7577 lines
2.1 MiB
7577 lines
2.1 MiB
<!DOCTYPE html>
|
||
<html class="writer-html5" lang="en" data-content_root="../">
|
||
<head>
|
||
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
||
<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 name="description" content="Classes" />
|
||
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||
<title>kittycad.models.input_format — kittycad v0.7.0 documentation</title>
|
||
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=d10597a4" />
|
||
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=19f00094" />
|
||
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=fd3f3429" />
|
||
<link rel="stylesheet" type="text/css" href="../_static/copybutton.css?v=76b2166b" />
|
||
<link rel="stylesheet" type="text/css" href="../_static/autoclasstoc.css?v=08871587" />
|
||
|
||
|
||
<!--[if lt IE 9]>
|
||
<script src="../_static/js/html5shiv.min.js"></script>
|
||
<![endif]-->
|
||
|
||
<script src="../_static/jquery.js?v=5d32c60e"></script>
|
||
<script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
|
||
<script src="../_static/documentation_options.js?v=05c9169f"></script>
|
||
<script src="../_static/doctools.js?v=9a2dae69"></script>
|
||
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||
<script src="../_static/clipboard.min.js?v=a7894cd8"></script>
|
||
<script src="../_static/copybutton.js?v=f281be69"></script>
|
||
<script src="../_static/js/theme.js"></script>
|
||
<link rel="index" title="Index" href="../genindex.html" />
|
||
<link rel="search" title="Search" href="../search.html" />
|
||
<link rel="next" title="kittycad.models.input_format.OptionFbx" href="kittycad.models.input_format.OptionFbx.html" />
|
||
<link rel="prev" title="kittycad.models.imported_geometry.ImportedGeometry" href="kittycad.models.imported_geometry.ImportedGeometry.html" />
|
||
</head>
|
||
|
||
<body class="wy-body-for-nav">
|
||
<div class="wy-grid-for-nav">
|
||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||
<div class="wy-side-scroll">
|
||
<div class="wy-side-nav-search" >
|
||
|
||
|
||
|
||
<a href="../index.html" class="icon icon-home">
|
||
kittycad
|
||
</a>
|
||
<div class="version">
|
||
v0.7.0
|
||
</div>
|
||
<div role="search">
|
||
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
|
||
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
|
||
<input type="hidden" name="check_keywords" value="yes" />
|
||
<input type="hidden" name="area" value="default" />
|
||
</form>
|
||
</div>
|
||
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||
<ul class="current">
|
||
<li class="toctree-l1"><a class="reference internal" href="kittycad.api.html">kittycad.api</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="kittycad.client.html">kittycad.client</a></li>
|
||
<li class="toctree-l1 current"><a class="reference internal" href="kittycad.models.html">kittycad.models</a><ul class="current">
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.account_provider.html">kittycad.models.account_provider</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.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>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.annotation_line_end.html">kittycad.models.annotation_line_end</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.annotation_line_end_options.html">kittycad.models.annotation_line_end_options</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.annotation_options.html">kittycad.models.annotation_options</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.annotation_text_alignment_x.html">kittycad.models.annotation_text_alignment_x</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.annotation_text_alignment_y.html">kittycad.models.annotation_text_alignment_y</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.annotation_text_options.html">kittycad.models.annotation_text_options</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.annotation_type.html">kittycad.models.annotation_type</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.api_call_query_group.html">kittycad.models.api_call_query_group</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.api_call_query_group_by.html">kittycad.models.api_call_query_group_by</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.api_call_status.html">kittycad.models.api_call_status</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.api_call_with_price.html">kittycad.models.api_call_with_price</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.api_call_with_price_results_page.html">kittycad.models.api_call_with_price_results_page</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.api_error.html">kittycad.models.api_error</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.api_token.html">kittycad.models.api_token</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.api_token_results_page.html">kittycad.models.api_token_results_page</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.api_token_uuid.html">kittycad.models.api_token_uuid</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.app_client_info.html">kittycad.models.app_client_info</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.async_api_call.html">kittycad.models.async_api_call</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.async_api_call_output.html">kittycad.models.async_api_call_output</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.async_api_call_results_page.html">kittycad.models.async_api_call_results_page</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.async_api_call_type.html">kittycad.models.async_api_call_type</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.auth_callback.html">kittycad.models.auth_callback</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.axis.html">kittycad.models.axis</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.axis_direction_pair.html">kittycad.models.axis_direction_pair</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.base64data.html">kittycad.models.base64data</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.batch_response.html">kittycad.models.batch_response</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.billing_info.html">kittycad.models.billing_info</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.block_reason.html">kittycad.models.block_reason</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.cache_metadata.html">kittycad.models.cache_metadata</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.camera_drag_end.html">kittycad.models.camera_drag_end</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.camera_drag_interaction_type.html">kittycad.models.camera_drag_interaction_type</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.camera_drag_move.html">kittycad.models.camera_drag_move</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.camera_drag_start.html">kittycad.models.camera_drag_start</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.camera_settings.html">kittycad.models.camera_settings</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.card_details.html">kittycad.models.card_details</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.center_of_mass.html">kittycad.models.center_of_mass</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.client_metrics.html">kittycad.models.client_metrics</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.close_path.html">kittycad.models.close_path</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.cluster.html">kittycad.models.cluster</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.code_language.html">kittycad.models.code_language</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.code_output.html">kittycad.models.code_output</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.color.html">kittycad.models.color</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.connection.html">kittycad.models.connection</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.country_code.html">kittycad.models.country_code</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.coupon.html">kittycad.models.coupon</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.created_at_sort_mode.html">kittycad.models.created_at_sort_mode</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.currency.html">kittycad.models.currency</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.curve_get_control_points.html">kittycad.models.curve_get_control_points</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.curve_get_end_points.html">kittycad.models.curve_get_end_points</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.curve_get_type.html">kittycad.models.curve_get_type</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.curve_set_constraint.html">kittycad.models.curve_set_constraint</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.curve_type.html">kittycad.models.curve_type</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.customer.html">kittycad.models.customer</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.customer_balance.html">kittycad.models.customer_balance</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.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_look_at.html">kittycad.models.default_camera_look_at</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.default_camera_perspective_settings.html">kittycad.models.default_camera_perspective_settings</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.default_camera_set_orthographic.html">kittycad.models.default_camera_set_orthographic</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.default_camera_set_perspective.html">kittycad.models.default_camera_set_perspective</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>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.der_encoded_key_pair.html">kittycad.models.der_encoded_key_pair</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.device_access_token_request_form.html">kittycad.models.device_access_token_request_form</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.device_access_token_uuid.html">kittycad.models.device_access_token_uuid</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.device_auth_request_form.html">kittycad.models.device_auth_request_form</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.device_auth_verify_params.html">kittycad.models.device_auth_verify_params</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.direction.html">kittycad.models.direction</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.discount.html">kittycad.models.discount</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.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>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.edge_lines_visible.html">kittycad.models.edge_lines_visible</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.edit_mode_enter.html">kittycad.models.edit_mode_enter</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.edit_mode_exit.html">kittycad.models.edit_mode_exit</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.email_authentication_form.html">kittycad.models.email_authentication_form</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.empty.html">kittycad.models.empty</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.enable_sketch_mode.html">kittycad.models.enable_sketch_mode</a></li>
|
||
<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_fade.html">kittycad.models.entity_fade</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.entity_get_all_child_uuids.html">kittycad.models.entity_get_all_child_uuids</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.entity_get_child_uuid.html">kittycad.models.entity_get_child_uuid</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.entity_get_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>
|
||
<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>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.entity_make_helix.html">kittycad.models.entity_make_helix</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.entity_mirror.html">kittycad.models.entity_mirror</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.entity_mirror_across_edge.html">kittycad.models.entity_mirror_across_edge</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.entity_set_opacity.html">kittycad.models.entity_set_opacity</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.entity_type.html">kittycad.models.entity_type</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.environment.html">kittycad.models.environment</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.error.html">kittycad.models.error</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.error_code.html">kittycad.models.error_code</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.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>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.export_file.html">kittycad.models.export_file</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.extend_path.html">kittycad.models.extend_path</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.extended_user.html">kittycad.models.extended_user</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.extended_user_results_page.html">kittycad.models.extended_user_results_page</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.extrude.html">kittycad.models.extrude</a></li>
|
||
<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>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.file_center_of_mass.html">kittycad.models.file_center_of_mass</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.file_conversion.html">kittycad.models.file_conversion</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.file_density.html">kittycad.models.file_density</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.file_export_format.html">kittycad.models.file_export_format</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.file_import_format.html">kittycad.models.file_import_format</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.file_mass.html">kittycad.models.file_mass</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.file_surface_area.html">kittycad.models.file_surface_area</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.file_system_metadata.html">kittycad.models.file_system_metadata</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.file_volume.html">kittycad.models.file_volume</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.gateway.html">kittycad.models.gateway</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.get_entity_type.html">kittycad.models.get_entity_type</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.get_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>
|
||
<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.handle_mouse_drag_end.html">kittycad.models.handle_mouse_drag_end</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.handle_mouse_drag_move.html">kittycad.models.handle_mouse_drag_move</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.handle_mouse_drag_start.html">kittycad.models.handle_mouse_drag_start</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.highlight_set_entities.html">kittycad.models.highlight_set_entities</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>
|
||
<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>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.imported_geometry.html">kittycad.models.imported_geometry</a></li>
|
||
<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.OptionFbx.html">kittycad.models.input_format.OptionFbx</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="kittycad.models.input_format.OptionGltf.html">kittycad.models.input_format.OptionGltf</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="kittycad.models.input_format.OptionObj.html">kittycad.models.input_format.OptionObj</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="kittycad.models.input_format.OptionPly.html">kittycad.models.input_format.OptionPly</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="kittycad.models.input_format.OptionSldprt.html">kittycad.models.input_format.OptionSldprt</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="kittycad.models.input_format.OptionStep.html">kittycad.models.input_format.OptionStep</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="kittycad.models.input_format.OptionStl.html">kittycad.models.input_format.OptionStl</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#kittycad.models.input_format.OptionFbx"><code class="docutils literal notranslate"><span class="pre">OptionFbx</span></code></a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionFbx.__abstractmethods__"><code class="docutils literal notranslate"><span class="pre">OptionFbx.__abstractmethods__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionFbx.__annotations__"><code class="docutils literal notranslate"><span class="pre">OptionFbx.__annotations__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionFbx.__class_getitem__"><code class="docutils literal notranslate"><span class="pre">OptionFbx.__class_getitem__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionFbx.__class_vars__"><code class="docutils literal notranslate"><span class="pre">OptionFbx.__class_vars__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionFbx.__copy__"><code class="docutils literal notranslate"><span class="pre">OptionFbx.__copy__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionFbx.__deepcopy__"><code class="docutils literal notranslate"><span class="pre">OptionFbx.__deepcopy__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionFbx.__delattr__"><code class="docutils literal notranslate"><span class="pre">OptionFbx.__delattr__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionFbx.__dict__"><code class="docutils literal notranslate"><span class="pre">OptionFbx.__dict__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionFbx.__eq__"><code class="docutils literal notranslate"><span class="pre">OptionFbx.__eq__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionFbx.__fields_set__"><code class="docutils literal notranslate"><span class="pre">OptionFbx.__fields_set__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionFbx.__get_pydantic_core_schema__"><code class="docutils literal notranslate"><span class="pre">OptionFbx.__get_pydantic_core_schema__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionFbx.__get_pydantic_json_schema__"><code class="docutils literal notranslate"><span class="pre">OptionFbx.__get_pydantic_json_schema__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionFbx.__getattr__"><code class="docutils literal notranslate"><span class="pre">OptionFbx.__getattr__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionFbx.__getstate__"><code class="docutils literal notranslate"><span class="pre">OptionFbx.__getstate__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionFbx.__hash__"><code class="docutils literal notranslate"><span class="pre">OptionFbx.__hash__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionFbx.__init__"><code class="docutils literal notranslate"><span class="pre">OptionFbx.__init__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionFbx.__iter__"><code class="docutils literal notranslate"><span class="pre">OptionFbx.__iter__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionFbx.__module__"><code class="docutils literal notranslate"><span class="pre">OptionFbx.__module__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionFbx.__pretty__"><code class="docutils literal notranslate"><span class="pre">OptionFbx.__pretty__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionFbx.__private_attributes__"><code class="docutils literal notranslate"><span class="pre">OptionFbx.__private_attributes__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionFbx.__pydantic_complete__"><code class="docutils literal notranslate"><span class="pre">OptionFbx.__pydantic_complete__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionFbx.__pydantic_core_schema__"><code class="docutils literal notranslate"><span class="pre">OptionFbx.__pydantic_core_schema__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionFbx.__pydantic_custom_init__"><code class="docutils literal notranslate"><span class="pre">OptionFbx.__pydantic_custom_init__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionFbx.__pydantic_decorators__"><code class="docutils literal notranslate"><span class="pre">OptionFbx.__pydantic_decorators__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionFbx.__pydantic_extra__"><code class="docutils literal notranslate"><span class="pre">OptionFbx.__pydantic_extra__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionFbx.__pydantic_fields_set__"><code class="docutils literal notranslate"><span class="pre">OptionFbx.__pydantic_fields_set__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionFbx.__pydantic_generic_metadata__"><code class="docutils literal notranslate"><span class="pre">OptionFbx.__pydantic_generic_metadata__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionFbx.__pydantic_init_subclass__"><code class="docutils literal notranslate"><span class="pre">OptionFbx.__pydantic_init_subclass__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionFbx.__pydantic_parent_namespace__"><code class="docutils literal notranslate"><span class="pre">OptionFbx.__pydantic_parent_namespace__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionFbx.__pydantic_post_init__"><code class="docutils literal notranslate"><span class="pre">OptionFbx.__pydantic_post_init__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionFbx.__pydantic_private__"><code class="docutils literal notranslate"><span class="pre">OptionFbx.__pydantic_private__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionFbx.__pydantic_root_model__"><code class="docutils literal notranslate"><span class="pre">OptionFbx.__pydantic_root_model__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionFbx.__pydantic_serializer__"><code class="docutils literal notranslate"><span class="pre">OptionFbx.__pydantic_serializer__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionFbx.__pydantic_validator__"><code class="docutils literal notranslate"><span class="pre">OptionFbx.__pydantic_validator__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionFbx.__repr__"><code class="docutils literal notranslate"><span class="pre">OptionFbx.__repr__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionFbx.__repr_args__"><code class="docutils literal notranslate"><span class="pre">OptionFbx.__repr_args__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionFbx.__repr_name__"><code class="docutils literal notranslate"><span class="pre">OptionFbx.__repr_name__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionFbx.__repr_str__"><code class="docutils literal notranslate"><span class="pre">OptionFbx.__repr_str__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionFbx.__rich_repr__"><code class="docutils literal notranslate"><span class="pre">OptionFbx.__rich_repr__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionFbx.__setattr__"><code class="docutils literal notranslate"><span class="pre">OptionFbx.__setattr__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionFbx.__setstate__"><code class="docutils literal notranslate"><span class="pre">OptionFbx.__setstate__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionFbx.__signature__"><code class="docutils literal notranslate"><span class="pre">OptionFbx.__signature__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionFbx.__slots__"><code class="docutils literal notranslate"><span class="pre">OptionFbx.__slots__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionFbx.__str__"><code class="docutils literal notranslate"><span class="pre">OptionFbx.__str__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionFbx._abc_impl"><code class="docutils literal notranslate"><span class="pre">OptionFbx._abc_impl</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionFbx._calculate_keys"><code class="docutils literal notranslate"><span class="pre">OptionFbx._calculate_keys()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionFbx._check_frozen"><code class="docutils literal notranslate"><span class="pre">OptionFbx._check_frozen()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionFbx._copy_and_set_values"><code class="docutils literal notranslate"><span class="pre">OptionFbx._copy_and_set_values()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionFbx._get_value"><code class="docutils literal notranslate"><span class="pre">OptionFbx._get_value()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionFbx._iter"><code class="docutils literal notranslate"><span class="pre">OptionFbx._iter()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionFbx.construct"><code class="docutils literal notranslate"><span class="pre">OptionFbx.construct()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionFbx.copy"><code class="docutils literal notranslate"><span class="pre">OptionFbx.copy()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionFbx.dict"><code class="docutils literal notranslate"><span class="pre">OptionFbx.dict()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionFbx.from_orm"><code class="docutils literal notranslate"><span class="pre">OptionFbx.from_orm()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionFbx.json"><code class="docutils literal notranslate"><span class="pre">OptionFbx.json()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionFbx.model_computed_fields"><code class="docutils literal notranslate"><span class="pre">OptionFbx.model_computed_fields</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionFbx.model_config"><code class="docutils literal notranslate"><span class="pre">OptionFbx.model_config</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionFbx.model_construct"><code class="docutils literal notranslate"><span class="pre">OptionFbx.model_construct()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionFbx.model_copy"><code class="docutils literal notranslate"><span class="pre">OptionFbx.model_copy()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionFbx.model_dump"><code class="docutils literal notranslate"><span class="pre">OptionFbx.model_dump()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionFbx.model_dump_json"><code class="docutils literal notranslate"><span class="pre">OptionFbx.model_dump_json()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionFbx.model_extra"><code class="docutils literal notranslate"><span class="pre">OptionFbx.model_extra</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionFbx.model_fields"><code class="docutils literal notranslate"><span class="pre">OptionFbx.model_fields</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionFbx.model_fields_set"><code class="docutils literal notranslate"><span class="pre">OptionFbx.model_fields_set</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionFbx.model_json_schema"><code class="docutils literal notranslate"><span class="pre">OptionFbx.model_json_schema()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionFbx.model_parametrized_name"><code class="docutils literal notranslate"><span class="pre">OptionFbx.model_parametrized_name()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionFbx.model_post_init"><code class="docutils literal notranslate"><span class="pre">OptionFbx.model_post_init()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionFbx.model_rebuild"><code class="docutils literal notranslate"><span class="pre">OptionFbx.model_rebuild()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionFbx.model_validate"><code class="docutils literal notranslate"><span class="pre">OptionFbx.model_validate()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionFbx.model_validate_json"><code class="docutils literal notranslate"><span class="pre">OptionFbx.model_validate_json()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionFbx.model_validate_strings"><code class="docutils literal notranslate"><span class="pre">OptionFbx.model_validate_strings()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionFbx.parse_file"><code class="docutils literal notranslate"><span class="pre">OptionFbx.parse_file()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionFbx.parse_obj"><code class="docutils literal notranslate"><span class="pre">OptionFbx.parse_obj()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionFbx.parse_raw"><code class="docutils literal notranslate"><span class="pre">OptionFbx.parse_raw()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionFbx.schema"><code class="docutils literal notranslate"><span class="pre">OptionFbx.schema()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionFbx.schema_json"><code class="docutils literal notranslate"><span class="pre">OptionFbx.schema_json()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionFbx.type"><code class="docutils literal notranslate"><span class="pre">OptionFbx.type</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionFbx.update_forward_refs"><code class="docutils literal notranslate"><span class="pre">OptionFbx.update_forward_refs()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionFbx.validate"><code class="docutils literal notranslate"><span class="pre">OptionFbx.validate()</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#kittycad.models.input_format.OptionGltf"><code class="docutils literal notranslate"><span class="pre">OptionGltf</span></code></a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionGltf.__abstractmethods__"><code class="docutils literal notranslate"><span class="pre">OptionGltf.__abstractmethods__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionGltf.__annotations__"><code class="docutils literal notranslate"><span class="pre">OptionGltf.__annotations__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionGltf.__class_getitem__"><code class="docutils literal notranslate"><span class="pre">OptionGltf.__class_getitem__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionGltf.__class_vars__"><code class="docutils literal notranslate"><span class="pre">OptionGltf.__class_vars__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionGltf.__copy__"><code class="docutils literal notranslate"><span class="pre">OptionGltf.__copy__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionGltf.__deepcopy__"><code class="docutils literal notranslate"><span class="pre">OptionGltf.__deepcopy__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionGltf.__delattr__"><code class="docutils literal notranslate"><span class="pre">OptionGltf.__delattr__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionGltf.__dict__"><code class="docutils literal notranslate"><span class="pre">OptionGltf.__dict__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionGltf.__eq__"><code class="docutils literal notranslate"><span class="pre">OptionGltf.__eq__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionGltf.__fields_set__"><code class="docutils literal notranslate"><span class="pre">OptionGltf.__fields_set__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionGltf.__get_pydantic_core_schema__"><code class="docutils literal notranslate"><span class="pre">OptionGltf.__get_pydantic_core_schema__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionGltf.__get_pydantic_json_schema__"><code class="docutils literal notranslate"><span class="pre">OptionGltf.__get_pydantic_json_schema__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionGltf.__getattr__"><code class="docutils literal notranslate"><span class="pre">OptionGltf.__getattr__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionGltf.__getstate__"><code class="docutils literal notranslate"><span class="pre">OptionGltf.__getstate__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionGltf.__hash__"><code class="docutils literal notranslate"><span class="pre">OptionGltf.__hash__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionGltf.__init__"><code class="docutils literal notranslate"><span class="pre">OptionGltf.__init__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionGltf.__iter__"><code class="docutils literal notranslate"><span class="pre">OptionGltf.__iter__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionGltf.__module__"><code class="docutils literal notranslate"><span class="pre">OptionGltf.__module__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionGltf.__pretty__"><code class="docutils literal notranslate"><span class="pre">OptionGltf.__pretty__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionGltf.__private_attributes__"><code class="docutils literal notranslate"><span class="pre">OptionGltf.__private_attributes__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionGltf.__pydantic_complete__"><code class="docutils literal notranslate"><span class="pre">OptionGltf.__pydantic_complete__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionGltf.__pydantic_core_schema__"><code class="docutils literal notranslate"><span class="pre">OptionGltf.__pydantic_core_schema__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionGltf.__pydantic_custom_init__"><code class="docutils literal notranslate"><span class="pre">OptionGltf.__pydantic_custom_init__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionGltf.__pydantic_decorators__"><code class="docutils literal notranslate"><span class="pre">OptionGltf.__pydantic_decorators__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionGltf.__pydantic_extra__"><code class="docutils literal notranslate"><span class="pre">OptionGltf.__pydantic_extra__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionGltf.__pydantic_fields_set__"><code class="docutils literal notranslate"><span class="pre">OptionGltf.__pydantic_fields_set__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionGltf.__pydantic_generic_metadata__"><code class="docutils literal notranslate"><span class="pre">OptionGltf.__pydantic_generic_metadata__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionGltf.__pydantic_init_subclass__"><code class="docutils literal notranslate"><span class="pre">OptionGltf.__pydantic_init_subclass__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionGltf.__pydantic_parent_namespace__"><code class="docutils literal notranslate"><span class="pre">OptionGltf.__pydantic_parent_namespace__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionGltf.__pydantic_post_init__"><code class="docutils literal notranslate"><span class="pre">OptionGltf.__pydantic_post_init__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionGltf.__pydantic_private__"><code class="docutils literal notranslate"><span class="pre">OptionGltf.__pydantic_private__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionGltf.__pydantic_root_model__"><code class="docutils literal notranslate"><span class="pre">OptionGltf.__pydantic_root_model__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionGltf.__pydantic_serializer__"><code class="docutils literal notranslate"><span class="pre">OptionGltf.__pydantic_serializer__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionGltf.__pydantic_validator__"><code class="docutils literal notranslate"><span class="pre">OptionGltf.__pydantic_validator__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionGltf.__repr__"><code class="docutils literal notranslate"><span class="pre">OptionGltf.__repr__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionGltf.__repr_args__"><code class="docutils literal notranslate"><span class="pre">OptionGltf.__repr_args__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionGltf.__repr_name__"><code class="docutils literal notranslate"><span class="pre">OptionGltf.__repr_name__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionGltf.__repr_str__"><code class="docutils literal notranslate"><span class="pre">OptionGltf.__repr_str__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionGltf.__rich_repr__"><code class="docutils literal notranslate"><span class="pre">OptionGltf.__rich_repr__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionGltf.__setattr__"><code class="docutils literal notranslate"><span class="pre">OptionGltf.__setattr__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionGltf.__setstate__"><code class="docutils literal notranslate"><span class="pre">OptionGltf.__setstate__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionGltf.__signature__"><code class="docutils literal notranslate"><span class="pre">OptionGltf.__signature__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionGltf.__slots__"><code class="docutils literal notranslate"><span class="pre">OptionGltf.__slots__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionGltf.__str__"><code class="docutils literal notranslate"><span class="pre">OptionGltf.__str__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionGltf._abc_impl"><code class="docutils literal notranslate"><span class="pre">OptionGltf._abc_impl</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionGltf._calculate_keys"><code class="docutils literal notranslate"><span class="pre">OptionGltf._calculate_keys()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionGltf._check_frozen"><code class="docutils literal notranslate"><span class="pre">OptionGltf._check_frozen()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionGltf._copy_and_set_values"><code class="docutils literal notranslate"><span class="pre">OptionGltf._copy_and_set_values()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionGltf._get_value"><code class="docutils literal notranslate"><span class="pre">OptionGltf._get_value()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionGltf._iter"><code class="docutils literal notranslate"><span class="pre">OptionGltf._iter()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionGltf.construct"><code class="docutils literal notranslate"><span class="pre">OptionGltf.construct()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionGltf.copy"><code class="docutils literal notranslate"><span class="pre">OptionGltf.copy()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionGltf.dict"><code class="docutils literal notranslate"><span class="pre">OptionGltf.dict()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionGltf.from_orm"><code class="docutils literal notranslate"><span class="pre">OptionGltf.from_orm()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionGltf.json"><code class="docutils literal notranslate"><span class="pre">OptionGltf.json()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionGltf.model_computed_fields"><code class="docutils literal notranslate"><span class="pre">OptionGltf.model_computed_fields</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionGltf.model_config"><code class="docutils literal notranslate"><span class="pre">OptionGltf.model_config</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionGltf.model_construct"><code class="docutils literal notranslate"><span class="pre">OptionGltf.model_construct()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionGltf.model_copy"><code class="docutils literal notranslate"><span class="pre">OptionGltf.model_copy()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionGltf.model_dump"><code class="docutils literal notranslate"><span class="pre">OptionGltf.model_dump()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionGltf.model_dump_json"><code class="docutils literal notranslate"><span class="pre">OptionGltf.model_dump_json()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionGltf.model_extra"><code class="docutils literal notranslate"><span class="pre">OptionGltf.model_extra</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionGltf.model_fields"><code class="docutils literal notranslate"><span class="pre">OptionGltf.model_fields</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionGltf.model_fields_set"><code class="docutils literal notranslate"><span class="pre">OptionGltf.model_fields_set</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionGltf.model_json_schema"><code class="docutils literal notranslate"><span class="pre">OptionGltf.model_json_schema()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionGltf.model_parametrized_name"><code class="docutils literal notranslate"><span class="pre">OptionGltf.model_parametrized_name()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionGltf.model_post_init"><code class="docutils literal notranslate"><span class="pre">OptionGltf.model_post_init()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionGltf.model_rebuild"><code class="docutils literal notranslate"><span class="pre">OptionGltf.model_rebuild()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionGltf.model_validate"><code class="docutils literal notranslate"><span class="pre">OptionGltf.model_validate()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionGltf.model_validate_json"><code class="docutils literal notranslate"><span class="pre">OptionGltf.model_validate_json()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionGltf.model_validate_strings"><code class="docutils literal notranslate"><span class="pre">OptionGltf.model_validate_strings()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionGltf.parse_file"><code class="docutils literal notranslate"><span class="pre">OptionGltf.parse_file()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionGltf.parse_obj"><code class="docutils literal notranslate"><span class="pre">OptionGltf.parse_obj()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionGltf.parse_raw"><code class="docutils literal notranslate"><span class="pre">OptionGltf.parse_raw()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionGltf.schema"><code class="docutils literal notranslate"><span class="pre">OptionGltf.schema()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionGltf.schema_json"><code class="docutils literal notranslate"><span class="pre">OptionGltf.schema_json()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionGltf.type"><code class="docutils literal notranslate"><span class="pre">OptionGltf.type</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionGltf.update_forward_refs"><code class="docutils literal notranslate"><span class="pre">OptionGltf.update_forward_refs()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionGltf.validate"><code class="docutils literal notranslate"><span class="pre">OptionGltf.validate()</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#kittycad.models.input_format.OptionObj"><code class="docutils literal notranslate"><span class="pre">OptionObj</span></code></a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionObj.__abstractmethods__"><code class="docutils literal notranslate"><span class="pre">OptionObj.__abstractmethods__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionObj.__annotations__"><code class="docutils literal notranslate"><span class="pre">OptionObj.__annotations__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionObj.__class_getitem__"><code class="docutils literal notranslate"><span class="pre">OptionObj.__class_getitem__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionObj.__class_vars__"><code class="docutils literal notranslate"><span class="pre">OptionObj.__class_vars__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionObj.__copy__"><code class="docutils literal notranslate"><span class="pre">OptionObj.__copy__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionObj.__deepcopy__"><code class="docutils literal notranslate"><span class="pre">OptionObj.__deepcopy__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionObj.__delattr__"><code class="docutils literal notranslate"><span class="pre">OptionObj.__delattr__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionObj.__dict__"><code class="docutils literal notranslate"><span class="pre">OptionObj.__dict__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionObj.__eq__"><code class="docutils literal notranslate"><span class="pre">OptionObj.__eq__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionObj.__fields_set__"><code class="docutils literal notranslate"><span class="pre">OptionObj.__fields_set__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionObj.__get_pydantic_core_schema__"><code class="docutils literal notranslate"><span class="pre">OptionObj.__get_pydantic_core_schema__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionObj.__get_pydantic_json_schema__"><code class="docutils literal notranslate"><span class="pre">OptionObj.__get_pydantic_json_schema__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionObj.__getattr__"><code class="docutils literal notranslate"><span class="pre">OptionObj.__getattr__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionObj.__getstate__"><code class="docutils literal notranslate"><span class="pre">OptionObj.__getstate__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionObj.__hash__"><code class="docutils literal notranslate"><span class="pre">OptionObj.__hash__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionObj.__init__"><code class="docutils literal notranslate"><span class="pre">OptionObj.__init__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionObj.__iter__"><code class="docutils literal notranslate"><span class="pre">OptionObj.__iter__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionObj.__module__"><code class="docutils literal notranslate"><span class="pre">OptionObj.__module__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionObj.__pretty__"><code class="docutils literal notranslate"><span class="pre">OptionObj.__pretty__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionObj.__private_attributes__"><code class="docutils literal notranslate"><span class="pre">OptionObj.__private_attributes__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionObj.__pydantic_complete__"><code class="docutils literal notranslate"><span class="pre">OptionObj.__pydantic_complete__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionObj.__pydantic_core_schema__"><code class="docutils literal notranslate"><span class="pre">OptionObj.__pydantic_core_schema__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionObj.__pydantic_custom_init__"><code class="docutils literal notranslate"><span class="pre">OptionObj.__pydantic_custom_init__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionObj.__pydantic_decorators__"><code class="docutils literal notranslate"><span class="pre">OptionObj.__pydantic_decorators__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionObj.__pydantic_extra__"><code class="docutils literal notranslate"><span class="pre">OptionObj.__pydantic_extra__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionObj.__pydantic_fields_set__"><code class="docutils literal notranslate"><span class="pre">OptionObj.__pydantic_fields_set__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionObj.__pydantic_generic_metadata__"><code class="docutils literal notranslate"><span class="pre">OptionObj.__pydantic_generic_metadata__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionObj.__pydantic_init_subclass__"><code class="docutils literal notranslate"><span class="pre">OptionObj.__pydantic_init_subclass__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionObj.__pydantic_parent_namespace__"><code class="docutils literal notranslate"><span class="pre">OptionObj.__pydantic_parent_namespace__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionObj.__pydantic_post_init__"><code class="docutils literal notranslate"><span class="pre">OptionObj.__pydantic_post_init__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionObj.__pydantic_private__"><code class="docutils literal notranslate"><span class="pre">OptionObj.__pydantic_private__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionObj.__pydantic_root_model__"><code class="docutils literal notranslate"><span class="pre">OptionObj.__pydantic_root_model__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionObj.__pydantic_serializer__"><code class="docutils literal notranslate"><span class="pre">OptionObj.__pydantic_serializer__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionObj.__pydantic_validator__"><code class="docutils literal notranslate"><span class="pre">OptionObj.__pydantic_validator__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionObj.__repr__"><code class="docutils literal notranslate"><span class="pre">OptionObj.__repr__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionObj.__repr_args__"><code class="docutils literal notranslate"><span class="pre">OptionObj.__repr_args__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionObj.__repr_name__"><code class="docutils literal notranslate"><span class="pre">OptionObj.__repr_name__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionObj.__repr_str__"><code class="docutils literal notranslate"><span class="pre">OptionObj.__repr_str__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionObj.__rich_repr__"><code class="docutils literal notranslate"><span class="pre">OptionObj.__rich_repr__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionObj.__setattr__"><code class="docutils literal notranslate"><span class="pre">OptionObj.__setattr__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionObj.__setstate__"><code class="docutils literal notranslate"><span class="pre">OptionObj.__setstate__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionObj.__signature__"><code class="docutils literal notranslate"><span class="pre">OptionObj.__signature__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionObj.__slots__"><code class="docutils literal notranslate"><span class="pre">OptionObj.__slots__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionObj.__str__"><code class="docutils literal notranslate"><span class="pre">OptionObj.__str__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionObj._abc_impl"><code class="docutils literal notranslate"><span class="pre">OptionObj._abc_impl</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionObj._calculate_keys"><code class="docutils literal notranslate"><span class="pre">OptionObj._calculate_keys()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionObj._check_frozen"><code class="docutils literal notranslate"><span class="pre">OptionObj._check_frozen()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionObj._copy_and_set_values"><code class="docutils literal notranslate"><span class="pre">OptionObj._copy_and_set_values()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionObj._get_value"><code class="docutils literal notranslate"><span class="pre">OptionObj._get_value()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionObj._iter"><code class="docutils literal notranslate"><span class="pre">OptionObj._iter()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionObj.construct"><code class="docutils literal notranslate"><span class="pre">OptionObj.construct()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionObj.coords"><code class="docutils literal notranslate"><span class="pre">OptionObj.coords</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionObj.copy"><code class="docutils literal notranslate"><span class="pre">OptionObj.copy()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionObj.dict"><code class="docutils literal notranslate"><span class="pre">OptionObj.dict()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionObj.from_orm"><code class="docutils literal notranslate"><span class="pre">OptionObj.from_orm()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionObj.json"><code class="docutils literal notranslate"><span class="pre">OptionObj.json()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionObj.model_computed_fields"><code class="docutils literal notranslate"><span class="pre">OptionObj.model_computed_fields</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionObj.model_config"><code class="docutils literal notranslate"><span class="pre">OptionObj.model_config</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionObj.model_construct"><code class="docutils literal notranslate"><span class="pre">OptionObj.model_construct()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionObj.model_copy"><code class="docutils literal notranslate"><span class="pre">OptionObj.model_copy()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionObj.model_dump"><code class="docutils literal notranslate"><span class="pre">OptionObj.model_dump()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionObj.model_dump_json"><code class="docutils literal notranslate"><span class="pre">OptionObj.model_dump_json()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionObj.model_extra"><code class="docutils literal notranslate"><span class="pre">OptionObj.model_extra</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionObj.model_fields"><code class="docutils literal notranslate"><span class="pre">OptionObj.model_fields</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionObj.model_fields_set"><code class="docutils literal notranslate"><span class="pre">OptionObj.model_fields_set</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionObj.model_json_schema"><code class="docutils literal notranslate"><span class="pre">OptionObj.model_json_schema()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionObj.model_parametrized_name"><code class="docutils literal notranslate"><span class="pre">OptionObj.model_parametrized_name()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionObj.model_post_init"><code class="docutils literal notranslate"><span class="pre">OptionObj.model_post_init()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionObj.model_rebuild"><code class="docutils literal notranslate"><span class="pre">OptionObj.model_rebuild()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionObj.model_validate"><code class="docutils literal notranslate"><span class="pre">OptionObj.model_validate()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionObj.model_validate_json"><code class="docutils literal notranslate"><span class="pre">OptionObj.model_validate_json()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionObj.model_validate_strings"><code class="docutils literal notranslate"><span class="pre">OptionObj.model_validate_strings()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionObj.parse_file"><code class="docutils literal notranslate"><span class="pre">OptionObj.parse_file()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionObj.parse_obj"><code class="docutils literal notranslate"><span class="pre">OptionObj.parse_obj()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionObj.parse_raw"><code class="docutils literal notranslate"><span class="pre">OptionObj.parse_raw()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionObj.schema"><code class="docutils literal notranslate"><span class="pre">OptionObj.schema()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionObj.schema_json"><code class="docutils literal notranslate"><span class="pre">OptionObj.schema_json()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionObj.type"><code class="docutils literal notranslate"><span class="pre">OptionObj.type</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionObj.units"><code class="docutils literal notranslate"><span class="pre">OptionObj.units</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionObj.update_forward_refs"><code class="docutils literal notranslate"><span class="pre">OptionObj.update_forward_refs()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionObj.validate"><code class="docutils literal notranslate"><span class="pre">OptionObj.validate()</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#kittycad.models.input_format.OptionPly"><code class="docutils literal notranslate"><span class="pre">OptionPly</span></code></a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionPly.__abstractmethods__"><code class="docutils literal notranslate"><span class="pre">OptionPly.__abstractmethods__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionPly.__annotations__"><code class="docutils literal notranslate"><span class="pre">OptionPly.__annotations__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionPly.__class_getitem__"><code class="docutils literal notranslate"><span class="pre">OptionPly.__class_getitem__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionPly.__class_vars__"><code class="docutils literal notranslate"><span class="pre">OptionPly.__class_vars__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionPly.__copy__"><code class="docutils literal notranslate"><span class="pre">OptionPly.__copy__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionPly.__deepcopy__"><code class="docutils literal notranslate"><span class="pre">OptionPly.__deepcopy__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionPly.__delattr__"><code class="docutils literal notranslate"><span class="pre">OptionPly.__delattr__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionPly.__dict__"><code class="docutils literal notranslate"><span class="pre">OptionPly.__dict__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionPly.__eq__"><code class="docutils literal notranslate"><span class="pre">OptionPly.__eq__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionPly.__fields_set__"><code class="docutils literal notranslate"><span class="pre">OptionPly.__fields_set__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionPly.__get_pydantic_core_schema__"><code class="docutils literal notranslate"><span class="pre">OptionPly.__get_pydantic_core_schema__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionPly.__get_pydantic_json_schema__"><code class="docutils literal notranslate"><span class="pre">OptionPly.__get_pydantic_json_schema__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionPly.__getattr__"><code class="docutils literal notranslate"><span class="pre">OptionPly.__getattr__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionPly.__getstate__"><code class="docutils literal notranslate"><span class="pre">OptionPly.__getstate__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionPly.__hash__"><code class="docutils literal notranslate"><span class="pre">OptionPly.__hash__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionPly.__init__"><code class="docutils literal notranslate"><span class="pre">OptionPly.__init__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionPly.__iter__"><code class="docutils literal notranslate"><span class="pre">OptionPly.__iter__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionPly.__module__"><code class="docutils literal notranslate"><span class="pre">OptionPly.__module__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionPly.__pretty__"><code class="docutils literal notranslate"><span class="pre">OptionPly.__pretty__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionPly.__private_attributes__"><code class="docutils literal notranslate"><span class="pre">OptionPly.__private_attributes__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionPly.__pydantic_complete__"><code class="docutils literal notranslate"><span class="pre">OptionPly.__pydantic_complete__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionPly.__pydantic_core_schema__"><code class="docutils literal notranslate"><span class="pre">OptionPly.__pydantic_core_schema__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionPly.__pydantic_custom_init__"><code class="docutils literal notranslate"><span class="pre">OptionPly.__pydantic_custom_init__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionPly.__pydantic_decorators__"><code class="docutils literal notranslate"><span class="pre">OptionPly.__pydantic_decorators__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionPly.__pydantic_extra__"><code class="docutils literal notranslate"><span class="pre">OptionPly.__pydantic_extra__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionPly.__pydantic_fields_set__"><code class="docutils literal notranslate"><span class="pre">OptionPly.__pydantic_fields_set__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionPly.__pydantic_generic_metadata__"><code class="docutils literal notranslate"><span class="pre">OptionPly.__pydantic_generic_metadata__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionPly.__pydantic_init_subclass__"><code class="docutils literal notranslate"><span class="pre">OptionPly.__pydantic_init_subclass__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionPly.__pydantic_parent_namespace__"><code class="docutils literal notranslate"><span class="pre">OptionPly.__pydantic_parent_namespace__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionPly.__pydantic_post_init__"><code class="docutils literal notranslate"><span class="pre">OptionPly.__pydantic_post_init__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionPly.__pydantic_private__"><code class="docutils literal notranslate"><span class="pre">OptionPly.__pydantic_private__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionPly.__pydantic_root_model__"><code class="docutils literal notranslate"><span class="pre">OptionPly.__pydantic_root_model__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionPly.__pydantic_serializer__"><code class="docutils literal notranslate"><span class="pre">OptionPly.__pydantic_serializer__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionPly.__pydantic_validator__"><code class="docutils literal notranslate"><span class="pre">OptionPly.__pydantic_validator__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionPly.__repr__"><code class="docutils literal notranslate"><span class="pre">OptionPly.__repr__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionPly.__repr_args__"><code class="docutils literal notranslate"><span class="pre">OptionPly.__repr_args__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionPly.__repr_name__"><code class="docutils literal notranslate"><span class="pre">OptionPly.__repr_name__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionPly.__repr_str__"><code class="docutils literal notranslate"><span class="pre">OptionPly.__repr_str__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionPly.__rich_repr__"><code class="docutils literal notranslate"><span class="pre">OptionPly.__rich_repr__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionPly.__setattr__"><code class="docutils literal notranslate"><span class="pre">OptionPly.__setattr__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionPly.__setstate__"><code class="docutils literal notranslate"><span class="pre">OptionPly.__setstate__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionPly.__signature__"><code class="docutils literal notranslate"><span class="pre">OptionPly.__signature__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionPly.__slots__"><code class="docutils literal notranslate"><span class="pre">OptionPly.__slots__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionPly.__str__"><code class="docutils literal notranslate"><span class="pre">OptionPly.__str__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionPly._abc_impl"><code class="docutils literal notranslate"><span class="pre">OptionPly._abc_impl</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionPly._calculate_keys"><code class="docutils literal notranslate"><span class="pre">OptionPly._calculate_keys()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionPly._check_frozen"><code class="docutils literal notranslate"><span class="pre">OptionPly._check_frozen()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionPly._copy_and_set_values"><code class="docutils literal notranslate"><span class="pre">OptionPly._copy_and_set_values()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionPly._get_value"><code class="docutils literal notranslate"><span class="pre">OptionPly._get_value()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionPly._iter"><code class="docutils literal notranslate"><span class="pre">OptionPly._iter()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionPly.construct"><code class="docutils literal notranslate"><span class="pre">OptionPly.construct()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionPly.coords"><code class="docutils literal notranslate"><span class="pre">OptionPly.coords</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionPly.copy"><code class="docutils literal notranslate"><span class="pre">OptionPly.copy()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionPly.dict"><code class="docutils literal notranslate"><span class="pre">OptionPly.dict()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionPly.from_orm"><code class="docutils literal notranslate"><span class="pre">OptionPly.from_orm()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionPly.json"><code class="docutils literal notranslate"><span class="pre">OptionPly.json()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionPly.model_computed_fields"><code class="docutils literal notranslate"><span class="pre">OptionPly.model_computed_fields</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionPly.model_config"><code class="docutils literal notranslate"><span class="pre">OptionPly.model_config</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionPly.model_construct"><code class="docutils literal notranslate"><span class="pre">OptionPly.model_construct()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionPly.model_copy"><code class="docutils literal notranslate"><span class="pre">OptionPly.model_copy()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionPly.model_dump"><code class="docutils literal notranslate"><span class="pre">OptionPly.model_dump()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionPly.model_dump_json"><code class="docutils literal notranslate"><span class="pre">OptionPly.model_dump_json()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionPly.model_extra"><code class="docutils literal notranslate"><span class="pre">OptionPly.model_extra</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionPly.model_fields"><code class="docutils literal notranslate"><span class="pre">OptionPly.model_fields</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionPly.model_fields_set"><code class="docutils literal notranslate"><span class="pre">OptionPly.model_fields_set</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionPly.model_json_schema"><code class="docutils literal notranslate"><span class="pre">OptionPly.model_json_schema()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionPly.model_parametrized_name"><code class="docutils literal notranslate"><span class="pre">OptionPly.model_parametrized_name()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionPly.model_post_init"><code class="docutils literal notranslate"><span class="pre">OptionPly.model_post_init()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionPly.model_rebuild"><code class="docutils literal notranslate"><span class="pre">OptionPly.model_rebuild()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionPly.model_validate"><code class="docutils literal notranslate"><span class="pre">OptionPly.model_validate()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionPly.model_validate_json"><code class="docutils literal notranslate"><span class="pre">OptionPly.model_validate_json()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionPly.model_validate_strings"><code class="docutils literal notranslate"><span class="pre">OptionPly.model_validate_strings()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionPly.parse_file"><code class="docutils literal notranslate"><span class="pre">OptionPly.parse_file()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionPly.parse_obj"><code class="docutils literal notranslate"><span class="pre">OptionPly.parse_obj()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionPly.parse_raw"><code class="docutils literal notranslate"><span class="pre">OptionPly.parse_raw()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionPly.schema"><code class="docutils literal notranslate"><span class="pre">OptionPly.schema()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionPly.schema_json"><code class="docutils literal notranslate"><span class="pre">OptionPly.schema_json()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionPly.type"><code class="docutils literal notranslate"><span class="pre">OptionPly.type</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionPly.units"><code class="docutils literal notranslate"><span class="pre">OptionPly.units</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionPly.update_forward_refs"><code class="docutils literal notranslate"><span class="pre">OptionPly.update_forward_refs()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionPly.validate"><code class="docutils literal notranslate"><span class="pre">OptionPly.validate()</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#kittycad.models.input_format.OptionSldprt"><code class="docutils literal notranslate"><span class="pre">OptionSldprt</span></code></a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionSldprt.__abstractmethods__"><code class="docutils literal notranslate"><span class="pre">OptionSldprt.__abstractmethods__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionSldprt.__annotations__"><code class="docutils literal notranslate"><span class="pre">OptionSldprt.__annotations__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionSldprt.__class_getitem__"><code class="docutils literal notranslate"><span class="pre">OptionSldprt.__class_getitem__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionSldprt.__class_vars__"><code class="docutils literal notranslate"><span class="pre">OptionSldprt.__class_vars__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionSldprt.__copy__"><code class="docutils literal notranslate"><span class="pre">OptionSldprt.__copy__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionSldprt.__deepcopy__"><code class="docutils literal notranslate"><span class="pre">OptionSldprt.__deepcopy__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionSldprt.__delattr__"><code class="docutils literal notranslate"><span class="pre">OptionSldprt.__delattr__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionSldprt.__dict__"><code class="docutils literal notranslate"><span class="pre">OptionSldprt.__dict__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionSldprt.__eq__"><code class="docutils literal notranslate"><span class="pre">OptionSldprt.__eq__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionSldprt.__fields_set__"><code class="docutils literal notranslate"><span class="pre">OptionSldprt.__fields_set__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionSldprt.__get_pydantic_core_schema__"><code class="docutils literal notranslate"><span class="pre">OptionSldprt.__get_pydantic_core_schema__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionSldprt.__get_pydantic_json_schema__"><code class="docutils literal notranslate"><span class="pre">OptionSldprt.__get_pydantic_json_schema__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionSldprt.__getattr__"><code class="docutils literal notranslate"><span class="pre">OptionSldprt.__getattr__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionSldprt.__getstate__"><code class="docutils literal notranslate"><span class="pre">OptionSldprt.__getstate__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionSldprt.__hash__"><code class="docutils literal notranslate"><span class="pre">OptionSldprt.__hash__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionSldprt.__init__"><code class="docutils literal notranslate"><span class="pre">OptionSldprt.__init__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionSldprt.__iter__"><code class="docutils literal notranslate"><span class="pre">OptionSldprt.__iter__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionSldprt.__module__"><code class="docutils literal notranslate"><span class="pre">OptionSldprt.__module__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionSldprt.__pretty__"><code class="docutils literal notranslate"><span class="pre">OptionSldprt.__pretty__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionSldprt.__private_attributes__"><code class="docutils literal notranslate"><span class="pre">OptionSldprt.__private_attributes__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionSldprt.__pydantic_complete__"><code class="docutils literal notranslate"><span class="pre">OptionSldprt.__pydantic_complete__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionSldprt.__pydantic_core_schema__"><code class="docutils literal notranslate"><span class="pre">OptionSldprt.__pydantic_core_schema__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionSldprt.__pydantic_custom_init__"><code class="docutils literal notranslate"><span class="pre">OptionSldprt.__pydantic_custom_init__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionSldprt.__pydantic_decorators__"><code class="docutils literal notranslate"><span class="pre">OptionSldprt.__pydantic_decorators__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionSldprt.__pydantic_extra__"><code class="docutils literal notranslate"><span class="pre">OptionSldprt.__pydantic_extra__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionSldprt.__pydantic_fields_set__"><code class="docutils literal notranslate"><span class="pre">OptionSldprt.__pydantic_fields_set__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionSldprt.__pydantic_generic_metadata__"><code class="docutils literal notranslate"><span class="pre">OptionSldprt.__pydantic_generic_metadata__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionSldprt.__pydantic_init_subclass__"><code class="docutils literal notranslate"><span class="pre">OptionSldprt.__pydantic_init_subclass__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionSldprt.__pydantic_parent_namespace__"><code class="docutils literal notranslate"><span class="pre">OptionSldprt.__pydantic_parent_namespace__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionSldprt.__pydantic_post_init__"><code class="docutils literal notranslate"><span class="pre">OptionSldprt.__pydantic_post_init__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionSldprt.__pydantic_private__"><code class="docutils literal notranslate"><span class="pre">OptionSldprt.__pydantic_private__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionSldprt.__pydantic_root_model__"><code class="docutils literal notranslate"><span class="pre">OptionSldprt.__pydantic_root_model__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionSldprt.__pydantic_serializer__"><code class="docutils literal notranslate"><span class="pre">OptionSldprt.__pydantic_serializer__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionSldprt.__pydantic_validator__"><code class="docutils literal notranslate"><span class="pre">OptionSldprt.__pydantic_validator__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionSldprt.__repr__"><code class="docutils literal notranslate"><span class="pre">OptionSldprt.__repr__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionSldprt.__repr_args__"><code class="docutils literal notranslate"><span class="pre">OptionSldprt.__repr_args__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionSldprt.__repr_name__"><code class="docutils literal notranslate"><span class="pre">OptionSldprt.__repr_name__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionSldprt.__repr_str__"><code class="docutils literal notranslate"><span class="pre">OptionSldprt.__repr_str__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionSldprt.__rich_repr__"><code class="docutils literal notranslate"><span class="pre">OptionSldprt.__rich_repr__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionSldprt.__setattr__"><code class="docutils literal notranslate"><span class="pre">OptionSldprt.__setattr__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionSldprt.__setstate__"><code class="docutils literal notranslate"><span class="pre">OptionSldprt.__setstate__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionSldprt.__signature__"><code class="docutils literal notranslate"><span class="pre">OptionSldprt.__signature__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionSldprt.__slots__"><code class="docutils literal notranslate"><span class="pre">OptionSldprt.__slots__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionSldprt.__str__"><code class="docutils literal notranslate"><span class="pre">OptionSldprt.__str__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionSldprt._abc_impl"><code class="docutils literal notranslate"><span class="pre">OptionSldprt._abc_impl</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionSldprt._calculate_keys"><code class="docutils literal notranslate"><span class="pre">OptionSldprt._calculate_keys()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionSldprt._check_frozen"><code class="docutils literal notranslate"><span class="pre">OptionSldprt._check_frozen()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionSldprt._copy_and_set_values"><code class="docutils literal notranslate"><span class="pre">OptionSldprt._copy_and_set_values()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionSldprt._get_value"><code class="docutils literal notranslate"><span class="pre">OptionSldprt._get_value()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionSldprt._iter"><code class="docutils literal notranslate"><span class="pre">OptionSldprt._iter()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionSldprt.construct"><code class="docutils literal notranslate"><span class="pre">OptionSldprt.construct()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionSldprt.copy"><code class="docutils literal notranslate"><span class="pre">OptionSldprt.copy()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionSldprt.dict"><code class="docutils literal notranslate"><span class="pre">OptionSldprt.dict()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionSldprt.from_orm"><code class="docutils literal notranslate"><span class="pre">OptionSldprt.from_orm()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionSldprt.json"><code class="docutils literal notranslate"><span class="pre">OptionSldprt.json()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionSldprt.model_computed_fields"><code class="docutils literal notranslate"><span class="pre">OptionSldprt.model_computed_fields</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionSldprt.model_config"><code class="docutils literal notranslate"><span class="pre">OptionSldprt.model_config</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionSldprt.model_construct"><code class="docutils literal notranslate"><span class="pre">OptionSldprt.model_construct()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionSldprt.model_copy"><code class="docutils literal notranslate"><span class="pre">OptionSldprt.model_copy()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionSldprt.model_dump"><code class="docutils literal notranslate"><span class="pre">OptionSldprt.model_dump()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionSldprt.model_dump_json"><code class="docutils literal notranslate"><span class="pre">OptionSldprt.model_dump_json()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionSldprt.model_extra"><code class="docutils literal notranslate"><span class="pre">OptionSldprt.model_extra</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionSldprt.model_fields"><code class="docutils literal notranslate"><span class="pre">OptionSldprt.model_fields</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionSldprt.model_fields_set"><code class="docutils literal notranslate"><span class="pre">OptionSldprt.model_fields_set</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionSldprt.model_json_schema"><code class="docutils literal notranslate"><span class="pre">OptionSldprt.model_json_schema()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionSldprt.model_parametrized_name"><code class="docutils literal notranslate"><span class="pre">OptionSldprt.model_parametrized_name()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionSldprt.model_post_init"><code class="docutils literal notranslate"><span class="pre">OptionSldprt.model_post_init()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionSldprt.model_rebuild"><code class="docutils literal notranslate"><span class="pre">OptionSldprt.model_rebuild()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionSldprt.model_validate"><code class="docutils literal notranslate"><span class="pre">OptionSldprt.model_validate()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionSldprt.model_validate_json"><code class="docutils literal notranslate"><span class="pre">OptionSldprt.model_validate_json()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionSldprt.model_validate_strings"><code class="docutils literal notranslate"><span class="pre">OptionSldprt.model_validate_strings()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionSldprt.parse_file"><code class="docutils literal notranslate"><span class="pre">OptionSldprt.parse_file()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionSldprt.parse_obj"><code class="docutils literal notranslate"><span class="pre">OptionSldprt.parse_obj()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionSldprt.parse_raw"><code class="docutils literal notranslate"><span class="pre">OptionSldprt.parse_raw()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionSldprt.schema"><code class="docutils literal notranslate"><span class="pre">OptionSldprt.schema()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionSldprt.schema_json"><code class="docutils literal notranslate"><span class="pre">OptionSldprt.schema_json()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionSldprt.split_closed_faces"><code class="docutils literal notranslate"><span class="pre">OptionSldprt.split_closed_faces</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionSldprt.type"><code class="docutils literal notranslate"><span class="pre">OptionSldprt.type</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionSldprt.update_forward_refs"><code class="docutils literal notranslate"><span class="pre">OptionSldprt.update_forward_refs()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionSldprt.validate"><code class="docutils literal notranslate"><span class="pre">OptionSldprt.validate()</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#kittycad.models.input_format.OptionStep"><code class="docutils literal notranslate"><span class="pre">OptionStep</span></code></a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStep.__abstractmethods__"><code class="docutils literal notranslate"><span class="pre">OptionStep.__abstractmethods__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStep.__annotations__"><code class="docutils literal notranslate"><span class="pre">OptionStep.__annotations__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStep.__class_getitem__"><code class="docutils literal notranslate"><span class="pre">OptionStep.__class_getitem__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStep.__class_vars__"><code class="docutils literal notranslate"><span class="pre">OptionStep.__class_vars__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStep.__copy__"><code class="docutils literal notranslate"><span class="pre">OptionStep.__copy__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStep.__deepcopy__"><code class="docutils literal notranslate"><span class="pre">OptionStep.__deepcopy__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStep.__delattr__"><code class="docutils literal notranslate"><span class="pre">OptionStep.__delattr__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStep.__dict__"><code class="docutils literal notranslate"><span class="pre">OptionStep.__dict__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStep.__eq__"><code class="docutils literal notranslate"><span class="pre">OptionStep.__eq__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStep.__fields_set__"><code class="docutils literal notranslate"><span class="pre">OptionStep.__fields_set__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStep.__get_pydantic_core_schema__"><code class="docutils literal notranslate"><span class="pre">OptionStep.__get_pydantic_core_schema__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStep.__get_pydantic_json_schema__"><code class="docutils literal notranslate"><span class="pre">OptionStep.__get_pydantic_json_schema__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStep.__getattr__"><code class="docutils literal notranslate"><span class="pre">OptionStep.__getattr__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStep.__getstate__"><code class="docutils literal notranslate"><span class="pre">OptionStep.__getstate__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStep.__hash__"><code class="docutils literal notranslate"><span class="pre">OptionStep.__hash__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStep.__init__"><code class="docutils literal notranslate"><span class="pre">OptionStep.__init__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStep.__iter__"><code class="docutils literal notranslate"><span class="pre">OptionStep.__iter__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStep.__module__"><code class="docutils literal notranslate"><span class="pre">OptionStep.__module__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStep.__pretty__"><code class="docutils literal notranslate"><span class="pre">OptionStep.__pretty__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStep.__private_attributes__"><code class="docutils literal notranslate"><span class="pre">OptionStep.__private_attributes__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStep.__pydantic_complete__"><code class="docutils literal notranslate"><span class="pre">OptionStep.__pydantic_complete__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStep.__pydantic_core_schema__"><code class="docutils literal notranslate"><span class="pre">OptionStep.__pydantic_core_schema__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStep.__pydantic_custom_init__"><code class="docutils literal notranslate"><span class="pre">OptionStep.__pydantic_custom_init__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStep.__pydantic_decorators__"><code class="docutils literal notranslate"><span class="pre">OptionStep.__pydantic_decorators__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStep.__pydantic_extra__"><code class="docutils literal notranslate"><span class="pre">OptionStep.__pydantic_extra__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStep.__pydantic_fields_set__"><code class="docutils literal notranslate"><span class="pre">OptionStep.__pydantic_fields_set__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStep.__pydantic_generic_metadata__"><code class="docutils literal notranslate"><span class="pre">OptionStep.__pydantic_generic_metadata__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStep.__pydantic_init_subclass__"><code class="docutils literal notranslate"><span class="pre">OptionStep.__pydantic_init_subclass__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStep.__pydantic_parent_namespace__"><code class="docutils literal notranslate"><span class="pre">OptionStep.__pydantic_parent_namespace__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStep.__pydantic_post_init__"><code class="docutils literal notranslate"><span class="pre">OptionStep.__pydantic_post_init__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStep.__pydantic_private__"><code class="docutils literal notranslate"><span class="pre">OptionStep.__pydantic_private__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStep.__pydantic_root_model__"><code class="docutils literal notranslate"><span class="pre">OptionStep.__pydantic_root_model__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStep.__pydantic_serializer__"><code class="docutils literal notranslate"><span class="pre">OptionStep.__pydantic_serializer__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStep.__pydantic_validator__"><code class="docutils literal notranslate"><span class="pre">OptionStep.__pydantic_validator__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStep.__repr__"><code class="docutils literal notranslate"><span class="pre">OptionStep.__repr__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStep.__repr_args__"><code class="docutils literal notranslate"><span class="pre">OptionStep.__repr_args__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStep.__repr_name__"><code class="docutils literal notranslate"><span class="pre">OptionStep.__repr_name__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStep.__repr_str__"><code class="docutils literal notranslate"><span class="pre">OptionStep.__repr_str__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStep.__rich_repr__"><code class="docutils literal notranslate"><span class="pre">OptionStep.__rich_repr__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStep.__setattr__"><code class="docutils literal notranslate"><span class="pre">OptionStep.__setattr__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStep.__setstate__"><code class="docutils literal notranslate"><span class="pre">OptionStep.__setstate__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStep.__signature__"><code class="docutils literal notranslate"><span class="pre">OptionStep.__signature__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStep.__slots__"><code class="docutils literal notranslate"><span class="pre">OptionStep.__slots__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStep.__str__"><code class="docutils literal notranslate"><span class="pre">OptionStep.__str__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStep._abc_impl"><code class="docutils literal notranslate"><span class="pre">OptionStep._abc_impl</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStep._calculate_keys"><code class="docutils literal notranslate"><span class="pre">OptionStep._calculate_keys()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStep._check_frozen"><code class="docutils literal notranslate"><span class="pre">OptionStep._check_frozen()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStep._copy_and_set_values"><code class="docutils literal notranslate"><span class="pre">OptionStep._copy_and_set_values()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStep._get_value"><code class="docutils literal notranslate"><span class="pre">OptionStep._get_value()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStep._iter"><code class="docutils literal notranslate"><span class="pre">OptionStep._iter()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStep.construct"><code class="docutils literal notranslate"><span class="pre">OptionStep.construct()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStep.copy"><code class="docutils literal notranslate"><span class="pre">OptionStep.copy()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStep.dict"><code class="docutils literal notranslate"><span class="pre">OptionStep.dict()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStep.from_orm"><code class="docutils literal notranslate"><span class="pre">OptionStep.from_orm()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStep.json"><code class="docutils literal notranslate"><span class="pre">OptionStep.json()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStep.model_computed_fields"><code class="docutils literal notranslate"><span class="pre">OptionStep.model_computed_fields</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStep.model_config"><code class="docutils literal notranslate"><span class="pre">OptionStep.model_config</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStep.model_construct"><code class="docutils literal notranslate"><span class="pre">OptionStep.model_construct()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStep.model_copy"><code class="docutils literal notranslate"><span class="pre">OptionStep.model_copy()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStep.model_dump"><code class="docutils literal notranslate"><span class="pre">OptionStep.model_dump()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStep.model_dump_json"><code class="docutils literal notranslate"><span class="pre">OptionStep.model_dump_json()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStep.model_extra"><code class="docutils literal notranslate"><span class="pre">OptionStep.model_extra</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStep.model_fields"><code class="docutils literal notranslate"><span class="pre">OptionStep.model_fields</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStep.model_fields_set"><code class="docutils literal notranslate"><span class="pre">OptionStep.model_fields_set</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStep.model_json_schema"><code class="docutils literal notranslate"><span class="pre">OptionStep.model_json_schema()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStep.model_parametrized_name"><code class="docutils literal notranslate"><span class="pre">OptionStep.model_parametrized_name()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStep.model_post_init"><code class="docutils literal notranslate"><span class="pre">OptionStep.model_post_init()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStep.model_rebuild"><code class="docutils literal notranslate"><span class="pre">OptionStep.model_rebuild()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStep.model_validate"><code class="docutils literal notranslate"><span class="pre">OptionStep.model_validate()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStep.model_validate_json"><code class="docutils literal notranslate"><span class="pre">OptionStep.model_validate_json()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStep.model_validate_strings"><code class="docutils literal notranslate"><span class="pre">OptionStep.model_validate_strings()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStep.parse_file"><code class="docutils literal notranslate"><span class="pre">OptionStep.parse_file()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStep.parse_obj"><code class="docutils literal notranslate"><span class="pre">OptionStep.parse_obj()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStep.parse_raw"><code class="docutils literal notranslate"><span class="pre">OptionStep.parse_raw()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStep.schema"><code class="docutils literal notranslate"><span class="pre">OptionStep.schema()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStep.schema_json"><code class="docutils literal notranslate"><span class="pre">OptionStep.schema_json()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStep.split_closed_faces"><code class="docutils literal notranslate"><span class="pre">OptionStep.split_closed_faces</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStep.type"><code class="docutils literal notranslate"><span class="pre">OptionStep.type</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStep.update_forward_refs"><code class="docutils literal notranslate"><span class="pre">OptionStep.update_forward_refs()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStep.validate"><code class="docutils literal notranslate"><span class="pre">OptionStep.validate()</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#kittycad.models.input_format.OptionStl"><code class="docutils literal notranslate"><span class="pre">OptionStl</span></code></a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStl.__abstractmethods__"><code class="docutils literal notranslate"><span class="pre">OptionStl.__abstractmethods__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStl.__annotations__"><code class="docutils literal notranslate"><span class="pre">OptionStl.__annotations__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStl.__class_getitem__"><code class="docutils literal notranslate"><span class="pre">OptionStl.__class_getitem__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStl.__class_vars__"><code class="docutils literal notranslate"><span class="pre">OptionStl.__class_vars__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStl.__copy__"><code class="docutils literal notranslate"><span class="pre">OptionStl.__copy__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStl.__deepcopy__"><code class="docutils literal notranslate"><span class="pre">OptionStl.__deepcopy__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStl.__delattr__"><code class="docutils literal notranslate"><span class="pre">OptionStl.__delattr__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStl.__dict__"><code class="docutils literal notranslate"><span class="pre">OptionStl.__dict__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStl.__eq__"><code class="docutils literal notranslate"><span class="pre">OptionStl.__eq__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStl.__fields_set__"><code class="docutils literal notranslate"><span class="pre">OptionStl.__fields_set__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStl.__get_pydantic_core_schema__"><code class="docutils literal notranslate"><span class="pre">OptionStl.__get_pydantic_core_schema__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStl.__get_pydantic_json_schema__"><code class="docutils literal notranslate"><span class="pre">OptionStl.__get_pydantic_json_schema__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStl.__getattr__"><code class="docutils literal notranslate"><span class="pre">OptionStl.__getattr__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStl.__getstate__"><code class="docutils literal notranslate"><span class="pre">OptionStl.__getstate__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStl.__hash__"><code class="docutils literal notranslate"><span class="pre">OptionStl.__hash__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStl.__init__"><code class="docutils literal notranslate"><span class="pre">OptionStl.__init__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStl.__iter__"><code class="docutils literal notranslate"><span class="pre">OptionStl.__iter__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStl.__module__"><code class="docutils literal notranslate"><span class="pre">OptionStl.__module__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStl.__pretty__"><code class="docutils literal notranslate"><span class="pre">OptionStl.__pretty__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStl.__private_attributes__"><code class="docutils literal notranslate"><span class="pre">OptionStl.__private_attributes__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStl.__pydantic_complete__"><code class="docutils literal notranslate"><span class="pre">OptionStl.__pydantic_complete__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStl.__pydantic_core_schema__"><code class="docutils literal notranslate"><span class="pre">OptionStl.__pydantic_core_schema__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStl.__pydantic_custom_init__"><code class="docutils literal notranslate"><span class="pre">OptionStl.__pydantic_custom_init__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStl.__pydantic_decorators__"><code class="docutils literal notranslate"><span class="pre">OptionStl.__pydantic_decorators__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStl.__pydantic_extra__"><code class="docutils literal notranslate"><span class="pre">OptionStl.__pydantic_extra__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStl.__pydantic_fields_set__"><code class="docutils literal notranslate"><span class="pre">OptionStl.__pydantic_fields_set__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStl.__pydantic_generic_metadata__"><code class="docutils literal notranslate"><span class="pre">OptionStl.__pydantic_generic_metadata__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStl.__pydantic_init_subclass__"><code class="docutils literal notranslate"><span class="pre">OptionStl.__pydantic_init_subclass__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStl.__pydantic_parent_namespace__"><code class="docutils literal notranslate"><span class="pre">OptionStl.__pydantic_parent_namespace__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStl.__pydantic_post_init__"><code class="docutils literal notranslate"><span class="pre">OptionStl.__pydantic_post_init__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStl.__pydantic_private__"><code class="docutils literal notranslate"><span class="pre">OptionStl.__pydantic_private__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStl.__pydantic_root_model__"><code class="docutils literal notranslate"><span class="pre">OptionStl.__pydantic_root_model__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStl.__pydantic_serializer__"><code class="docutils literal notranslate"><span class="pre">OptionStl.__pydantic_serializer__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStl.__pydantic_validator__"><code class="docutils literal notranslate"><span class="pre">OptionStl.__pydantic_validator__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStl.__repr__"><code class="docutils literal notranslate"><span class="pre">OptionStl.__repr__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStl.__repr_args__"><code class="docutils literal notranslate"><span class="pre">OptionStl.__repr_args__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStl.__repr_name__"><code class="docutils literal notranslate"><span class="pre">OptionStl.__repr_name__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStl.__repr_str__"><code class="docutils literal notranslate"><span class="pre">OptionStl.__repr_str__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStl.__rich_repr__"><code class="docutils literal notranslate"><span class="pre">OptionStl.__rich_repr__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStl.__setattr__"><code class="docutils literal notranslate"><span class="pre">OptionStl.__setattr__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStl.__setstate__"><code class="docutils literal notranslate"><span class="pre">OptionStl.__setstate__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStl.__signature__"><code class="docutils literal notranslate"><span class="pre">OptionStl.__signature__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStl.__slots__"><code class="docutils literal notranslate"><span class="pre">OptionStl.__slots__</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStl.__str__"><code class="docutils literal notranslate"><span class="pre">OptionStl.__str__()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStl._abc_impl"><code class="docutils literal notranslate"><span class="pre">OptionStl._abc_impl</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStl._calculate_keys"><code class="docutils literal notranslate"><span class="pre">OptionStl._calculate_keys()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStl._check_frozen"><code class="docutils literal notranslate"><span class="pre">OptionStl._check_frozen()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStl._copy_and_set_values"><code class="docutils literal notranslate"><span class="pre">OptionStl._copy_and_set_values()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStl._get_value"><code class="docutils literal notranslate"><span class="pre">OptionStl._get_value()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStl._iter"><code class="docutils literal notranslate"><span class="pre">OptionStl._iter()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStl.construct"><code class="docutils literal notranslate"><span class="pre">OptionStl.construct()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStl.coords"><code class="docutils literal notranslate"><span class="pre">OptionStl.coords</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStl.copy"><code class="docutils literal notranslate"><span class="pre">OptionStl.copy()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStl.dict"><code class="docutils literal notranslate"><span class="pre">OptionStl.dict()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStl.from_orm"><code class="docutils literal notranslate"><span class="pre">OptionStl.from_orm()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStl.json"><code class="docutils literal notranslate"><span class="pre">OptionStl.json()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStl.model_computed_fields"><code class="docutils literal notranslate"><span class="pre">OptionStl.model_computed_fields</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStl.model_config"><code class="docutils literal notranslate"><span class="pre">OptionStl.model_config</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStl.model_construct"><code class="docutils literal notranslate"><span class="pre">OptionStl.model_construct()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStl.model_copy"><code class="docutils literal notranslate"><span class="pre">OptionStl.model_copy()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStl.model_dump"><code class="docutils literal notranslate"><span class="pre">OptionStl.model_dump()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStl.model_dump_json"><code class="docutils literal notranslate"><span class="pre">OptionStl.model_dump_json()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStl.model_extra"><code class="docutils literal notranslate"><span class="pre">OptionStl.model_extra</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStl.model_fields"><code class="docutils literal notranslate"><span class="pre">OptionStl.model_fields</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStl.model_fields_set"><code class="docutils literal notranslate"><span class="pre">OptionStl.model_fields_set</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStl.model_json_schema"><code class="docutils literal notranslate"><span class="pre">OptionStl.model_json_schema()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStl.model_parametrized_name"><code class="docutils literal notranslate"><span class="pre">OptionStl.model_parametrized_name()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStl.model_post_init"><code class="docutils literal notranslate"><span class="pre">OptionStl.model_post_init()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStl.model_rebuild"><code class="docutils literal notranslate"><span class="pre">OptionStl.model_rebuild()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStl.model_validate"><code class="docutils literal notranslate"><span class="pre">OptionStl.model_validate()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStl.model_validate_json"><code class="docutils literal notranslate"><span class="pre">OptionStl.model_validate_json()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStl.model_validate_strings"><code class="docutils literal notranslate"><span class="pre">OptionStl.model_validate_strings()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStl.parse_file"><code class="docutils literal notranslate"><span class="pre">OptionStl.parse_file()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStl.parse_obj"><code class="docutils literal notranslate"><span class="pre">OptionStl.parse_obj()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStl.parse_raw"><code class="docutils literal notranslate"><span class="pre">OptionStl.parse_raw()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStl.schema"><code class="docutils literal notranslate"><span class="pre">OptionStl.schema()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStl.schema_json"><code class="docutils literal notranslate"><span class="pre">OptionStl.schema_json()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStl.type"><code class="docutils literal notranslate"><span class="pre">OptionStl.type</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStl.units"><code class="docutils literal notranslate"><span class="pre">OptionStl.units</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStl.update_forward_refs"><code class="docutils literal notranslate"><span class="pre">OptionStl.update_forward_refs()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.OptionStl.validate"><code class="docutils literal notranslate"><span class="pre">OptionStl.validate()</span></code></a></li>
|
||
</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>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.ip_addr_info.html">kittycad.models.ip_addr_info</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.jetstream.html">kittycad.models.jetstream</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.jetstream_api_stats.html">kittycad.models.jetstream_api_stats</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.jetstream_config.html">kittycad.models.jetstream_config</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.jetstream_stats.html">kittycad.models.jetstream_stats</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.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>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.leaf_node.html">kittycad.models.leaf_node</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.length_unit.html">kittycad.models.length_unit</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.loft.html">kittycad.models.loft</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.make_axes_gizmo.html">kittycad.models.make_axes_gizmo</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.make_plane.html">kittycad.models.make_plane</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.mass.html">kittycad.models.mass</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.meta_cluster_info.html">kittycad.models.meta_cluster_info</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.metadata.html">kittycad.models.metadata</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.method.html">kittycad.models.method</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.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>
|
||
<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>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.modeling_cmd.html">kittycad.models.modeling_cmd</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.modeling_cmd_id.html">kittycad.models.modeling_cmd_id</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.modeling_cmd_req.html">kittycad.models.modeling_cmd_req</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.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>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.mouse_move.html">kittycad.models.mouse_move</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.move_path_pen.html">kittycad.models.move_path_pen</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.new_annotation.html">kittycad.models.new_annotation</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.o_auth2_client_info.html">kittycad.models.o_auth2_client_info</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.o_auth2_grant_type.html">kittycad.models.o_auth2_grant_type</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.object_bring_to_front.html">kittycad.models.object_bring_to_front</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.object_set_material_params_pbr.html">kittycad.models.object_set_material_params_pbr</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.object_visible.html">kittycad.models.object_visible</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.ok_modeling_cmd_response.html">kittycad.models.ok_modeling_cmd_response</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.ok_web_socket_response_data.html">kittycad.models.ok_web_socket_response_data</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.onboarding.html">kittycad.models.onboarding</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.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>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.origin_type.html">kittycad.models.origin_type</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.output_file.html">kittycad.models.output_file</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.output_format.html">kittycad.models.output_format</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.path_command.html">kittycad.models.path_command</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.path_component_constraint_bound.html">kittycad.models.path_component_constraint_bound</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.path_component_constraint_type.html">kittycad.models.path_component_constraint_type</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.path_get_curve_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>
|
||
<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>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.path_segment.html">kittycad.models.path_segment</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.path_segment_info.html">kittycad.models.path_segment_info</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.payment_intent.html">kittycad.models.payment_intent</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.payment_method.html">kittycad.models.payment_method</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.payment_method_card_checks.html">kittycad.models.payment_method_card_checks</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.payment_method_type.html">kittycad.models.payment_method_type</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.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.plane_set_color.html">kittycad.models.plane_set_color</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.ply_storage.html">kittycad.models.ply_storage</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.point2d.html">kittycad.models.point2d</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.point3d.html">kittycad.models.point3d</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.point4d.html">kittycad.models.point4d</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.pong.html">kittycad.models.pong</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.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.reconfigure_stream.html">kittycad.models.reconfigure_stream</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.remove_scene_objects.html">kittycad.models.remove_scene_objects</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.revolve.html">kittycad.models.revolve</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.revolve_about_edge.html">kittycad.models.revolve_about_edge</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.rotation.html">kittycad.models.rotation</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.rtc_ice_candidate_init.html">kittycad.models.rtc_ice_candidate_init</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.rtc_sdp_type.html">kittycad.models.rtc_sdp_type</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.rtc_session_description.html">kittycad.models.rtc_session_description</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.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>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.scene_clear_all.html">kittycad.models.scene_clear_all</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.scene_selection_type.html">kittycad.models.scene_selection_type</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.scene_tool_type.html">kittycad.models.scene_tool_type</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.select_add.html">kittycad.models.select_add</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.select_clear.html">kittycad.models.select_clear</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_remove.html">kittycad.models.select_remove</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.select_replace.html">kittycad.models.select_replace</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.select_with_point.html">kittycad.models.select_with_point</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.selection.html">kittycad.models.selection</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.send_object.html">kittycad.models.send_object</a></li>
|
||
<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>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.service_account_token_uuid.html">kittycad.models.service_account_token_uuid</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.session.html">kittycad.models.session</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.session_token_uuid.html">kittycad.models.session_token_uuid</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.set_background_color.html">kittycad.models.set_background_color</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.set_current_tool_properties.html">kittycad.models.set_current_tool_properties</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.set_default_system_properties.html">kittycad.models.set_default_system_properties</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.set_scene_units.html">kittycad.models.set_scene_units</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.set_selection_filter.html">kittycad.models.set_selection_filter</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.set_selection_type.html">kittycad.models.set_selection_type</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.set_tool.html">kittycad.models.set_tool</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.sketch_mode_disable.html">kittycad.models.sketch_mode_disable</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.solid2d_add_hole.html">kittycad.models.solid2d_add_hole</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.solid3d_fillet_edge.html">kittycad.models.solid3d_fillet_edge</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.solid3d_get_all_edge_faces.html">kittycad.models.solid3d_get_all_edge_faces</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.solid3d_get_all_opposite_edges.html">kittycad.models.solid3d_get_all_opposite_edges</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.solid3d_get_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>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.solid3d_shell_face.html">kittycad.models.solid3d_shell_face</a></li>
|
||
<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.start_path.html">kittycad.models.start_path</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.stl_storage.html">kittycad.models.stl_storage</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.store_coupon_params.html">kittycad.models.store_coupon_params</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>
|
||
<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>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.system.html">kittycad.models.system</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.take_snapshot.html">kittycad.models.take_snapshot</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.text_to_cad.html">kittycad.models.text_to_cad</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.text_to_cad_create_body.html">kittycad.models.text_to_cad_create_body</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.text_to_cad_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>
|
||
<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>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.token_revoke_request_form.html">kittycad.models.token_revoke_request_form</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.transform.html">kittycad.models.transform</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.unit_angle.html">kittycad.models.unit_angle</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.unit_angle_conversion.html">kittycad.models.unit_angle_conversion</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.unit_area.html">kittycad.models.unit_area</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.unit_area_conversion.html">kittycad.models.unit_area_conversion</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.unit_current.html">kittycad.models.unit_current</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.unit_current_conversion.html">kittycad.models.unit_current_conversion</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.unit_density.html">kittycad.models.unit_density</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.unit_energy.html">kittycad.models.unit_energy</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.unit_energy_conversion.html">kittycad.models.unit_energy_conversion</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.unit_force.html">kittycad.models.unit_force</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.unit_force_conversion.html">kittycad.models.unit_force_conversion</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.unit_frequency.html">kittycad.models.unit_frequency</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.unit_frequency_conversion.html">kittycad.models.unit_frequency_conversion</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.unit_length.html">kittycad.models.unit_length</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.unit_length_conversion.html">kittycad.models.unit_length_conversion</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.unit_mass.html">kittycad.models.unit_mass</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.unit_mass_conversion.html">kittycad.models.unit_mass_conversion</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.unit_power.html">kittycad.models.unit_power</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.unit_power_conversion.html">kittycad.models.unit_power_conversion</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.unit_pressure.html">kittycad.models.unit_pressure</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.unit_pressure_conversion.html">kittycad.models.unit_pressure_conversion</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.unit_temperature.html">kittycad.models.unit_temperature</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.unit_temperature_conversion.html">kittycad.models.unit_temperature_conversion</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.unit_torque.html">kittycad.models.unit_torque</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.unit_torque_conversion.html">kittycad.models.unit_torque_conversion</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.unit_volume.html">kittycad.models.unit_volume</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.unit_volume_conversion.html">kittycad.models.unit_volume_conversion</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.update_annotation.html">kittycad.models.update_annotation</a></li>
|
||
<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>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.update_user.html">kittycad.models.update_user</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.user.html">kittycad.models.user</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.user_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>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.user_results_page.html">kittycad.models.user_results_page</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.uuid.html">kittycad.models.uuid</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.verification_token_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>
|
||
<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>
|
||
</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">
|
||
<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>
|
||
<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.OptionFbx.html#kittycad.models.input_format.OptionFbx" title="kittycad.models.input_format.OptionFbx"><code class="xref py py-obj docutils literal notranslate"><span class="pre">OptionFbx</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.OptionGltf.html#kittycad.models.input_format.OptionGltf" title="kittycad.models.input_format.OptionGltf"><code class="xref py py-obj docutils literal notranslate"><span class="pre">OptionGltf</span></code></a>(**data)</p></td>
|
||
<td><p>Binary glTF 2.0.</p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p><a class="reference internal" href="kittycad.models.input_format.OptionObj.html#kittycad.models.input_format.OptionObj" title="kittycad.models.input_format.OptionObj"><code class="xref py py-obj docutils literal notranslate"><span class="pre">OptionObj</span></code></a>(**data)</p></td>
|
||
<td><p>Wavefront OBJ format.</p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p><a class="reference internal" href="kittycad.models.input_format.OptionPly.html#kittycad.models.input_format.OptionPly" title="kittycad.models.input_format.OptionPly"><code class="xref py py-obj docutils literal notranslate"><span class="pre">OptionPly</span></code></a>(**data)</p></td>
|
||
<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.OptionSldprt.html#kittycad.models.input_format.OptionSldprt" title="kittycad.models.input_format.OptionSldprt"><code class="xref py py-obj docutils literal notranslate"><span class="pre">OptionSldprt</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.OptionStep.html#kittycad.models.input_format.OptionStep" title="kittycad.models.input_format.OptionStep"><code class="xref py py-obj docutils literal notranslate"><span class="pre">OptionStep</span></code></a>(**data)</p></td>
|
||
<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.OptionStl.html#kittycad.models.input_format.OptionStl" title="kittycad.models.input_format.OptionStl"><code class="xref py py-obj docutils literal notranslate"><span class="pre">OptionStl</span></code></a>(**data)</p></td>
|
||
<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.OptionFbx">
|
||
<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">OptionFbx</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#OptionFbx"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionFbx" 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>
|
||
<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>
|
||
<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.OptionFbx.__abstractmethods__">
|
||
<span class="sig-name descname"><span class="pre">__abstractmethods__</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">frozenset({})</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionFbx.__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.OptionFbx.__annotations__">
|
||
<span class="sig-name descname"><span class="pre">__annotations__</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'__class_vars__':</span> <span class="pre">'ClassVar[set[str]]',</span> <span class="pre">'__private_attributes__':</span> <span class="pre">'ClassVar[Dict[str,</span> <span class="pre">ModelPrivateAttr]]',</span> <span class="pre">'__pydantic_complete__':</span> <span class="pre">'ClassVar[bool]',</span> <span class="pre">'__pydantic_core_schema__':</span> <span class="pre">'ClassVar[CoreSchema]',</span> <span class="pre">'__pydantic_custom_init__':</span> <span class="pre">'ClassVar[bool]',</span> <span class="pre">'__pydantic_decorators__':</span> <span class="pre">'ClassVar[_decorators.DecoratorInfos]',</span> <span class="pre">'__pydantic_extra__':</span> <span class="pre">'dict[str,</span> <span class="pre">Any]</span> <span class="pre">|</span> <span class="pre">None',</span> <span class="pre">'__pydantic_fields_set__':</span> <span class="pre">'set[str]',</span> <span class="pre">'__pydantic_generic_metadata__':</span> <span class="pre">'ClassVar[_generics.PydanticGenericMetadata]',</span> <span class="pre">'__pydantic_parent_namespace__':</span> <span class="pre">'ClassVar[Dict[str,</span> <span class="pre">Any]</span> <span class="pre">|</span> <span class="pre">None]',</span> <span class="pre">'__pydantic_post_init__':</span> <span class="pre">"ClassVar[None</span> <span class="pre">|</span> <span class="pre">Literal['model_post_init']]",</span> <span class="pre">'__pydantic_private__':</span> <span class="pre">'dict[str,</span> <span class="pre">Any]</span> <span class="pre">|</span> <span class="pre">None',</span> <span class="pre">'__pydantic_root_model__':</span> <span class="pre">'ClassVar[bool]',</span> <span class="pre">'__pydantic_serializer__':</span> <span class="pre">'ClassVar[SchemaSerializer]',</span> <span class="pre">'__pydantic_validator__':</span> <span class="pre">'ClassVar[SchemaValidator</span> <span class="pre">|</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.OptionFbx.__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.OptionFbx.__class_getitem__">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">__class_getitem__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">typevar_values</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionFbx.__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.OptionFbx.html#kittycad.models.input_format.OptionFbx.type" title="kittycad.models.input_format.OptionFbx.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.OptionFbx.__class_vars__">
|
||
<span class="sig-name descname"><span class="pre">__class_vars__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[set[str]]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionFbx.__class_vars__" title="Link to this definition"></a></dt>
|
||
<dd><p>The names of the class variables defined on the model.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionFbx.__copy__">
|
||
<span class="sig-name descname"><span class="pre">__copy__</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionFbx.__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>
|
||
<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.OptionFbx.__deepcopy__">
|
||
<span class="sig-name descname"><span class="pre">__deepcopy__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">memo</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionFbx.__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>
|
||
<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.OptionFbx.__delattr__">
|
||
<span class="sig-name descname"><span class="pre">__delattr__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">item</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionFbx.__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>
|
||
<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.OptionFbx.__dict__">
|
||
<span class="sig-name descname"><span class="pre">__dict__</span></span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionFbx.__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.OptionFbx.__eq__">
|
||
<span class="sig-name descname"><span class="pre">__eq__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">other</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionFbx.__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>
|
||
<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.OptionFbx.__fields_set__">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">__fields_set__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#set" title="(in Python v3.12)"><span class="pre">set</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionFbx.__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.OptionFbx.__get_pydantic_core_schema__">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">__get_pydantic_core_schema__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">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.OptionFbx.__get_pydantic_core_schema__" title="Link to this definition"></a></dt>
|
||
<dd><p>Hook into generating the model’s CoreSchema.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>source</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference internal" href="kittycad.models.input_format.OptionFbx.html#kittycad.models.input_format.OptionFbx.type" title="kittycad.models.input_format.OptionFbx.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 Pydantic’s internal CoreSchema generation logic.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><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 class="xref py py-class docutils literal notranslate"><span class="pre">ModelFieldsSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">ModelSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">DataclassArgsSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">DataclassSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">ArgumentsSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">CallSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">CustomErrorSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">JsonSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">UrlSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">MultiHostUrlSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">DefinitionsSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">DefinitionReferenceSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">UuidSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">ComplexSchema</span></code>]</span></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<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.OptionFbx.__get_pydantic_json_schema__">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">__get_pydantic_json_schema__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">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.OptionFbx.__get_pydantic_json_schema__" title="Link to this definition"></a></dt>
|
||
<dd><p>Hook into generating the model’s JSON schema.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>core_schema</strong> (<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 class="xref py py-class docutils literal notranslate"><span class="pre">ModelFieldsSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">ModelSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">DataclassArgsSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">DataclassSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">ArgumentsSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">CallSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">CustomErrorSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">JsonSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">UrlSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">MultiHostUrlSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">DefinitionsSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">DefinitionReferenceSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">UuidSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">ComplexSchema</span></code>]</span>) – A <code class="xref any docutils literal notranslate"><span class="pre">pydantic-core</span></code> CoreSchema.
|
||
You can ignore this argument and call the handler with a new CoreSchema,
|
||
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>
|
||
<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 Pydantic’s 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.
|
||
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>
|
||
<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.OptionFbx.__getattr__">
|
||
<span class="sig-name descname"><span class="pre">__getattr__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">item</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionFbx.__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>
|
||
<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.OptionFbx.__getstate__">
|
||
<span class="sig-name descname"><span class="pre">__getstate__</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionFbx.__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>
|
||
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><a class="reference internal" href="kittycad.models.input_format.OptionFbx.html#kittycad.models.input_format.OptionFbx.dict" title="kittycad.models.input_format.OptionFbx.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.OptionFbx.__hash__">
|
||
<span class="sig-name descname"><span class="pre">__hash__</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionFbx.__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.OptionFbx.__init__">
|
||
<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">data</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionFbx.__init__" title="Link to this definition"></a></dt>
|
||
<dd><p>Create a new model by parsing and validating input data from keyword arguments.</p>
|
||
<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>
|
||
<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.OptionFbx.__iter__">
|
||
<span class="sig-name descname"><span class="pre">__iter__</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionFbx.__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>
|
||
<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.OptionFbx.__module__">
|
||
<span class="sig-name descname"><span class="pre">__module__</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'kittycad.models.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.OptionFbx.__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.OptionFbx.__pretty__">
|
||
<span class="sig-name descname"><span class="pre">__pretty__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">fmt</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionFbx.__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>
|
||
<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.OptionFbx.__private_attributes__">
|
||
<span class="sig-name descname"><span class="pre">__private_attributes__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[Dict[str,</span> <span class="pre">ModelPrivateAttr]]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionFbx.__private_attributes__" title="Link to this definition"></a></dt>
|
||
<dd><p>Metadata about the private attributes of the model.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionFbx.__pydantic_complete__">
|
||
<span class="sig-name descname"><span class="pre">__pydantic_complete__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[bool]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">True</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionFbx.__pydantic_complete__" title="Link to this definition"></a></dt>
|
||
<dd><p>Whether model building is completed, or if there are still undefined fields.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionFbx.__pydantic_core_schema__">
|
||
<span class="sig-name descname"><span class="pre">__pydantic_core_schema__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[CoreSchema]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'cls':</span> <span class="pre"><class</span> <span class="pre">'kittycad.models.input_format.OptionFbx'>,</span> <span class="pre">'config':</span> <span class="pre">{'title':</span> <span class="pre">'OptionFbx'},</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(<function</span> <span class="pre">modify_model_json_schema>,</span> <span class="pre">cls=<class</span> <span class="pre">'kittycad.models.input_format.OptionFbx'>,</span> <span class="pre">title=None),</span> <span class="pre"><bound</span> <span class="pre">method</span> <span class="pre">BaseModel.__get_pydantic_json_schema__</span> <span class="pre">of</span> <span class="pre"><class</span> <span class="pre">'kittycad.models.input_format.OptionFbx'>>]},</span> <span class="pre">'ref':</span> <span class="pre">'kittycad.models.input_format.OptionFbx:94740974306848',</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">[<function</span> <span class="pre">get_json_schema_update_func.<locals>.json_schema_update_func>],</span> <span class="pre">'pydantic_js_functions':</span> <span class="pre">[]},</span> <span class="pre">'schema':</span> <span class="pre">{'default':</span> <span class="pre">'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">'OptionFbx',</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.OptionFbx.__pydantic_core_schema__" title="Link to this definition"></a></dt>
|
||
<dd><p>The core schema of the model.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionFbx.__pydantic_custom_init__">
|
||
<span class="sig-name descname"><span class="pre">__pydantic_custom_init__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[bool]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">False</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionFbx.__pydantic_custom_init__" title="Link to this definition"></a></dt>
|
||
<dd><p>Whether the model has a custom <a class="reference internal" href="kittycad.models.input_format.OptionFbx.html#id0" title="kittycad.models.input_format.OptionFbx.__init__"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">__init__</span></code></a> method.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionFbx.__pydantic_decorators__">
|
||
<span class="sig-name descname"><span class="pre">__pydantic_decorators__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[_decorators.DecoratorInfos]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">DecoratorInfos(validators={},</span> <span class="pre">field_validators={},</span> <span class="pre">root_validators={},</span> <span class="pre">field_serializers={},</span> <span class="pre">model_serializers={},</span> <span class="pre">model_validators={},</span> <span class="pre">computed_fields={})</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionFbx.__pydantic_decorators__" title="Link to this definition"></a></dt>
|
||
<dd><p>Metadata containing the decorators defined on the model.
|
||
This replaces <code class="xref any docutils literal notranslate"><span class="pre">Model.__validators__</span></code> and <code class="xref any docutils literal notranslate"><span class="pre">Model.__root_validators__</span></code> from Pydantic V1.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionFbx.__pydantic_extra__">
|
||
<span class="sig-name descname"><span class="pre">__pydantic_extra__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">dict[str,</span> <span class="pre">Any]</span> <span class="pre">|</span> <span class="pre">None</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionFbx.__pydantic_extra__" title="Link to this definition"></a></dt>
|
||
<dd><p>A dictionary containing extra values, if [<a class="reference internal" href="kittycad.models.kcl_code_completion_request.KclCodeCompletionRequest.html#kittycad.models.kcl_code_completion_request.KclCodeCompletionRequest.extra" title="kittycad.models.kcl_code_completion_request.KclCodeCompletionRequest.extra"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">extra</span></code></a>][pydantic.config.ConfigDict.extra] is set to <code class="xref any docutils literal notranslate"><span class="pre">'allow'</span></code>.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionFbx.__pydantic_fields_set__">
|
||
<span class="sig-name descname"><span class="pre">__pydantic_fields_set__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">set[str]</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionFbx.__pydantic_fields_set__" title="Link to this definition"></a></dt>
|
||
<dd><p>The names of fields explicitly set during instantiation.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionFbx.__pydantic_generic_metadata__">
|
||
<span class="sig-name descname"><span class="pre">__pydantic_generic_metadata__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[_generics.PydanticGenericMetadata]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'args':</span> <span class="pre">(),</span> <span class="pre">'origin':</span> <span class="pre">None,</span> <span class="pre">'parameters':</span> <span class="pre">()}</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionFbx.__pydantic_generic_metadata__" title="Link to this definition"></a></dt>
|
||
<dd><p>Metadata for generic models; contains data used for a similar purpose to
|
||
__args__, __origin__, __parameters__ in typing-module generics. May eventually be replaced by these.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionFbx.__pydantic_init_subclass__">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">__pydantic_init_subclass__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionFbx.__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.OptionFbx.html#kittycad.models.input_format.OptionFbx.model_fields" title="kittycad.models.input_format.OptionFbx.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>
|
||
<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 aren’t used internally by pydantic.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>**kwargs</strong> (<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 aren’t used internally
|
||
by pydantic.</p>
|
||
</dd>
|
||
<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/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.OptionFbx.__pydantic_parent_namespace__">
|
||
<span class="sig-name descname"><span class="pre">__pydantic_parent_namespace__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[Dict[str,</span> <span class="pre">Any]</span> <span class="pre">|</span> <span class="pre">None]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">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.OptionFbx.__pydantic_parent_namespace__" title="Link to this definition"></a></dt>
|
||
<dd><p>Parent namespace of the model, used for automatic rebuilding of models.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionFbx.__pydantic_post_init__">
|
||
<span class="sig-name descname"><span class="pre">__pydantic_post_init__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[None</span> <span class="pre">|</span> <span class="pre">Literal['model_post_init']]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionFbx.__pydantic_post_init__" title="Link to this definition"></a></dt>
|
||
<dd><p>The name of the post-init method for the model, if defined.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionFbx.__pydantic_private__">
|
||
<span class="sig-name descname"><span class="pre">__pydantic_private__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">dict[str,</span> <span class="pre">Any]</span> <span class="pre">|</span> <span class="pre">None</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionFbx.__pydantic_private__" title="Link to this definition"></a></dt>
|
||
<dd><p>Values of private attributes set on the model instance.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionFbx.__pydantic_root_model__">
|
||
<span class="sig-name descname"><span class="pre">__pydantic_root_model__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[bool]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">False</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionFbx.__pydantic_root_model__" title="Link to this definition"></a></dt>
|
||
<dd><p>Whether the model is a [<code class="xref any docutils literal notranslate"><span class="pre">RootModel</span></code>][pydantic.root_model.RootModel].</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionFbx.__pydantic_serializer__">
|
||
<span class="sig-name descname"><span class="pre">__pydantic_serializer__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[SchemaSerializer]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">SchemaSerializer(serializer=Model(</span>     <span class="pre">ModelSerializer</span> <span class="pre">{</span>         <span class="pre">class:</span> <span class="pre">Py(</span>             <span class="pre">0x0000562a9a1e8620,</span>         <span class="pre">),</span>         <span class="pre">serializer:</span> <span class="pre">Fields(</span>             <span class="pre">GeneralFieldsSerializer</span> <span class="pre">{</span>                 <span class="pre">fields:</span> <span class="pre">{</span>                     <span class="pre">"type":</span> <span class="pre">SerField</span> <span class="pre">{</span>                         <span class="pre">key_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007f936f623938,</span>                         <span class="pre">),</span>                         <span class="pre">alias:</span> <span class="pre">None,</span>                         <span class="pre">alias_py:</span> <span class="pre">None,</span>                         <span class="pre">serializer:</span> <span class="pre">Some(</span>                             <span class="pre">WithDefault(</span>                                 <span class="pre">WithDefaultSerializer</span> <span class="pre">{</span>                                     <span class="pre">default:</span> <span class="pre">Default(</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007f936b879830,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                     <span class="pre">serializer:</span> <span class="pre">Literal(</span>                                         <span class="pre">LiteralSerializer</span> <span class="pre">{</span>                                             <span class="pre">expected_int:</span> <span class="pre">{},</span>                                             <span class="pre">expected_str:</span> <span class="pre">{</span>                                                 <span class="pre">"fbx",</span>                                             <span class="pre">},</span>                                             <span class="pre">expected_py:</span> <span class="pre">None,</span>                                             <span class="pre">name:</span> <span class="pre">"literal['fbx']",</span>                                         <span class="pre">},</span>                                     <span class="pre">),</span>                                 <span class="pre">},</span>                             <span class="pre">),</span>                         <span class="pre">),</span>                         <span class="pre">required:</span> <span class="pre">true,</span>                     <span class="pre">},</span>                 <span class="pre">},</span>                 <span class="pre">computed_fields:</span> <span class="pre">Some(</span>                     <span class="pre">ComputedFields(</span>                         <span class="pre">[],</span>                     <span class="pre">),</span>                 <span class="pre">),</span>                 <span class="pre">mode:</span> <span class="pre">SimpleDict,</span>                 <span class="pre">extra_serializer:</span> <span class="pre">None,</span>                 <span class="pre">filter:</span> <span class="pre">SchemaFilter</span> <span class="pre">{</span>                     <span class="pre">include:</span> <span class="pre">None,</span>                     <span class="pre">exclude:</span> <span class="pre">None,</span>                 <span class="pre">},</span>                 <span class="pre">required_fields:</span> <span class="pre">1,</span>             <span class="pre">},</span>         <span class="pre">),</span>         <span class="pre">has_extra:</span> <span class="pre">false,</span>         <span class="pre">root_model:</span> <span class="pre">false,</span>         <span class="pre">name:</span> <span class="pre">"OptionFbx",</span>     <span class="pre">},</span> <span class="pre">),</span> <span class="pre">definitions=[])</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.OptionFbx.__pydantic_serializer__" title="Link to this definition"></a></dt>
|
||
<dd><p>The <code class="xref any docutils literal notranslate"><span class="pre">pydantic-core</span></code> <code class="xref any docutils literal notranslate"><span class="pre">SchemaSerializer</span></code> used to dump instances of the model.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionFbx.__pydantic_validator__">
|
||
<span class="sig-name descname"><span class="pre">__pydantic_validator__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[SchemaValidator</span> <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="OptionFbx",</span> <span class="pre">validator=Model(</span>     <span class="pre">ModelValidator</span> <span class="pre">{</span>         <span class="pre">revalidate:</span> <span class="pre">Never,</span>         <span class="pre">validator:</span> <span class="pre">ModelFields(</span>             <span class="pre">ModelFieldsValidator</span> <span class="pre">{</span>                 <span class="pre">fields:</span> <span class="pre">[</span>                     <span class="pre">Field</span> <span class="pre">{</span>                         <span class="pre">name:</span> <span class="pre">"type",</span>                         <span class="pre">lookup_key:</span> <span class="pre">Simple</span> <span class="pre">{</span>                             <span class="pre">key:</span> <span class="pre">"type",</span>                             <span class="pre">py_key:</span> <span class="pre">Py(</span>                                 <span class="pre">0x00007f936b87a370,</span>                             <span class="pre">),</span>                             <span class="pre">path:</span> <span class="pre">LookupPath(</span>                                 <span class="pre">[</span>                                     <span class="pre">S(</span>                                         <span class="pre">"type",</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007f936b87a3d0,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                 <span class="pre">],</span>                             <span class="pre">),</span>                         <span class="pre">},</span>                         <span class="pre">name_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007f936f623938,</span>                         <span class="pre">),</span>                         <span class="pre">validator:</span> <span class="pre">WithDefault(</span>                             <span class="pre">WithDefaultValidator</span> <span class="pre">{</span>                                 <span class="pre">default:</span> <span class="pre">Default(</span>                                     <span class="pre">Py(</span>                                         <span class="pre">0x00007f936b879830,</span>                                     <span class="pre">),</span>                                 <span class="pre">),</span>                                 <span class="pre">on_error:</span> <span class="pre">Raise,</span>                                 <span class="pre">validator:</span> <span class="pre">Literal(</span>                                     <span class="pre">LiteralValidator</span> <span class="pre">{</span>                                         <span class="pre">lookup:</span> <span class="pre">LiteralLookup</span> <span class="pre">{</span>                                             <span class="pre">expected_bool:</span> <span class="pre">None,</span>                                             <span class="pre">expected_int:</span> <span class="pre">None,</span>                                             <span class="pre">expected_str:</span> <span class="pre">Some(</span>                                                 <span class="pre">{</span>                                                     <span class="pre">"fbx":</span> <span class="pre">0,</span>                                                 <span class="pre">},</span>                                             <span class="pre">),</span>                                             <span class="pre">expected_py_dict:</span> <span class="pre">None,</span>                                             <span class="pre">expected_py_values:</span> <span class="pre">None,</span>                                             <span class="pre">values:</span> <span class="pre">[</span>                                                 <span class="pre">Py(</span>                                                     <span class="pre">0x00007f936b879830,</span>                                                 <span class="pre">),</span>                                             <span class="pre">],</span>                                         <span class="pre">},</span>                                         <span class="pre">expected_repr:</span> <span class="pre">"'fbx'",</span>                                         <span class="pre">name:</span> <span class="pre">"literal['fbx']",</span>                                     <span class="pre">},</span>                                 <span class="pre">),</span>                                 <span class="pre">validate_default:</span> <span class="pre">false,</span>                                 <span class="pre">copy_default:</span> <span class="pre">false,</span>                                 <span class="pre">name:</span> <span class="pre">"default[literal['fbx']]",</span>                                 <span class="pre">undefined:</span> <span class="pre">Py(</span>                                     <span class="pre">0x00007f936d406320,</span>                                 <span class="pre">),</span>                             <span class="pre">},</span>                         <span class="pre">),</span>                         <span class="pre">frozen:</span> <span class="pre">false,</span>                     <span class="pre">},</span>                 <span class="pre">],</span>                 <span class="pre">model_name:</span> <span class="pre">"OptionFbx",</span>                 <span class="pre">extra_behavior:</span> <span class="pre">Ignore,</span>                 <span class="pre">extras_validator:</span> <span class="pre">None,</span>                 <span class="pre">strict:</span> <span class="pre">false,</span>                 <span class="pre">from_attributes:</span> <span class="pre">false,</span>                 <span class="pre">loc_by_alias:</span> <span class="pre">true,</span>             <span class="pre">},</span>         <span class="pre">),</span>         <span class="pre">class:</span> <span class="pre">Py(</span>             <span class="pre">0x0000562a9a1e8620,</span>         <span class="pre">),</span>         <span class="pre">post_init:</span> <span class="pre">None,</span>         <span class="pre">frozen:</span> <span class="pre">false,</span>         <span class="pre">custom_init:</span> <span class="pre">false,</span>         <span class="pre">root_model:</span> <span class="pre">false,</span>         <span class="pre">undefined:</span> <span class="pre">Py(</span>             <span class="pre">0x00007f936d406320,</span>         <span class="pre">),</span>         <span class="pre">name:</span> <span class="pre">"OptionFbx",</span>     <span class="pre">},</span> <span class="pre">),</span> <span class="pre">definitions=[],</span> <span class="pre">cache_strings=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.OptionFbx.__pydantic_validator__" title="Link to this definition"></a></dt>
|
||
<dd><p>The <code class="xref any docutils literal notranslate"><span class="pre">pydantic-core</span></code> <code class="xref any docutils literal notranslate"><span class="pre">SchemaValidator</span></code> used to validate instances of the model.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionFbx.__repr__">
|
||
<span class="sig-name descname"><span class="pre">__repr__</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionFbx.__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>
|
||
<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.OptionFbx.__repr_args__">
|
||
<span class="sig-name descname"><span class="pre">__repr_args__</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionFbx.__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/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/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/typing.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.OptionFbx.__repr_name__">
|
||
<span class="sig-name descname"><span class="pre">__repr_name__</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionFbx.__repr_name__" title="Link to this definition"></a></dt>
|
||
<dd><p>Name of the instance’s class, used in __repr__.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><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.OptionFbx.__repr_str__">
|
||
<span class="sig-name descname"><span class="pre">__repr_str__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">join_str</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionFbx.__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>
|
||
<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.OptionFbx.__rich_repr__">
|
||
<span class="sig-name descname"><span class="pre">__rich_repr__</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionFbx.__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>
|
||
<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.OptionFbx.__setattr__">
|
||
<span class="sig-name descname"><span class="pre">__setattr__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionFbx.__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>
|
||
<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.OptionFbx.__setstate__">
|
||
<span class="sig-name descname"><span class="pre">__setstate__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">state</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionFbx.__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>
|
||
<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.OptionFbx.__signature__">
|
||
<span class="sig-name descname"><span class="pre">__signature__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[Signature]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre"><Signature</span> <span class="pre">(*,</span> <span class="pre">type:</span> <span class="pre">Literal['fbx']</span> <span class="pre">=</span> <span class="pre">'fbx')</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.OptionFbx.__signature__" title="Link to this definition"></a></dt>
|
||
<dd><p>The synthesized <a class="reference internal" href="kittycad.models.input_format.OptionFbx.html#id0" title="kittycad.models.input_format.OptionFbx.__init__"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">__init__</span></code></a> [<code class="xref any docutils literal notranslate"><span class="pre">Signature</span></code>][inspect.Signature] of the model.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionFbx.__slots__">
|
||
<span class="sig-name descname"><span class="pre">__slots__</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">('__dict__',</span> <span class="pre">'__pydantic_fields_set__',</span> <span class="pre">'__pydantic_extra__',</span> <span class="pre">'__pydantic_private__')</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionFbx.__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.OptionFbx.__str__">
|
||
<span class="sig-name descname"><span class="pre">__str__</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionFbx.__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>
|
||
<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.OptionFbx._abc_impl">
|
||
<span class="sig-name descname"><span class="pre">_abc_impl</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre"><_abc._abc_data</span> <span class="pre">object></span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionFbx._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.OptionFbx._calculate_keys">
|
||
<span class="sig-name descname"><span class="pre">_calculate_keys</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionFbx._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>
|
||
<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.OptionFbx._check_frozen">
|
||
<span class="sig-name descname"><span class="pre">_check_frozen</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionFbx._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>
|
||
<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.OptionFbx._copy_and_set_values">
|
||
<span class="sig-name descname"><span class="pre">_copy_and_set_values</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionFbx._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>
|
||
<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.OptionFbx._get_value">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">_get_value</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="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.OptionFbx._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>
|
||
<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.OptionFbx._iter">
|
||
<span class="sig-name descname"><span class="pre">_iter</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionFbx._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>
|
||
<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.OptionFbx.construct">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">construct</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_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.OptionFbx.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>
|
||
<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.OptionFbx.copy">
|
||
<span class="sig-name descname"><span class="pre">copy</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">include</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exclude</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">update</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">deep</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionFbx.copy" title="Link to this definition"></a></dt>
|
||
<dd><p>Returns a copy of the model.</p>
|
||
<dl class="simple">
|
||
<dt>!!! warning “Deprecated”</dt><dd><p>This method is now deprecated; use <a class="reference internal" href="kittycad.models.input_format.OptionFbx.html#kittycad.models.input_format.OptionFbx.model_copy" title="kittycad.models.input_format.OptionFbx.model_copy"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">model_copy</span></code></a> instead.</p>
|
||
</dd>
|
||
</dl>
|
||
<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">
|
||
<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>
|
||
<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.OptionFbx.dict">
|
||
<span class="sig-name descname"><span class="pre">dict</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">include</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exclude</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">by_alias</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exclude_unset</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exclude_defaults</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exclude_none</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionFbx.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>
|
||
<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.OptionFbx.from_orm">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_orm</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">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.OptionFbx.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>
|
||
<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.OptionFbx.json">
|
||
<span class="sig-name descname"><span class="pre">json</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">include</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exclude</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">by_alias</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exclude_unset</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exclude_defaults</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exclude_none</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">encoder</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">PydanticUndefined</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">models_as_dict</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">PydanticUndefined</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">dumps_kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionFbx.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>
|
||
<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.OptionFbx.model_computed_fields">
|
||
<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.OptionFbx.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.OptionFbx.model_config">
|
||
<span class="sig-name descname"><span class="pre">model_config</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[ConfigDict]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'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.OptionFbx.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.OptionFbx.model_construct">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">model_construct</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_fields_set</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">values</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionFbx.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.OptionFbx.html#kittycad.models.input_format.OptionFbx.__dict__" title="kittycad.models.input_format.OptionFbx.__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.OptionFbx.html#kittycad.models.input_format.OptionFbx.__pydantic_fields_set__" title="kittycad.models.input_format.OptionFbx.__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.OptionFbx.html#kittycad.models.input_format.OptionFbx.model_construct" title="kittycad.models.input_format.OptionFbx.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 instance’s <a class="reference internal" href="kittycad.models.input_format.OptionFbx.html#kittycad.models.input_format.OptionFbx.__dict__" title="kittycad.models.input_format.OptionFbx.__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.OptionFbx.html#kittycad.models.input_format.OptionFbx.__pydantic_extra__" title="kittycad.models.input_format.OptionFbx.__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.OptionFbx.html#kittycad.models.input_format.OptionFbx.model_construct" title="kittycad.models.input_format.OptionFbx.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">
|
||
<li><p><strong>_fields_set</strong> (<span class="sphinx_autodoc_typehints-type"><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>] | <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 field names that were originally explicitly set during instantiation. If provided,
|
||
this is directly used for the [<a class="reference internal" href="kittycad.models.input_format.OptionFbx.html#kittycad.models.input_format.OptionFbx.model_fields_set" title="kittycad.models.input_format.OptionFbx.model_fields_set"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">model_fields_set</span></code></a>][pydantic.BaseModel.model_fields_set] attribute.
|
||
Otherwise, the field names from the <code class="xref any docutils literal notranslate"><span class="pre">values</span></code> argument will be used.</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>
|
||
<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>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.OptionFbx.model_copy">
|
||
<span class="sig-name descname"><span class="pre">model_copy</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">update</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">deep</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionFbx.model_copy" title="Link to this definition"></a></dt>
|
||
<dd><p>Usage docs: <a class="reference external" href="https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy">https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy</a></p>
|
||
<p>Returns a copy of the model.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>update</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference internal" href="kittycad.models.input_format.OptionFbx.html#kittycad.models.input_format.OptionFbx.dict" title="kittycad.models.input_format.OptionFbx.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>] | <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>) – Values to change/add in the new model. Note: the data is not validated
|
||
before creating the new model. You should trust this data.</p></li>
|
||
<li><p><strong>deep</strong> (<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>
|
||
<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.OptionFbx.model_dump">
|
||
<span class="sig-name descname"><span class="pre">model_dump</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mode</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'python'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">include</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exclude</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">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.OptionFbx.model_dump" title="Link to this definition"></a></dt>
|
||
<dd><p>Usage docs: <a class="reference external" href="https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump">https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump</a></p>
|
||
<p>Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>mode</strong> (<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.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.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.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[IncEx, <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">True</span></code>]]], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[IncEx, <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">True</span></code>]]], <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">True</span></code>]]], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.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.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[IncEx, <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">True</span></code>]]], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[IncEx, <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">True</span></code>]]], <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">True</span></code>]]], <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.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.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.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[IncEx, <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">True</span></code>]]], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[IncEx, <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">True</span></code>]]], <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">True</span></code>]]], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.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.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[IncEx, <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">True</span></code>]]], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[IncEx, <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">True</span></code>]]], <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">True</span></code>]]], <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.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>) – 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 field’s 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>
|
||
<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.OptionFbx.html#kittycad.models.input_format.OptionFbx.dict" title="kittycad.models.input_format.OptionFbx.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.OptionFbx.model_dump_json">
|
||
<span class="sig-name descname"><span class="pre">model_dump_json</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">indent</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">include</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exclude</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">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.OptionFbx.model_dump_json" title="Link to this definition"></a></dt>
|
||
<dd><p>Usage docs: <a class="reference external" href="https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json">https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json</a></p>
|
||
<p>Generates a JSON representation of the model using Pydantic’s <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">
|
||
<li><p><strong>indent</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> | <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>) – 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.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.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.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[IncEx, <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">True</span></code>]]], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[IncEx, <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">True</span></code>]]], <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">True</span></code>]]], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.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.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[IncEx, <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">True</span></code>]]], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[IncEx, <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">True</span></code>]]], <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">True</span></code>]]], <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.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.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.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[IncEx, <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">True</span></code>]]], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[IncEx, <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">True</span></code>]]], <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">True</span></code>]]], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.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.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[IncEx, <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">True</span></code>]]], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[IncEx, <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">True</span></code>]]], <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">True</span></code>]]], <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.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>) – 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>
|
||
<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.OptionFbx.model_extra">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">model_extra</span></span><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.OptionFbx.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>
|
||
<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">"allow"</span></code>.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionFbx.model_fields">
|
||
<span class="sig-name descname"><span class="pre">model_fields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[Dict[str,</span> <span class="pre">FieldInfo]]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'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.OptionFbx.model_fields" title="Link to this definition"></a></dt>
|
||
<dd><p>Metadata about the fields defined on the model,
|
||
mapping of field names to [<code class="xref any docutils literal notranslate"><span class="pre">FieldInfo</span></code>][pydantic.fields.FieldInfo] objects.</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.OptionFbx.model_fields_set">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">model_fields_set</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#set" title="(in Python v3.12)"><span class="pre">set</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionFbx.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.OptionFbx.model_json_schema">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">model_json_schema</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">by_alias=True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ref_template='#/$defs/{model}'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">schema_generator=<class</span> <span class="pre">'pydantic.json_schema.GenerateJsonSchema'></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mode='validation'</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionFbx.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">
|
||
<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.OptionFbx.html#kittycad.models.input_format.OptionFbx.type" title="kittycad.models.input_format.OptionFbx.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>
|
||
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><a class="reference internal" href="kittycad.models.input_format.OptionFbx.html#kittycad.models.input_format.OptionFbx.dict" title="kittycad.models.input_format.OptionFbx.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.OptionFbx.model_parametrized_name">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">model_parametrized_name</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">params</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionFbx.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>
|
||
<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.OptionFbx.html#kittycad.models.input_format.OptionFbx.type" title="kittycad.models.input_format.OptionFbx.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>
|
||
<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>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.OptionFbx.model_post_init">
|
||
<span class="sig-name descname"><span class="pre">model_post_init</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_BaseModel__context</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionFbx.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.OptionFbx.html#id0" title="kittycad.models.input_format.OptionFbx.__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.OptionFbx.html#kittycad.models.input_format.OptionFbx.model_construct" title="kittycad.models.input_format.OptionFbx.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>
|
||
<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.OptionFbx.model_rebuild">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">model_rebuild</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">force</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">raise_errors</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_parent_namespace_depth</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">2</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_types_namespace</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionFbx.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">
|
||
<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 internal" href="kittycad.models.input_format.OptionFbx.html#kittycad.models.input_format.OptionFbx.dict" title="kittycad.models.input_format.OptionFbx.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>] | <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>) – 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>
|
||
<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/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/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>
|
||
<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.OptionFbx.model_validate">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">model_validate</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">obj</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">strict</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">from_attributes</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">context</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionFbx.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">
|
||
<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/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/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>) – 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/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/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>) – 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.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>) – Additional context to pass to the validator.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><strong>ValidationError</strong> – If the object could not be validated.</p>
|
||
</dd>
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><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.OptionFbx.model_validate_json">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">model_validate_json</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">json_data</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">strict</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">context</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionFbx.model_validate_json" title="Link to this definition"></a></dt>
|
||
<dd><p>Usage docs: <a class="reference external" href="https://docs.pydantic.dev/2.9/concepts/json/#json-parsing">https://docs.pydantic.dev/2.9/concepts/json/#json-parsing</a></p>
|
||
<p>Validate the given JSON data against the Pydantic model.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>json_data</strong> (<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/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/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>) – 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.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>) – Extra variables to pass to the validator.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><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>
|
||
<dd class="field-even"><p><strong>ValidationError</strong> – If <code class="xref any docutils literal notranslate"><span class="pre">json_data</span></code> is not a JSON string or the object could not be validated.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionFbx.model_validate_strings">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">model_validate_strings</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">obj</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">strict</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">context</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionFbx.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">
|
||
<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/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/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>) – 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.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>) – Extra variables to pass to the validator.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><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.OptionFbx.parse_file">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">parse_file</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">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.OptionFbx.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>
|
||
<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.OptionFbx.parse_obj">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">parse_obj</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">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.OptionFbx.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>
|
||
<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.OptionFbx.parse_raw">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">parse_raw</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">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.OptionFbx.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>
|
||
<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.OptionFbx.schema">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">schema</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">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.OptionFbx.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>
|
||
<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.OptionFbx.schema_json">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">schema_json</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="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.OptionFbx.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>
|
||
<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.OptionFbx.type">
|
||
<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.OptionFbx.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.OptionFbx.update_forward_refs">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">update_forward_refs</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="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.OptionFbx.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>
|
||
<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.OptionFbx.validate">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">validate</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">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.OptionFbx.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>
|
||
<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.OptionGltf">
|
||
<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">OptionGltf</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#OptionGltf"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionGltf" 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>
|
||
<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>
|
||
<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.OptionGltf.__abstractmethods__">
|
||
<span class="sig-name descname"><span class="pre">__abstractmethods__</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">frozenset({})</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionGltf.__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.OptionGltf.__annotations__">
|
||
<span class="sig-name descname"><span class="pre">__annotations__</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'__class_vars__':</span> <span class="pre">'ClassVar[set[str]]',</span> <span class="pre">'__private_attributes__':</span> <span class="pre">'ClassVar[Dict[str,</span> <span class="pre">ModelPrivateAttr]]',</span> <span class="pre">'__pydantic_complete__':</span> <span class="pre">'ClassVar[bool]',</span> <span class="pre">'__pydantic_core_schema__':</span> <span class="pre">'ClassVar[CoreSchema]',</span> <span class="pre">'__pydantic_custom_init__':</span> <span class="pre">'ClassVar[bool]',</span> <span class="pre">'__pydantic_decorators__':</span> <span class="pre">'ClassVar[_decorators.DecoratorInfos]',</span> <span class="pre">'__pydantic_extra__':</span> <span class="pre">'dict[str,</span> <span class="pre">Any]</span> <span class="pre">|</span> <span class="pre">None',</span> <span class="pre">'__pydantic_fields_set__':</span> <span class="pre">'set[str]',</span> <span class="pre">'__pydantic_generic_metadata__':</span> <span class="pre">'ClassVar[_generics.PydanticGenericMetadata]',</span> <span class="pre">'__pydantic_parent_namespace__':</span> <span class="pre">'ClassVar[Dict[str,</span> <span class="pre">Any]</span> <span class="pre">|</span> <span class="pre">None]',</span> <span class="pre">'__pydantic_post_init__':</span> <span class="pre">"ClassVar[None</span> <span class="pre">|</span> <span class="pre">Literal['model_post_init']]",</span> <span class="pre">'__pydantic_private__':</span> <span class="pre">'dict[str,</span> <span class="pre">Any]</span> <span class="pre">|</span> <span class="pre">None',</span> <span class="pre">'__pydantic_root_model__':</span> <span class="pre">'ClassVar[bool]',</span> <span class="pre">'__pydantic_serializer__':</span> <span class="pre">'ClassVar[SchemaSerializer]',</span> <span class="pre">'__pydantic_validator__':</span> <span class="pre">'ClassVar[SchemaValidator</span> <span class="pre">|</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.OptionGltf.__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.OptionGltf.__class_getitem__">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">__class_getitem__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">typevar_values</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionGltf.__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.OptionGltf.html#kittycad.models.input_format.OptionGltf.type" title="kittycad.models.input_format.OptionGltf.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.OptionGltf.__class_vars__">
|
||
<span class="sig-name descname"><span class="pre">__class_vars__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[set[str]]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionGltf.__class_vars__" title="Link to this definition"></a></dt>
|
||
<dd><p>The names of the class variables defined on the model.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionGltf.__copy__">
|
||
<span class="sig-name descname"><span class="pre">__copy__</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionGltf.__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>
|
||
<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.OptionGltf.__deepcopy__">
|
||
<span class="sig-name descname"><span class="pre">__deepcopy__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">memo</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionGltf.__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>
|
||
<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.OptionGltf.__delattr__">
|
||
<span class="sig-name descname"><span class="pre">__delattr__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">item</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionGltf.__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>
|
||
<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.OptionGltf.__dict__">
|
||
<span class="sig-name descname"><span class="pre">__dict__</span></span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionGltf.__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.OptionGltf.__eq__">
|
||
<span class="sig-name descname"><span class="pre">__eq__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">other</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionGltf.__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>
|
||
<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.OptionGltf.__fields_set__">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">__fields_set__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#set" title="(in Python v3.12)"><span class="pre">set</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionGltf.__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.OptionGltf.__get_pydantic_core_schema__">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">__get_pydantic_core_schema__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">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.OptionGltf.__get_pydantic_core_schema__" title="Link to this definition"></a></dt>
|
||
<dd><p>Hook into generating the model’s CoreSchema.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>source</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference internal" href="kittycad.models.input_format.OptionGltf.html#kittycad.models.input_format.OptionGltf.type" title="kittycad.models.input_format.OptionGltf.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 Pydantic’s internal CoreSchema generation logic.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><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 class="xref py py-class docutils literal notranslate"><span class="pre">ModelFieldsSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">ModelSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">DataclassArgsSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">DataclassSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">ArgumentsSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">CallSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">CustomErrorSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">JsonSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">UrlSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">MultiHostUrlSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">DefinitionsSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">DefinitionReferenceSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">UuidSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">ComplexSchema</span></code>]</span></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<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.OptionGltf.__get_pydantic_json_schema__">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">__get_pydantic_json_schema__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">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.OptionGltf.__get_pydantic_json_schema__" title="Link to this definition"></a></dt>
|
||
<dd><p>Hook into generating the model’s JSON schema.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>core_schema</strong> (<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 class="xref py py-class docutils literal notranslate"><span class="pre">ModelFieldsSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">ModelSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">DataclassArgsSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">DataclassSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">ArgumentsSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">CallSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">CustomErrorSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">JsonSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">UrlSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">MultiHostUrlSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">DefinitionsSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">DefinitionReferenceSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">UuidSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">ComplexSchema</span></code>]</span>) – A <code class="xref any docutils literal notranslate"><span class="pre">pydantic-core</span></code> CoreSchema.
|
||
You can ignore this argument and call the handler with a new CoreSchema,
|
||
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>
|
||
<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 Pydantic’s 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.
|
||
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>
|
||
<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.OptionGltf.__getattr__">
|
||
<span class="sig-name descname"><span class="pre">__getattr__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">item</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionGltf.__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>
|
||
<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.OptionGltf.__getstate__">
|
||
<span class="sig-name descname"><span class="pre">__getstate__</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionGltf.__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>
|
||
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><a class="reference internal" href="kittycad.models.input_format.OptionGltf.html#kittycad.models.input_format.OptionGltf.dict" title="kittycad.models.input_format.OptionGltf.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.OptionGltf.__hash__">
|
||
<span class="sig-name descname"><span class="pre">__hash__</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionGltf.__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.OptionGltf.__init__">
|
||
<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">data</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionGltf.__init__" title="Link to this definition"></a></dt>
|
||
<dd><p>Create a new model by parsing and validating input data from keyword arguments.</p>
|
||
<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>
|
||
<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.OptionGltf.__iter__">
|
||
<span class="sig-name descname"><span class="pre">__iter__</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionGltf.__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>
|
||
<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.OptionGltf.__module__">
|
||
<span class="sig-name descname"><span class="pre">__module__</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'kittycad.models.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.OptionGltf.__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.OptionGltf.__pretty__">
|
||
<span class="sig-name descname"><span class="pre">__pretty__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">fmt</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionGltf.__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>
|
||
<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.OptionGltf.__private_attributes__">
|
||
<span class="sig-name descname"><span class="pre">__private_attributes__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[Dict[str,</span> <span class="pre">ModelPrivateAttr]]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionGltf.__private_attributes__" title="Link to this definition"></a></dt>
|
||
<dd><p>Metadata about the private attributes of the model.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionGltf.__pydantic_complete__">
|
||
<span class="sig-name descname"><span class="pre">__pydantic_complete__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[bool]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">True</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionGltf.__pydantic_complete__" title="Link to this definition"></a></dt>
|
||
<dd><p>Whether model building is completed, or if there are still undefined fields.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionGltf.__pydantic_core_schema__">
|
||
<span class="sig-name descname"><span class="pre">__pydantic_core_schema__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[CoreSchema]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'cls':</span> <span class="pre"><class</span> <span class="pre">'kittycad.models.input_format.OptionGltf'>,</span> <span class="pre">'config':</span> <span class="pre">{'title':</span> <span class="pre">'OptionGltf'},</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(<function</span> <span class="pre">modify_model_json_schema>,</span> <span class="pre">cls=<class</span> <span class="pre">'kittycad.models.input_format.OptionGltf'>,</span> <span class="pre">title=None),</span> <span class="pre"><bound</span> <span class="pre">method</span> <span class="pre">BaseModel.__get_pydantic_json_schema__</span> <span class="pre">of</span> <span class="pre"><class</span> <span class="pre">'kittycad.models.input_format.OptionGltf'>>]},</span> <span class="pre">'ref':</span> <span class="pre">'kittycad.models.input_format.OptionGltf:94740974312240',</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">[<function</span> <span class="pre">get_json_schema_update_func.<locals>.json_schema_update_func>],</span> <span class="pre">'pydantic_js_functions':</span> <span class="pre">[]},</span> <span class="pre">'schema':</span> <span class="pre">{'default':</span> <span class="pre">'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">'OptionGltf',</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.OptionGltf.__pydantic_core_schema__" title="Link to this definition"></a></dt>
|
||
<dd><p>The core schema of the model.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionGltf.__pydantic_custom_init__">
|
||
<span class="sig-name descname"><span class="pre">__pydantic_custom_init__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[bool]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">False</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionGltf.__pydantic_custom_init__" title="Link to this definition"></a></dt>
|
||
<dd><p>Whether the model has a custom <a class="reference internal" href="kittycad.models.input_format.OptionGltf.html#id0" title="kittycad.models.input_format.OptionGltf.__init__"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">__init__</span></code></a> method.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionGltf.__pydantic_decorators__">
|
||
<span class="sig-name descname"><span class="pre">__pydantic_decorators__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[_decorators.DecoratorInfos]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">DecoratorInfos(validators={},</span> <span class="pre">field_validators={},</span> <span class="pre">root_validators={},</span> <span class="pre">field_serializers={},</span> <span class="pre">model_serializers={},</span> <span class="pre">model_validators={},</span> <span class="pre">computed_fields={})</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionGltf.__pydantic_decorators__" title="Link to this definition"></a></dt>
|
||
<dd><p>Metadata containing the decorators defined on the model.
|
||
This replaces <code class="xref any docutils literal notranslate"><span class="pre">Model.__validators__</span></code> and <code class="xref any docutils literal notranslate"><span class="pre">Model.__root_validators__</span></code> from Pydantic V1.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionGltf.__pydantic_extra__">
|
||
<span class="sig-name descname"><span class="pre">__pydantic_extra__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">dict[str,</span> <span class="pre">Any]</span> <span class="pre">|</span> <span class="pre">None</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionGltf.__pydantic_extra__" title="Link to this definition"></a></dt>
|
||
<dd><p>A dictionary containing extra values, if [<a class="reference internal" href="kittycad.models.kcl_code_completion_request.KclCodeCompletionRequest.html#kittycad.models.kcl_code_completion_request.KclCodeCompletionRequest.extra" title="kittycad.models.kcl_code_completion_request.KclCodeCompletionRequest.extra"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">extra</span></code></a>][pydantic.config.ConfigDict.extra] is set to <code class="xref any docutils literal notranslate"><span class="pre">'allow'</span></code>.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionGltf.__pydantic_fields_set__">
|
||
<span class="sig-name descname"><span class="pre">__pydantic_fields_set__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">set[str]</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionGltf.__pydantic_fields_set__" title="Link to this definition"></a></dt>
|
||
<dd><p>The names of fields explicitly set during instantiation.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionGltf.__pydantic_generic_metadata__">
|
||
<span class="sig-name descname"><span class="pre">__pydantic_generic_metadata__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[_generics.PydanticGenericMetadata]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'args':</span> <span class="pre">(),</span> <span class="pre">'origin':</span> <span class="pre">None,</span> <span class="pre">'parameters':</span> <span class="pre">()}</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionGltf.__pydantic_generic_metadata__" title="Link to this definition"></a></dt>
|
||
<dd><p>Metadata for generic models; contains data used for a similar purpose to
|
||
__args__, __origin__, __parameters__ in typing-module generics. May eventually be replaced by these.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionGltf.__pydantic_init_subclass__">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">__pydantic_init_subclass__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionGltf.__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.OptionGltf.html#kittycad.models.input_format.OptionGltf.model_fields" title="kittycad.models.input_format.OptionGltf.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>
|
||
<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 aren’t used internally by pydantic.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>**kwargs</strong> (<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 aren’t used internally
|
||
by pydantic.</p>
|
||
</dd>
|
||
<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/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.OptionGltf.__pydantic_parent_namespace__">
|
||
<span class="sig-name descname"><span class="pre">__pydantic_parent_namespace__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[Dict[str,</span> <span class="pre">Any]</span> <span class="pre">|</span> <span class="pre">None]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">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.OptionGltf.__pydantic_parent_namespace__" title="Link to this definition"></a></dt>
|
||
<dd><p>Parent namespace of the model, used for automatic rebuilding of models.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionGltf.__pydantic_post_init__">
|
||
<span class="sig-name descname"><span class="pre">__pydantic_post_init__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[None</span> <span class="pre">|</span> <span class="pre">Literal['model_post_init']]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionGltf.__pydantic_post_init__" title="Link to this definition"></a></dt>
|
||
<dd><p>The name of the post-init method for the model, if defined.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionGltf.__pydantic_private__">
|
||
<span class="sig-name descname"><span class="pre">__pydantic_private__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">dict[str,</span> <span class="pre">Any]</span> <span class="pre">|</span> <span class="pre">None</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionGltf.__pydantic_private__" title="Link to this definition"></a></dt>
|
||
<dd><p>Values of private attributes set on the model instance.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionGltf.__pydantic_root_model__">
|
||
<span class="sig-name descname"><span class="pre">__pydantic_root_model__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[bool]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">False</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionGltf.__pydantic_root_model__" title="Link to this definition"></a></dt>
|
||
<dd><p>Whether the model is a [<code class="xref any docutils literal notranslate"><span class="pre">RootModel</span></code>][pydantic.root_model.RootModel].</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionGltf.__pydantic_serializer__">
|
||
<span class="sig-name descname"><span class="pre">__pydantic_serializer__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[SchemaSerializer]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">SchemaSerializer(serializer=Model(</span>     <span class="pre">ModelSerializer</span> <span class="pre">{</span>         <span class="pre">class:</span> <span class="pre">Py(</span>             <span class="pre">0x0000562a9a1e9b30,</span>         <span class="pre">),</span>         <span class="pre">serializer:</span> <span class="pre">Fields(</span>             <span class="pre">GeneralFieldsSerializer</span> <span class="pre">{</span>                 <span class="pre">fields:</span> <span class="pre">{</span>                     <span class="pre">"type":</span> <span class="pre">SerField</span> <span class="pre">{</span>                         <span class="pre">key_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007f936f623938,</span>                         <span class="pre">),</span>                         <span class="pre">alias:</span> <span class="pre">None,</span>                         <span class="pre">alias_py:</span> <span class="pre">None,</span>                         <span class="pre">serializer:</span> <span class="pre">Some(</span>                             <span class="pre">WithDefault(</span>                                 <span class="pre">WithDefaultSerializer</span> <span class="pre">{</span>                                     <span class="pre">default:</span> <span class="pre">Default(</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007f936b879a10,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                     <span class="pre">serializer:</span> <span class="pre">Literal(</span>                                         <span class="pre">LiteralSerializer</span> <span class="pre">{</span>                                             <span class="pre">expected_int:</span> <span class="pre">{},</span>                                             <span class="pre">expected_str:</span> <span class="pre">{</span>                                                 <span class="pre">"gltf",</span>                                             <span class="pre">},</span>                                             <span class="pre">expected_py:</span> <span class="pre">None,</span>                                             <span class="pre">name:</span> <span class="pre">"literal['gltf']",</span>                                         <span class="pre">},</span>                                     <span class="pre">),</span>                                 <span class="pre">},</span>                             <span class="pre">),</span>                         <span class="pre">),</span>                         <span class="pre">required:</span> <span class="pre">true,</span>                     <span class="pre">},</span>                 <span class="pre">},</span>                 <span class="pre">computed_fields:</span> <span class="pre">Some(</span>                     <span class="pre">ComputedFields(</span>                         <span class="pre">[],</span>                     <span class="pre">),</span>                 <span class="pre">),</span>                 <span class="pre">mode:</span> <span class="pre">SimpleDict,</span>                 <span class="pre">extra_serializer:</span> <span class="pre">None,</span>                 <span class="pre">filter:</span> <span class="pre">SchemaFilter</span> <span class="pre">{</span>                     <span class="pre">include:</span> <span class="pre">None,</span>                     <span class="pre">exclude:</span> <span class="pre">None,</span>                 <span class="pre">},</span>                 <span class="pre">required_fields:</span> <span class="pre">1,</span>             <span class="pre">},</span>         <span class="pre">),</span>         <span class="pre">has_extra:</span> <span class="pre">false,</span>         <span class="pre">root_model:</span> <span class="pre">false,</span>         <span class="pre">name:</span> <span class="pre">"OptionGltf",</span>     <span class="pre">},</span> <span class="pre">),</span> <span class="pre">definitions=[])</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.OptionGltf.__pydantic_serializer__" title="Link to this definition"></a></dt>
|
||
<dd><p>The <code class="xref any docutils literal notranslate"><span class="pre">pydantic-core</span></code> <code class="xref any docutils literal notranslate"><span class="pre">SchemaSerializer</span></code> used to dump instances of the model.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionGltf.__pydantic_validator__">
|
||
<span class="sig-name descname"><span class="pre">__pydantic_validator__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[SchemaValidator</span> <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="OptionGltf",</span> <span class="pre">validator=Model(</span>     <span class="pre">ModelValidator</span> <span class="pre">{</span>         <span class="pre">revalidate:</span> <span class="pre">Never,</span>         <span class="pre">validator:</span> <span class="pre">ModelFields(</span>             <span class="pre">ModelFieldsValidator</span> <span class="pre">{</span>                 <span class="pre">fields:</span> <span class="pre">[</span>                     <span class="pre">Field</span> <span class="pre">{</span>                         <span class="pre">name:</span> <span class="pre">"type",</span>                         <span class="pre">lookup_key:</span> <span class="pre">Simple</span> <span class="pre">{</span>                             <span class="pre">key:</span> <span class="pre">"type",</span>                             <span class="pre">py_key:</span> <span class="pre">Py(</span>                                 <span class="pre">0x00007f936b8793e0,</span>                             <span class="pre">),</span>                             <span class="pre">path:</span> <span class="pre">LookupPath(</span>                                 <span class="pre">[</span>                                     <span class="pre">S(</span>                                         <span class="pre">"type",</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007f936b8795f0,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                 <span class="pre">],</span>                             <span class="pre">),</span>                         <span class="pre">},</span>                         <span class="pre">name_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007f936f623938,</span>                         <span class="pre">),</span>                         <span class="pre">validator:</span> <span class="pre">WithDefault(</span>                             <span class="pre">WithDefaultValidator</span> <span class="pre">{</span>                                 <span class="pre">default:</span> <span class="pre">Default(</span>                                     <span class="pre">Py(</span>                                         <span class="pre">0x00007f936b879a10,</span>                                     <span class="pre">),</span>                                 <span class="pre">),</span>                                 <span class="pre">on_error:</span> <span class="pre">Raise,</span>                                 <span class="pre">validator:</span> <span class="pre">Literal(</span>                                     <span class="pre">LiteralValidator</span> <span class="pre">{</span>                                         <span class="pre">lookup:</span> <span class="pre">LiteralLookup</span> <span class="pre">{</span>                                             <span class="pre">expected_bool:</span> <span class="pre">None,</span>                                             <span class="pre">expected_int:</span> <span class="pre">None,</span>                                             <span class="pre">expected_str:</span> <span class="pre">Some(</span>                                                 <span class="pre">{</span>                                                     <span class="pre">"gltf":</span> <span class="pre">0,</span>                                                 <span class="pre">},</span>                                             <span class="pre">),</span>                                             <span class="pre">expected_py_dict:</span> <span class="pre">None,</span>                                             <span class="pre">expected_py_values:</span> <span class="pre">None,</span>                                             <span class="pre">values:</span> <span class="pre">[</span>                                                 <span class="pre">Py(</span>                                                     <span class="pre">0x00007f936b879a10,</span>                                                 <span class="pre">),</span>                                             <span class="pre">],</span>                                         <span class="pre">},</span>                                         <span class="pre">expected_repr:</span> <span class="pre">"'gltf'",</span>                                         <span class="pre">name:</span> <span class="pre">"literal['gltf']",</span>                                     <span class="pre">},</span>                                 <span class="pre">),</span>                                 <span class="pre">validate_default:</span> <span class="pre">false,</span>                                 <span class="pre">copy_default:</span> <span class="pre">false,</span>                                 <span class="pre">name:</span> <span class="pre">"default[literal['gltf']]",</span>                                 <span class="pre">undefined:</span> <span class="pre">Py(</span>                                     <span class="pre">0x00007f936d406320,</span>                                 <span class="pre">),</span>                             <span class="pre">},</span>                         <span class="pre">),</span>                         <span class="pre">frozen:</span> <span class="pre">false,</span>                     <span class="pre">},</span>                 <span class="pre">],</span>                 <span class="pre">model_name:</span> <span class="pre">"OptionGltf",</span>                 <span class="pre">extra_behavior:</span> <span class="pre">Ignore,</span>                 <span class="pre">extras_validator:</span> <span class="pre">None,</span>                 <span class="pre">strict:</span> <span class="pre">false,</span>                 <span class="pre">from_attributes:</span> <span class="pre">false,</span>                 <span class="pre">loc_by_alias:</span> <span class="pre">true,</span>             <span class="pre">},</span>         <span class="pre">),</span>         <span class="pre">class:</span> <span class="pre">Py(</span>             <span class="pre">0x0000562a9a1e9b30,</span>         <span class="pre">),</span>         <span class="pre">post_init:</span> <span class="pre">None,</span>         <span class="pre">frozen:</span> <span class="pre">false,</span>         <span class="pre">custom_init:</span> <span class="pre">false,</span>         <span class="pre">root_model:</span> <span class="pre">false,</span>         <span class="pre">undefined:</span> <span class="pre">Py(</span>             <span class="pre">0x00007f936d406320,</span>         <span class="pre">),</span>         <span class="pre">name:</span> <span class="pre">"OptionGltf",</span>     <span class="pre">},</span> <span class="pre">),</span> <span class="pre">definitions=[],</span> <span class="pre">cache_strings=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.OptionGltf.__pydantic_validator__" title="Link to this definition"></a></dt>
|
||
<dd><p>The <code class="xref any docutils literal notranslate"><span class="pre">pydantic-core</span></code> <code class="xref any docutils literal notranslate"><span class="pre">SchemaValidator</span></code> used to validate instances of the model.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionGltf.__repr__">
|
||
<span class="sig-name descname"><span class="pre">__repr__</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionGltf.__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>
|
||
<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.OptionGltf.__repr_args__">
|
||
<span class="sig-name descname"><span class="pre">__repr_args__</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionGltf.__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/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/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/typing.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.OptionGltf.__repr_name__">
|
||
<span class="sig-name descname"><span class="pre">__repr_name__</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionGltf.__repr_name__" title="Link to this definition"></a></dt>
|
||
<dd><p>Name of the instance’s class, used in __repr__.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><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.OptionGltf.__repr_str__">
|
||
<span class="sig-name descname"><span class="pre">__repr_str__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">join_str</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionGltf.__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>
|
||
<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.OptionGltf.__rich_repr__">
|
||
<span class="sig-name descname"><span class="pre">__rich_repr__</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionGltf.__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>
|
||
<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.OptionGltf.__setattr__">
|
||
<span class="sig-name descname"><span class="pre">__setattr__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionGltf.__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>
|
||
<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.OptionGltf.__setstate__">
|
||
<span class="sig-name descname"><span class="pre">__setstate__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">state</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionGltf.__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>
|
||
<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.OptionGltf.__signature__">
|
||
<span class="sig-name descname"><span class="pre">__signature__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[Signature]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre"><Signature</span> <span class="pre">(*,</span> <span class="pre">type:</span> <span class="pre">Literal['gltf']</span> <span class="pre">=</span> <span class="pre">'gltf')</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.OptionGltf.__signature__" title="Link to this definition"></a></dt>
|
||
<dd><p>The synthesized <a class="reference internal" href="kittycad.models.input_format.OptionGltf.html#id0" title="kittycad.models.input_format.OptionGltf.__init__"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">__init__</span></code></a> [<code class="xref any docutils literal notranslate"><span class="pre">Signature</span></code>][inspect.Signature] of the model.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionGltf.__slots__">
|
||
<span class="sig-name descname"><span class="pre">__slots__</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">('__dict__',</span> <span class="pre">'__pydantic_fields_set__',</span> <span class="pre">'__pydantic_extra__',</span> <span class="pre">'__pydantic_private__')</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionGltf.__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.OptionGltf.__str__">
|
||
<span class="sig-name descname"><span class="pre">__str__</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionGltf.__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>
|
||
<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.OptionGltf._abc_impl">
|
||
<span class="sig-name descname"><span class="pre">_abc_impl</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre"><_abc._abc_data</span> <span class="pre">object></span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionGltf._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.OptionGltf._calculate_keys">
|
||
<span class="sig-name descname"><span class="pre">_calculate_keys</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionGltf._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>
|
||
<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.OptionGltf._check_frozen">
|
||
<span class="sig-name descname"><span class="pre">_check_frozen</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionGltf._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>
|
||
<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.OptionGltf._copy_and_set_values">
|
||
<span class="sig-name descname"><span class="pre">_copy_and_set_values</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionGltf._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>
|
||
<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.OptionGltf._get_value">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">_get_value</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="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.OptionGltf._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>
|
||
<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.OptionGltf._iter">
|
||
<span class="sig-name descname"><span class="pre">_iter</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionGltf._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>
|
||
<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.OptionGltf.construct">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">construct</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_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.OptionGltf.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>
|
||
<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.OptionGltf.copy">
|
||
<span class="sig-name descname"><span class="pre">copy</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">include</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exclude</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">update</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">deep</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionGltf.copy" title="Link to this definition"></a></dt>
|
||
<dd><p>Returns a copy of the model.</p>
|
||
<dl class="simple">
|
||
<dt>!!! warning “Deprecated”</dt><dd><p>This method is now deprecated; use <a class="reference internal" href="kittycad.models.input_format.OptionGltf.html#kittycad.models.input_format.OptionGltf.model_copy" title="kittycad.models.input_format.OptionGltf.model_copy"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">model_copy</span></code></a> instead.</p>
|
||
</dd>
|
||
</dl>
|
||
<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">
|
||
<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>
|
||
<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.OptionGltf.dict">
|
||
<span class="sig-name descname"><span class="pre">dict</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">include</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exclude</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">by_alias</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exclude_unset</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exclude_defaults</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exclude_none</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionGltf.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>
|
||
<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.OptionGltf.from_orm">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_orm</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">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.OptionGltf.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>
|
||
<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.OptionGltf.json">
|
||
<span class="sig-name descname"><span class="pre">json</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">include</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exclude</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">by_alias</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exclude_unset</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exclude_defaults</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exclude_none</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">encoder</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">PydanticUndefined</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">models_as_dict</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">PydanticUndefined</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">dumps_kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionGltf.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>
|
||
<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.OptionGltf.model_computed_fields">
|
||
<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.OptionGltf.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.OptionGltf.model_config">
|
||
<span class="sig-name descname"><span class="pre">model_config</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[ConfigDict]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'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.OptionGltf.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.OptionGltf.model_construct">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">model_construct</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_fields_set</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">values</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionGltf.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.OptionGltf.html#kittycad.models.input_format.OptionGltf.__dict__" title="kittycad.models.input_format.OptionGltf.__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.OptionGltf.html#kittycad.models.input_format.OptionGltf.__pydantic_fields_set__" title="kittycad.models.input_format.OptionGltf.__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.OptionGltf.html#kittycad.models.input_format.OptionGltf.model_construct" title="kittycad.models.input_format.OptionGltf.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 instance’s <a class="reference internal" href="kittycad.models.input_format.OptionGltf.html#kittycad.models.input_format.OptionGltf.__dict__" title="kittycad.models.input_format.OptionGltf.__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.OptionGltf.html#kittycad.models.input_format.OptionGltf.__pydantic_extra__" title="kittycad.models.input_format.OptionGltf.__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.OptionGltf.html#kittycad.models.input_format.OptionGltf.model_construct" title="kittycad.models.input_format.OptionGltf.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">
|
||
<li><p><strong>_fields_set</strong> (<span class="sphinx_autodoc_typehints-type"><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>] | <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 field names that were originally explicitly set during instantiation. If provided,
|
||
this is directly used for the [<a class="reference internal" href="kittycad.models.input_format.OptionGltf.html#kittycad.models.input_format.OptionGltf.model_fields_set" title="kittycad.models.input_format.OptionGltf.model_fields_set"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">model_fields_set</span></code></a>][pydantic.BaseModel.model_fields_set] attribute.
|
||
Otherwise, the field names from the <code class="xref any docutils literal notranslate"><span class="pre">values</span></code> argument will be used.</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>
|
||
<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>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.OptionGltf.model_copy">
|
||
<span class="sig-name descname"><span class="pre">model_copy</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">update</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">deep</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionGltf.model_copy" title="Link to this definition"></a></dt>
|
||
<dd><p>Usage docs: <a class="reference external" href="https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy">https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy</a></p>
|
||
<p>Returns a copy of the model.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>update</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference internal" href="kittycad.models.input_format.OptionGltf.html#kittycad.models.input_format.OptionGltf.dict" title="kittycad.models.input_format.OptionGltf.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>] | <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>) – Values to change/add in the new model. Note: the data is not validated
|
||
before creating the new model. You should trust this data.</p></li>
|
||
<li><p><strong>deep</strong> (<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>
|
||
<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.OptionGltf.model_dump">
|
||
<span class="sig-name descname"><span class="pre">model_dump</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mode</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'python'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">include</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exclude</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">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.OptionGltf.model_dump" title="Link to this definition"></a></dt>
|
||
<dd><p>Usage docs: <a class="reference external" href="https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump">https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump</a></p>
|
||
<p>Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>mode</strong> (<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.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.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.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[IncEx, <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">True</span></code>]]], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[IncEx, <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">True</span></code>]]], <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">True</span></code>]]], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.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.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[IncEx, <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">True</span></code>]]], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[IncEx, <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">True</span></code>]]], <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">True</span></code>]]], <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.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.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.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[IncEx, <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">True</span></code>]]], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[IncEx, <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">True</span></code>]]], <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">True</span></code>]]], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.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.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[IncEx, <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">True</span></code>]]], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[IncEx, <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">True</span></code>]]], <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">True</span></code>]]], <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.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>) – 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 field’s 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>
|
||
<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.OptionGltf.html#kittycad.models.input_format.OptionGltf.dict" title="kittycad.models.input_format.OptionGltf.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.OptionGltf.model_dump_json">
|
||
<span class="sig-name descname"><span class="pre">model_dump_json</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">indent</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">include</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exclude</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">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.OptionGltf.model_dump_json" title="Link to this definition"></a></dt>
|
||
<dd><p>Usage docs: <a class="reference external" href="https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json">https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json</a></p>
|
||
<p>Generates a JSON representation of the model using Pydantic’s <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">
|
||
<li><p><strong>indent</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> | <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>) – 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.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.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.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[IncEx, <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">True</span></code>]]], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[IncEx, <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">True</span></code>]]], <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">True</span></code>]]], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.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.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[IncEx, <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">True</span></code>]]], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[IncEx, <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">True</span></code>]]], <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">True</span></code>]]], <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.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.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.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[IncEx, <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">True</span></code>]]], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[IncEx, <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">True</span></code>]]], <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">True</span></code>]]], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.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.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[IncEx, <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">True</span></code>]]], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[IncEx, <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">True</span></code>]]], <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">True</span></code>]]], <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.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>) – 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>
|
||
<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.OptionGltf.model_extra">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">model_extra</span></span><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.OptionGltf.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>
|
||
<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">"allow"</span></code>.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionGltf.model_fields">
|
||
<span class="sig-name descname"><span class="pre">model_fields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[Dict[str,</span> <span class="pre">FieldInfo]]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'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.OptionGltf.model_fields" title="Link to this definition"></a></dt>
|
||
<dd><p>Metadata about the fields defined on the model,
|
||
mapping of field names to [<code class="xref any docutils literal notranslate"><span class="pre">FieldInfo</span></code>][pydantic.fields.FieldInfo] objects.</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.OptionGltf.model_fields_set">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">model_fields_set</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#set" title="(in Python v3.12)"><span class="pre">set</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionGltf.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.OptionGltf.model_json_schema">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">model_json_schema</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">by_alias=True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ref_template='#/$defs/{model}'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">schema_generator=<class</span> <span class="pre">'pydantic.json_schema.GenerateJsonSchema'></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mode='validation'</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionGltf.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">
|
||
<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.OptionGltf.html#kittycad.models.input_format.OptionGltf.type" title="kittycad.models.input_format.OptionGltf.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>
|
||
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><a class="reference internal" href="kittycad.models.input_format.OptionGltf.html#kittycad.models.input_format.OptionGltf.dict" title="kittycad.models.input_format.OptionGltf.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.OptionGltf.model_parametrized_name">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">model_parametrized_name</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">params</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionGltf.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>
|
||
<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.OptionGltf.html#kittycad.models.input_format.OptionGltf.type" title="kittycad.models.input_format.OptionGltf.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>
|
||
<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>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.OptionGltf.model_post_init">
|
||
<span class="sig-name descname"><span class="pre">model_post_init</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_BaseModel__context</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionGltf.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.OptionGltf.html#id0" title="kittycad.models.input_format.OptionGltf.__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.OptionGltf.html#kittycad.models.input_format.OptionGltf.model_construct" title="kittycad.models.input_format.OptionGltf.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>
|
||
<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.OptionGltf.model_rebuild">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">model_rebuild</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">force</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">raise_errors</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_parent_namespace_depth</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">2</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_types_namespace</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionGltf.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">
|
||
<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 internal" href="kittycad.models.input_format.OptionGltf.html#kittycad.models.input_format.OptionGltf.dict" title="kittycad.models.input_format.OptionGltf.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>] | <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>) – 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>
|
||
<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/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/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>
|
||
<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.OptionGltf.model_validate">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">model_validate</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">obj</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">strict</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">from_attributes</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">context</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionGltf.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">
|
||
<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/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/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>) – 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/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/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>) – 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.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>) – Additional context to pass to the validator.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><strong>ValidationError</strong> – If the object could not be validated.</p>
|
||
</dd>
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><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.OptionGltf.model_validate_json">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">model_validate_json</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">json_data</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">strict</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">context</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionGltf.model_validate_json" title="Link to this definition"></a></dt>
|
||
<dd><p>Usage docs: <a class="reference external" href="https://docs.pydantic.dev/2.9/concepts/json/#json-parsing">https://docs.pydantic.dev/2.9/concepts/json/#json-parsing</a></p>
|
||
<p>Validate the given JSON data against the Pydantic model.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>json_data</strong> (<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/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/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>) – 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.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>) – Extra variables to pass to the validator.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><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>
|
||
<dd class="field-even"><p><strong>ValidationError</strong> – If <code class="xref any docutils literal notranslate"><span class="pre">json_data</span></code> is not a JSON string or the object could not be validated.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionGltf.model_validate_strings">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">model_validate_strings</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">obj</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">strict</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">context</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionGltf.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">
|
||
<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/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/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>) – 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.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>) – Extra variables to pass to the validator.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><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.OptionGltf.parse_file">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">parse_file</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">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.OptionGltf.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>
|
||
<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.OptionGltf.parse_obj">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">parse_obj</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">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.OptionGltf.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>
|
||
<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.OptionGltf.parse_raw">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">parse_raw</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">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.OptionGltf.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>
|
||
<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.OptionGltf.schema">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">schema</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">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.OptionGltf.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>
|
||
<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.OptionGltf.schema_json">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">schema_json</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="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.OptionGltf.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>
|
||
<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.OptionGltf.type">
|
||
<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.OptionGltf.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.OptionGltf.update_forward_refs">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">update_forward_refs</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="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.OptionGltf.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>
|
||
<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.OptionGltf.validate">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">validate</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">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.OptionGltf.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>
|
||
<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.OptionObj">
|
||
<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">OptionObj</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#OptionObj"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionObj" 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>
|
||
<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>
|
||
<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.OptionObj.__abstractmethods__">
|
||
<span class="sig-name descname"><span class="pre">__abstractmethods__</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">frozenset({})</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionObj.__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.OptionObj.__annotations__">
|
||
<span class="sig-name descname"><span class="pre">__annotations__</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'__class_vars__':</span> <span class="pre">'ClassVar[set[str]]',</span> <span class="pre">'__private_attributes__':</span> <span class="pre">'ClassVar[Dict[str,</span> <span class="pre">ModelPrivateAttr]]',</span> <span class="pre">'__pydantic_complete__':</span> <span class="pre">'ClassVar[bool]',</span> <span class="pre">'__pydantic_core_schema__':</span> <span class="pre">'ClassVar[CoreSchema]',</span> <span class="pre">'__pydantic_custom_init__':</span> <span class="pre">'ClassVar[bool]',</span> <span class="pre">'__pydantic_decorators__':</span> <span class="pre">'ClassVar[_decorators.DecoratorInfos]',</span> <span class="pre">'__pydantic_extra__':</span> <span class="pre">'dict[str,</span> <span class="pre">Any]</span> <span class="pre">|</span> <span class="pre">None',</span> <span class="pre">'__pydantic_fields_set__':</span> <span class="pre">'set[str]',</span> <span class="pre">'__pydantic_generic_metadata__':</span> <span class="pre">'ClassVar[_generics.PydanticGenericMetadata]',</span> <span class="pre">'__pydantic_parent_namespace__':</span> <span class="pre">'ClassVar[Dict[str,</span> <span class="pre">Any]</span> <span class="pre">|</span> <span class="pre">None]',</span> <span class="pre">'__pydantic_post_init__':</span> <span class="pre">"ClassVar[None</span> <span class="pre">|</span> <span class="pre">Literal['model_post_init']]",</span> <span class="pre">'__pydantic_private__':</span> <span class="pre">'dict[str,</span> <span class="pre">Any]</span> <span class="pre">|</span> <span class="pre">None',</span> <span class="pre">'__pydantic_root_model__':</span> <span class="pre">'ClassVar[bool]',</span> <span class="pre">'__pydantic_serializer__':</span> <span class="pre">'ClassVar[SchemaSerializer]',</span> <span class="pre">'__pydantic_validator__':</span> <span class="pre">'ClassVar[SchemaValidator</span> <span class="pre">|</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"><class</span> <span class="pre">'kittycad.models.system.System'>,</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"><enum</span> <span class="pre">'UnitLength'>}</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.OptionObj.__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.OptionObj.__class_getitem__">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">__class_getitem__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">typevar_values</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionObj.__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.OptionObj.html#kittycad.models.input_format.OptionObj.type" title="kittycad.models.input_format.OptionObj.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.OptionObj.__class_vars__">
|
||
<span class="sig-name descname"><span class="pre">__class_vars__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[set[str]]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionObj.__class_vars__" title="Link to this definition"></a></dt>
|
||
<dd><p>The names of the class variables defined on the model.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionObj.__copy__">
|
||
<span class="sig-name descname"><span class="pre">__copy__</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionObj.__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>
|
||
<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.OptionObj.__deepcopy__">
|
||
<span class="sig-name descname"><span class="pre">__deepcopy__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">memo</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionObj.__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>
|
||
<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.OptionObj.__delattr__">
|
||
<span class="sig-name descname"><span class="pre">__delattr__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">item</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionObj.__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>
|
||
<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.OptionObj.__dict__">
|
||
<span class="sig-name descname"><span class="pre">__dict__</span></span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionObj.__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.OptionObj.__eq__">
|
||
<span class="sig-name descname"><span class="pre">__eq__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">other</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionObj.__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>
|
||
<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.OptionObj.__fields_set__">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">__fields_set__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#set" title="(in Python v3.12)"><span class="pre">set</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionObj.__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.OptionObj.__get_pydantic_core_schema__">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">__get_pydantic_core_schema__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">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.OptionObj.__get_pydantic_core_schema__" title="Link to this definition"></a></dt>
|
||
<dd><p>Hook into generating the model’s CoreSchema.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>source</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference internal" href="kittycad.models.input_format.OptionObj.html#kittycad.models.input_format.OptionObj.type" title="kittycad.models.input_format.OptionObj.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 Pydantic’s internal CoreSchema generation logic.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><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 class="xref py py-class docutils literal notranslate"><span class="pre">ModelFieldsSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">ModelSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">DataclassArgsSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">DataclassSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">ArgumentsSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">CallSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">CustomErrorSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">JsonSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">UrlSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">MultiHostUrlSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">DefinitionsSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">DefinitionReferenceSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">UuidSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">ComplexSchema</span></code>]</span></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<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.OptionObj.__get_pydantic_json_schema__">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">__get_pydantic_json_schema__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">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.OptionObj.__get_pydantic_json_schema__" title="Link to this definition"></a></dt>
|
||
<dd><p>Hook into generating the model’s JSON schema.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>core_schema</strong> (<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 class="xref py py-class docutils literal notranslate"><span class="pre">ModelFieldsSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">ModelSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">DataclassArgsSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">DataclassSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">ArgumentsSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">CallSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">CustomErrorSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">JsonSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">UrlSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">MultiHostUrlSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">DefinitionsSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">DefinitionReferenceSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">UuidSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">ComplexSchema</span></code>]</span>) – A <code class="xref any docutils literal notranslate"><span class="pre">pydantic-core</span></code> CoreSchema.
|
||
You can ignore this argument and call the handler with a new CoreSchema,
|
||
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>
|
||
<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 Pydantic’s 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.
|
||
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>
|
||
<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.OptionObj.__getattr__">
|
||
<span class="sig-name descname"><span class="pre">__getattr__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">item</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionObj.__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>
|
||
<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.OptionObj.__getstate__">
|
||
<span class="sig-name descname"><span class="pre">__getstate__</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionObj.__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>
|
||
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><a class="reference internal" href="kittycad.models.input_format.OptionObj.html#kittycad.models.input_format.OptionObj.dict" title="kittycad.models.input_format.OptionObj.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.OptionObj.__hash__">
|
||
<span class="sig-name descname"><span class="pre">__hash__</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionObj.__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.OptionObj.__init__">
|
||
<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">data</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionObj.__init__" title="Link to this definition"></a></dt>
|
||
<dd><p>Create a new model by parsing and validating input data from keyword arguments.</p>
|
||
<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>
|
||
<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.OptionObj.__iter__">
|
||
<span class="sig-name descname"><span class="pre">__iter__</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionObj.__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>
|
||
<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.OptionObj.__module__">
|
||
<span class="sig-name descname"><span class="pre">__module__</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'kittycad.models.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.OptionObj.__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.OptionObj.__pretty__">
|
||
<span class="sig-name descname"><span class="pre">__pretty__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">fmt</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionObj.__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>
|
||
<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.OptionObj.__private_attributes__">
|
||
<span class="sig-name descname"><span class="pre">__private_attributes__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[Dict[str,</span> <span class="pre">ModelPrivateAttr]]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionObj.__private_attributes__" title="Link to this definition"></a></dt>
|
||
<dd><p>Metadata about the private attributes of the model.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionObj.__pydantic_complete__">
|
||
<span class="sig-name descname"><span class="pre">__pydantic_complete__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[bool]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">True</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionObj.__pydantic_complete__" title="Link to this definition"></a></dt>
|
||
<dd><p>Whether model building is completed, or if there are still undefined fields.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionObj.__pydantic_core_schema__">
|
||
<span class="sig-name descname"><span class="pre">__pydantic_core_schema__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[CoreSchema]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'definitions':</span> <span class="pre">[{'cls':</span> <span class="pre"><class</span> <span class="pre">'kittycad.models.axis_direction_pair.AxisDirectionPair'>,</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(<function</span> <span class="pre">modify_model_json_schema>,</span> <span class="pre">cls=<class</span> <span class="pre">'kittycad.models.axis_direction_pair.AxisDirectionPair'>,</span> <span class="pre">title=None),</span> <span class="pre"><bound</span> <span class="pre">method</span> <span class="pre">BaseModel.__get_pydantic_json_schema__</span> <span class="pre">of</span> <span class="pre"><class</span> <span class="pre">'kittycad.models.axis_direction_pair.AxisDirectionPair'>>]},</span> <span class="pre">'ref':</span> <span class="pre">'kittycad.models.axis_direction_pair.AxisDirectionPair:94740976732752',</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">[<function</span> <span class="pre">get_json_schema_update_func.<locals>.json_schema_update_func>],</span> <span class="pre">'pydantic_js_functions':</span> <span class="pre">[]},</span> <span class="pre">'schema':</span> <span class="pre">{'schema_ref':</span> <span class="pre">'kittycad.models.axis.Axis:94740976727632',</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">[<function</span> <span class="pre">get_json_schema_update_func.<locals>.json_schema_update_func>],</span> <span class="pre">'pydantic_js_functions':</span> <span class="pre">[]},</span> <span class="pre">'schema':</span> <span class="pre">{'schema_ref':</span> <span class="pre">'kittycad.models.direction.Direction:94740976730192',</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"><enum</span> <span class="pre">'Axis'>,</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">[<function</span> <span class="pre">GenerateSchema._enum_schema.<locals>.get_json_schema>]},</span> <span class="pre">'ref':</span> <span class="pre">'kittycad.models.axis.Axis:94740976727632',</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"><enum</span> <span class="pre">'Direction'>,</span> <span class="pre">'members':</span> <span class="pre">[Direction.POSITIVE,</span> <span class="pre">Direction.NEGATIVE],</span> <span class="pre">'metadata':</span> <span class="pre">{'pydantic_js_functions':</span> <span class="pre">[<function</span> <span class="pre">GenerateSchema._enum_schema.<locals>.get_json_schema>]},</span> <span class="pre">'ref':</span> <span class="pre">'kittycad.models.direction.Direction:94740976730192',</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">'schema':</span> <span class="pre">{'cls':</span> <span class="pre"><class</span> <span class="pre">'kittycad.models.input_format.OptionObj'>,</span> <span class="pre">'config':</span> <span class="pre">{'title':</span> <span class="pre">'OptionObj'},</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(<function</span> <span class="pre">modify_model_json_schema>,</span> <span class="pre">cls=<class</span> <span class="pre">'kittycad.models.input_format.OptionObj'>,</span> <span class="pre">title=None),</span> <span class="pre"><bound</span> <span class="pre">method</span> <span class="pre">BaseModel.__get_pydantic_json_schema__</span> <span class="pre">of</span> <span class="pre"><class</span> <span class="pre">'kittycad.models.input_format.OptionObj'>>]},</span> <span class="pre">'ref':</span> <span class="pre">'kittycad.models.input_format.OptionObj:94740974284240',</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">{'coords':</span> <span class="pre">{'metadata':</span> <span class="pre">{'pydantic_js_annotation_functions':</span> <span class="pre">[<function</span> <span class="pre">get_json_schema_update_func.<locals>.json_schema_update_func>],</span> <span class="pre">'pydantic_js_functions':</span> <span class="pre">[]},</span> <span class="pre">'schema':</span> <span class="pre">{'cls':</span> <span class="pre"><class</span> <span class="pre">'kittycad.models.system.System'>,</span> <span class="pre">'config':</span> <span class="pre">{'title':</span> <span class="pre">'System'},</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(<function</span> <span class="pre">modify_model_json_schema>,</span> <span class="pre">cls=<class</span> <span class="pre">'kittycad.models.system.System'>,</span> <span class="pre">title=None),</span> <span class="pre"><bound</span> <span class="pre">method</span> <span class="pre">BaseModel.__get_pydantic_json_schema__</span> <span class="pre">of</span> <span class="pre"><class</span> <span class="pre">'kittycad.models.system.System'>>]},</span> <span class="pre">'ref':</span> <span class="pre">'kittycad.models.system.System:94740976742480',</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">{'forward':</span> <span class="pre">{'metadata':</span> <span class="pre">{'pydantic_js_annotation_functions':</span> <span class="pre">[<function</span> <span class="pre">get_json_schema_update_func.<locals>.json_schema_update_func>],</span> <span class="pre">'pydantic_js_functions':</span> <span class="pre">[]},</span> <span class="pre">'schema':</span> <span class="pre">{'schema_ref':</span> <span class="pre">'kittycad.models.axis_direction_pair.AxisDirectionPair:94740976732752',</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">'up':</span> <span class="pre">{'metadata':</span> <span class="pre">{'pydantic_js_annotation_functions':</span> <span class="pre">[<function</span> <span class="pre">get_json_schema_update_func.<locals>.json_schema_update_func>],</span> <span class="pre">'pydantic_js_functions':</span> <span class="pre">[]},</span> <span class="pre">'schema':</span> <span class="pre">{'schema_ref':</span> <span class="pre">'kittycad.models.axis_direction_pair.AxisDirectionPair:94740976732752',</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">'System',</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">'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">[<function</span> <span class="pre">get_json_schema_update_func.<locals>.json_schema_update_func>],</span> <span class="pre">'pydantic_js_functions':</span> <span class="pre">[]},</span> <span class="pre">'schema':</span> <span class="pre">{'default':</span> <span class="pre">'obj',</span> <span class="pre">'schema':</span> <span class="pre">{'expected':</span> <span class="pre">['obj'],</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">'units':</span> <span class="pre">{'metadata':</span> <span class="pre">{'pydantic_js_annotation_functions':</span> <span class="pre">[<function</span> <span class="pre">get_json_schema_update_func.<locals>.json_schema_update_func>],</span> <span class="pre">'pydantic_js_functions':</span> <span class="pre">[]},</span> <span class="pre">'schema':</span> <span class="pre">{'cls':</span> <span class="pre"><enum</span> <span class="pre">'UnitLength'>,</span> <span class="pre">'members':</span> <span class="pre">[UnitLength.CM,</span> <span class="pre">UnitLength.FT,</span> <span class="pre">UnitLength.IN,</span> <span class="pre">UnitLength.M,</span> <span class="pre">UnitLength.MM,</span> <span class="pre">UnitLength.YD],</span> <span class="pre">'metadata':</span> <span class="pre">{'pydantic_js_functions':</span> <span class="pre">[<function</span> <span class="pre">GenerateSchema._enum_schema.<locals>.get_json_schema>]},</span> <span class="pre">'ref':</span> <span class="pre">'kittycad.models.unit_length.UnitLength:94740972900288',</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">'type':</span> <span class="pre">'model-field'}},</span> <span class="pre">'model_name':</span> <span class="pre">'OptionObj',</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">'type':</span> <span class="pre">'definitions'}</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.OptionObj.__pydantic_core_schema__" title="Link to this definition"></a></dt>
|
||
<dd><p>The core schema of the model.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionObj.__pydantic_custom_init__">
|
||
<span class="sig-name descname"><span class="pre">__pydantic_custom_init__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[bool]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">False</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionObj.__pydantic_custom_init__" title="Link to this definition"></a></dt>
|
||
<dd><p>Whether the model has a custom <a class="reference internal" href="kittycad.models.input_format.OptionObj.html#id0" title="kittycad.models.input_format.OptionObj.__init__"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">__init__</span></code></a> method.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionObj.__pydantic_decorators__">
|
||
<span class="sig-name descname"><span class="pre">__pydantic_decorators__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[_decorators.DecoratorInfos]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">DecoratorInfos(validators={},</span> <span class="pre">field_validators={},</span> <span class="pre">root_validators={},</span> <span class="pre">field_serializers={},</span> <span class="pre">model_serializers={},</span> <span class="pre">model_validators={},</span> <span class="pre">computed_fields={})</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionObj.__pydantic_decorators__" title="Link to this definition"></a></dt>
|
||
<dd><p>Metadata containing the decorators defined on the model.
|
||
This replaces <code class="xref any docutils literal notranslate"><span class="pre">Model.__validators__</span></code> and <code class="xref any docutils literal notranslate"><span class="pre">Model.__root_validators__</span></code> from Pydantic V1.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionObj.__pydantic_extra__">
|
||
<span class="sig-name descname"><span class="pre">__pydantic_extra__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">dict[str,</span> <span class="pre">Any]</span> <span class="pre">|</span> <span class="pre">None</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionObj.__pydantic_extra__" title="Link to this definition"></a></dt>
|
||
<dd><p>A dictionary containing extra values, if [<a class="reference internal" href="kittycad.models.kcl_code_completion_request.KclCodeCompletionRequest.html#kittycad.models.kcl_code_completion_request.KclCodeCompletionRequest.extra" title="kittycad.models.kcl_code_completion_request.KclCodeCompletionRequest.extra"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">extra</span></code></a>][pydantic.config.ConfigDict.extra] is set to <code class="xref any docutils literal notranslate"><span class="pre">'allow'</span></code>.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionObj.__pydantic_fields_set__">
|
||
<span class="sig-name descname"><span class="pre">__pydantic_fields_set__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">set[str]</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionObj.__pydantic_fields_set__" title="Link to this definition"></a></dt>
|
||
<dd><p>The names of fields explicitly set during instantiation.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionObj.__pydantic_generic_metadata__">
|
||
<span class="sig-name descname"><span class="pre">__pydantic_generic_metadata__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[_generics.PydanticGenericMetadata]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'args':</span> <span class="pre">(),</span> <span class="pre">'origin':</span> <span class="pre">None,</span> <span class="pre">'parameters':</span> <span class="pre">()}</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionObj.__pydantic_generic_metadata__" title="Link to this definition"></a></dt>
|
||
<dd><p>Metadata for generic models; contains data used for a similar purpose to
|
||
__args__, __origin__, __parameters__ in typing-module generics. May eventually be replaced by these.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionObj.__pydantic_init_subclass__">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">__pydantic_init_subclass__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionObj.__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.OptionObj.html#kittycad.models.input_format.OptionObj.model_fields" title="kittycad.models.input_format.OptionObj.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>
|
||
<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 aren’t used internally by pydantic.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>**kwargs</strong> (<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 aren’t used internally
|
||
by pydantic.</p>
|
||
</dd>
|
||
<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/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.OptionObj.__pydantic_parent_namespace__">
|
||
<span class="sig-name descname"><span class="pre">__pydantic_parent_namespace__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[Dict[str,</span> <span class="pre">Any]</span> <span class="pre">|</span> <span class="pre">None]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">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.OptionObj.__pydantic_parent_namespace__" title="Link to this definition"></a></dt>
|
||
<dd><p>Parent namespace of the model, used for automatic rebuilding of models.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionObj.__pydantic_post_init__">
|
||
<span class="sig-name descname"><span class="pre">__pydantic_post_init__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[None</span> <span class="pre">|</span> <span class="pre">Literal['model_post_init']]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionObj.__pydantic_post_init__" title="Link to this definition"></a></dt>
|
||
<dd><p>The name of the post-init method for the model, if defined.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionObj.__pydantic_private__">
|
||
<span class="sig-name descname"><span class="pre">__pydantic_private__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">dict[str,</span> <span class="pre">Any]</span> <span class="pre">|</span> <span class="pre">None</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionObj.__pydantic_private__" title="Link to this definition"></a></dt>
|
||
<dd><p>Values of private attributes set on the model instance.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionObj.__pydantic_root_model__">
|
||
<span class="sig-name descname"><span class="pre">__pydantic_root_model__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[bool]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">False</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionObj.__pydantic_root_model__" title="Link to this definition"></a></dt>
|
||
<dd><p>Whether the model is a [<code class="xref any docutils literal notranslate"><span class="pre">RootModel</span></code>][pydantic.root_model.RootModel].</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionObj.__pydantic_serializer__">
|
||
<span class="sig-name descname"><span class="pre">__pydantic_serializer__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[SchemaSerializer]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">SchemaSerializer(serializer=Model(</span>     <span class="pre">ModelSerializer</span> <span class="pre">{</span>         <span class="pre">class:</span> <span class="pre">Py(</span>             <span class="pre">0x0000562a9a1e2dd0,</span>         <span class="pre">),</span>         <span class="pre">serializer:</span> <span class="pre">Fields(</span>             <span class="pre">GeneralFieldsSerializer</span> <span class="pre">{</span>                 <span class="pre">fields:</span> <span class="pre">{</span>                     <span class="pre">"units":</span> <span class="pre">SerField</span> <span class="pre">{</span>                         <span class="pre">key_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007f936e37aa30,</span>                         <span class="pre">),</span>                         <span class="pre">alias:</span> <span class="pre">None,</span>                         <span class="pre">alias_py:</span> <span class="pre">None,</span>                         <span class="pre">serializer:</span> <span class="pre">Some(</span>                             <span class="pre">Enum(</span>                                 <span class="pre">EnumSerializer</span> <span class="pre">{</span>                                     <span class="pre">class:</span> <span class="pre">Py(</span>                                         <span class="pre">0x0000562a9a090fc0,</span>                                     <span class="pre">),</span>                                     <span class="pre">serializer:</span> <span class="pre">Some(</span>                                         <span class="pre">Str(</span>                                             <span class="pre">StrSerializer,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                 <span class="pre">},</span>                             <span class="pre">),</span>                         <span class="pre">),</span>                         <span class="pre">required:</span> <span class="pre">true,</span>                     <span class="pre">},</span>                     <span class="pre">"coords":</span> <span class="pre">SerField</span> <span class="pre">{</span>                         <span class="pre">key_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007f936b87a2e0,</span>                         <span class="pre">),</span>                         <span class="pre">alias:</span> <span class="pre">None,</span>                         <span class="pre">alias_py:</span> <span class="pre">None,</span>                         <span class="pre">serializer:</span> <span class="pre">Some(</span>                             <span class="pre">Model(</span>                                 <span class="pre">ModelSerializer</span> <span class="pre">{</span>                                     <span class="pre">class:</span> <span class="pre">Py(</span>                                         <span class="pre">0x0000562a9a43b050,</span>                                     <span class="pre">),</span>                                     <span class="pre">serializer:</span> <span class="pre">Fields(</span>                                         <span class="pre">GeneralFieldsSerializer</span> <span class="pre">{</span>                                             <span class="pre">fields:</span> <span class="pre">{</span>                                                 <span class="pre">"up":</span> <span class="pre">SerField</span> <span class="pre">{</span>                                                     <span class="pre">key_py:</span> <span class="pre">Py(</span>                                                         <span class="pre">0x00007f936e3777e0,</span>                                                     <span class="pre">),</span>                                                     <span class="pre">alias:</span> <span class="pre">None,</span>                                                     <span class="pre">alias_py:</span> <span class="pre">None,</span>                                                     <span class="pre">serializer:</span> <span class="pre">Some(</span>                                                         <span class="pre">Recursive(</span>                                                             <span class="pre">DefinitionRefSerializer</span> <span class="pre">{</span>                                                                 <span class="pre">definition:</span> <span class="pre">"...",</span>                                                                 <span class="pre">retry_with_lax_check:</span> <span class="pre">true,</span>                                                             <span class="pre">},</span>                                                         <span class="pre">),</span>                                                     <span class="pre">),</span>                                                     <span class="pre">required:</span> <span class="pre">true,</span>                                                 <span class="pre">},</span>                                                 <span class="pre">"forward":</span> <span class="pre">SerField</span> <span class="pre">{</span>                                                     <span class="pre">key_py:</span> <span class="pre">Py(</span>                                                         <span class="pre">0x00007f936b879b00,</span>                                                     <span class="pre">),</span>                                                     <span class="pre">alias:</span> <span class="pre">None,</span>                                                     <span class="pre">alias_py:</span> <span class="pre">None,</span>                                                     <span class="pre">serializer:</span> <span class="pre">Some(</span>                                                         <span class="pre">Recursive(</span>                                                             <span class="pre">DefinitionRefSerializer</span> <span class="pre">{</span>                                                                 <span class="pre">definition:</span> <span class="pre">"...",</span>                                                                 <span class="pre">retry_with_lax_check:</span> <span class="pre">true,</span>                                                             <span class="pre">},</span>                                                         <span class="pre">),</span>                                                     <span class="pre">),</span>                                                     <span class="pre">required:</span> <span class="pre">true,</span>                                                 <span class="pre">},</span>                                             <span class="pre">},</span>                                             <span class="pre">computed_fields:</span> <span class="pre">Some(</span>                                                 <span class="pre">ComputedFields(</span>                                                     <span class="pre">[],</span>                                                 <span class="pre">),</span>                                             <span class="pre">),</span>                                             <span class="pre">mode:</span> <span class="pre">SimpleDict,</span>                                             <span class="pre">extra_serializer:</span> <span class="pre">None,</span>                                             <span class="pre">filter:</span> <span class="pre">SchemaFilter</span> <span class="pre">{</span>                                                 <span class="pre">include:</span> <span class="pre">None,</span>                                                 <span class="pre">exclude:</span> <span class="pre">None,</span>                                             <span class="pre">},</span>                                             <span class="pre">required_fields:</span> <span class="pre">2,</span>                                         <span class="pre">},</span>                                     <span class="pre">),</span>                                     <span class="pre">has_extra:</span> <span class="pre">false,</span>                                     <span class="pre">root_model:</span> <span class="pre">false,</span>                                     <span class="pre">name:</span> <span class="pre">"System",</span>                                 <span class="pre">},</span>                             <span class="pre">),</span>                         <span class="pre">),</span>                         <span class="pre">required:</span> <span class="pre">true,</span>                     <span class="pre">},</span>                     <span class="pre">"type":</span> <span class="pre">SerField</span> <span class="pre">{</span>                         <span class="pre">key_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007f936f623938,</span>                         <span class="pre">),</span>                         <span class="pre">alias:</span> <span class="pre">None,</span>                         <span class="pre">alias_py:</span> <span class="pre">None,</span>                         <span class="pre">serializer:</span> <span class="pre">Some(</span>                             <span class="pre">WithDefault(</span>                                 <span class="pre">WithDefaultSerializer</span> <span class="pre">{</span>                                     <span class="pre">default:</span> <span class="pre">Default(</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007f936f621a68,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                     <span class="pre">serializer:</span> <span class="pre">Literal(</span>                                         <span class="pre">LiteralSerializer</span> <span class="pre">{</span>                                             <span class="pre">expected_int:</span> <span class="pre">{},</span>                                             <span class="pre">expected_str:</span> <span class="pre">{</span>                                                 <span class="pre">"obj",</span>                                             <span class="pre">},</span>                                             <span class="pre">expected_py:</span> <span class="pre">None,</span>                                             <span class="pre">name:</span> <span class="pre">"literal['obj']",</span>                                         <span class="pre">},</span>                                     <span class="pre">),</span>                                 <span class="pre">},</span>                             <span class="pre">),</span>                         <span class="pre">),</span>                         <span class="pre">required:</span> <span class="pre">true,</span>                     <span class="pre">},</span>                 <span class="pre">},</span>                 <span class="pre">computed_fields:</span> <span class="pre">Some(</span>                     <span class="pre">ComputedFields(</span>                         <span class="pre">[],</span>                     <span class="pre">),</span>                 <span class="pre">),</span>                 <span class="pre">mode:</span> <span class="pre">SimpleDict,</span>                 <span class="pre">extra_serializer:</span> <span class="pre">None,</span>                 <span class="pre">filter:</span> <span class="pre">SchemaFilter</span> <span class="pre">{</span>                     <span class="pre">include:</span> <span class="pre">None,</span>                     <span class="pre">exclude:</span> <span class="pre">None,</span>                 <span class="pre">},</span>                 <span class="pre">required_fields:</span> <span class="pre">3,</span>             <span class="pre">},</span>         <span class="pre">),</span>         <span class="pre">has_extra:</span> <span class="pre">false,</span>         <span class="pre">root_model:</span> <span class="pre">false,</span>         <span class="pre">name:</span> <span class="pre">"OptionObj",</span>     <span class="pre">},</span> <span class="pre">),</span> <span class="pre">definitions=[Enum(EnumSerializer</span> <span class="pre">{</span> <span class="pre">class:</span> <span class="pre">Py(0x562a9a437650),</span> <span class="pre">serializer:</span> <span class="pre">Some(Str(StrSerializer))</span> <span class="pre">}),</span> <span class="pre">Enum(EnumSerializer</span> <span class="pre">{</span> <span class="pre">class:</span> <span class="pre">Py(0x562a9a438050),</span> <span class="pre">serializer:</span> <span class="pre">Some(Str(StrSerializer))</span> <span class="pre">}),</span> <span class="pre">Model(ModelSerializer</span> <span class="pre">{</span> <span class="pre">class:</span> <span class="pre">Py(0x562a9a438a50),</span> <span class="pre">serializer:</span> <span class="pre">Fields(GeneralFieldsSerializer</span> <span class="pre">{</span> <span class="pre">fields:</span> <span class="pre">{"axis":</span> <span class="pre">SerField</span> <span class="pre">{</span> <span class="pre">key_py:</span> <span class="pre">Py(0x7f936bc3a310),</span> <span class="pre">alias:</span> <span class="pre">None,</span> <span class="pre">alias_py:</span> <span class="pre">None,</span> <span class="pre">serializer:</span> <span class="pre">Some(Recursive(DefinitionRefSerializer</span> <span class="pre">{</span> <span class="pre">definition:</span> <span class="pre">"...",</span> <span class="pre">retry_with_lax_check:</span> <span class="pre">false</span> <span class="pre">})),</span> <span class="pre">required:</span> <span class="pre">true</span> <span class="pre">},</span> <span class="pre">"direction":</span> <span class="pre">SerField</span> <span class="pre">{</span> <span class="pre">key_py:</span> <span class="pre">Py(0x7f936e0debf0),</span> <span class="pre">alias:</span> <span class="pre">None,</span> <span class="pre">alias_py:</span> <span class="pre">None,</span> <span class="pre">serializer:</span> <span class="pre">Some(Recursive(DefinitionRefSerializer</span> <span class="pre">{</span> <span class="pre">definition:</span> <span class="pre">"...",</span> <span class="pre">retry_with_lax_check:</span> <span class="pre">false</span> <span class="pre">})),</span> <span class="pre">required:</span> <span class="pre">true</span> <span class="pre">}},</span> <span class="pre">computed_fields:</span> <span class="pre">Some(ComputedFields([])),</span> <span class="pre">mode:</span> <span class="pre">SimpleDict,</span> <span class="pre">extra_serializer:</span> <span class="pre">None,</span> <span class="pre">filter:</span> <span class="pre">SchemaFilter</span> <span class="pre">{</span> <span class="pre">include:</span> <span class="pre">None,</span> <span class="pre">exclude:</span> <span class="pre">None</span> <span class="pre">},</span> <span class="pre">required_fields:</span> <span class="pre">2</span> <span class="pre">}),</span> <span class="pre">has_extra:</span> <span class="pre">false,</span> <span class="pre">root_model:</span> <span class="pre">false,</span> <span class="pre">name:</span> <span class="pre">"AxisDirectionPair"</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.OptionObj.__pydantic_serializer__" title="Link to this definition"></a></dt>
|
||
<dd><p>The <code class="xref any docutils literal notranslate"><span class="pre">pydantic-core</span></code> <code class="xref any docutils literal notranslate"><span class="pre">SchemaSerializer</span></code> used to dump instances of the model.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionObj.__pydantic_validator__">
|
||
<span class="sig-name descname"><span class="pre">__pydantic_validator__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[SchemaValidator</span> <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="OptionObj",</span> <span class="pre">validator=Model(</span>     <span class="pre">ModelValidator</span> <span class="pre">{</span>         <span class="pre">revalidate:</span> <span class="pre">Never,</span>         <span class="pre">validator:</span> <span class="pre">ModelFields(</span>             <span class="pre">ModelFieldsValidator</span> <span class="pre">{</span>                 <span class="pre">fields:</span> <span class="pre">[</span>                     <span class="pre">Field</span> <span class="pre">{</span>                         <span class="pre">name:</span> <span class="pre">"coords",</span>                         <span class="pre">lookup_key:</span> <span class="pre">Simple</span> <span class="pre">{</span>                             <span class="pre">key:</span> <span class="pre">"coords",</span>                             <span class="pre">py_key:</span> <span class="pre">Py(</span>                                 <span class="pre">0x00007f936b87b0c0,</span>                             <span class="pre">),</span>                             <span class="pre">path:</span> <span class="pre">LookupPath(</span>                                 <span class="pre">[</span>                                     <span class="pre">S(</span>                                         <span class="pre">"coords",</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007f936b87b0f0,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                 <span class="pre">],</span>                             <span class="pre">),</span>                         <span class="pre">},</span>                         <span class="pre">name_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007f936b87a2e0,</span>                         <span class="pre">),</span>                         <span class="pre">validator:</span> <span class="pre">Model(</span>                             <span class="pre">ModelValidator</span> <span class="pre">{</span>                                 <span class="pre">revalidate:</span> <span class="pre">Never,</span>                                 <span class="pre">validator:</span> <span class="pre">ModelFields(</span>                                     <span class="pre">ModelFieldsValidator</span> <span class="pre">{</span>                                         <span class="pre">fields:</span> <span class="pre">[</span>                                             <span class="pre">Field</span> <span class="pre">{</span>                                                 <span class="pre">name:</span> <span class="pre">"forward",</span>                                                 <span class="pre">lookup_key:</span> <span class="pre">Simple</span> <span class="pre">{</span>                                                     <span class="pre">key:</span> <span class="pre">"forward",</span>                                                     <span class="pre">py_key:</span> <span class="pre">Py(</span>                                                         <span class="pre">0x00007f936b87afd0,</span>                                                     <span class="pre">),</span>                                                     <span class="pre">path:</span> <span class="pre">LookupPath(</span>                                                         <span class="pre">[</span>                                                             <span class="pre">S(</span>                                                                 <span class="pre">"forward",</span>                                                                 <span class="pre">Py(</span>                                                                     <span class="pre">0x00007f936b87b000,</span>                                                                 <span class="pre">),</span>                                                             <span class="pre">),</span>                                                         <span class="pre">],</span>                                                     <span class="pre">),</span>                                                 <span class="pre">},</span>                                                 <span class="pre">name_py:</span> <span class="pre">Py(</span>                                                     <span class="pre">0x00007f936b879b00,</span>                                                 <span class="pre">),</span>                                                 <span class="pre">validator:</span> <span class="pre">DefinitionRef(</span>                                                     <span class="pre">DefinitionRefValidator</span> <span class="pre">{</span>                                                         <span class="pre">definition:</span> <span class="pre">"...",</span>                                                     <span class="pre">},</span>                                                 <span class="pre">),</span>                                                 <span class="pre">frozen:</span> <span class="pre">false,</span>                                             <span class="pre">},</span>                                             <span class="pre">Field</span> <span class="pre">{</span>                                                 <span class="pre">name:</span> <span class="pre">"up",</span>                                                 <span class="pre">lookup_key:</span> <span class="pre">Simple</span> <span class="pre">{</span>                                                     <span class="pre">key:</span> <span class="pre">"up",</span>                                                     <span class="pre">py_key:</span> <span class="pre">Py(</span>                                                         <span class="pre">0x00007f936b87b030,</span>                                                     <span class="pre">),</span>                                                     <span class="pre">path:</span> <span class="pre">LookupPath(</span>                                                         <span class="pre">[</span>                                                             <span class="pre">S(</span>                                                                 <span class="pre">"up",</span>                                                                 <span class="pre">Py(</span>                                                                     <span class="pre">0x00007f936b87b060,</span>                                                                 <span class="pre">),</span>                                                             <span class="pre">),</span>                                                         <span class="pre">],</span>                                                     <span class="pre">),</span>                                                 <span class="pre">},</span>                                                 <span class="pre">name_py:</span> <span class="pre">Py(</span>                                                     <span class="pre">0x00007f936e3777e0,</span>                                                 <span class="pre">),</span>                                                 <span class="pre">validator:</span> <span class="pre">DefinitionRef(</span>                                                     <span class="pre">DefinitionRefValidator</span> <span class="pre">{</span>                                                         <span class="pre">definition:</span> <span class="pre">"...",</span>                                                     <span class="pre">},</span>                                                 <span class="pre">),</span>                                                 <span class="pre">frozen:</span> <span class="pre">false,</span>                                             <span class="pre">},</span>                                         <span class="pre">],</span>                                         <span class="pre">model_name:</span> <span class="pre">"System",</span>                                         <span class="pre">extra_behavior:</span> <span class="pre">Ignore,</span>                                         <span class="pre">extras_validator:</span> <span class="pre">None,</span>                                         <span class="pre">strict:</span> <span class="pre">false,</span>                                         <span class="pre">from_attributes:</span> <span class="pre">false,</span>                                         <span class="pre">loc_by_alias:</span> <span class="pre">true,</span>                                     <span class="pre">},</span>                                 <span class="pre">),</span>                                 <span class="pre">class:</span> <span class="pre">Py(</span>                                     <span class="pre">0x0000562a9a43b050,</span>                                 <span class="pre">),</span>                                 <span class="pre">post_init:</span> <span class="pre">None,</span>                                 <span class="pre">frozen:</span> <span class="pre">false,</span>                                 <span class="pre">custom_init:</span> <span class="pre">false,</span>                                 <span class="pre">root_model:</span> <span class="pre">false,</span>                                 <span class="pre">undefined:</span> <span class="pre">Py(</span>                                     <span class="pre">0x00007f936d406320,</span>                                 <span class="pre">),</span>                                 <span class="pre">name:</span> <span class="pre">"System",</span>                             <span class="pre">},</span>                         <span class="pre">),</span>                         <span class="pre">frozen:</span> <span class="pre">false,</span>                     <span class="pre">},</span>                     <span class="pre">Field</span> <span class="pre">{</span>                         <span class="pre">name:</span> <span class="pre">"type",</span>                         <span class="pre">lookup_key:</span> <span class="pre">Simple</span> <span class="pre">{</span>                             <span class="pre">key:</span> <span class="pre">"type",</span>                             <span class="pre">py_key:</span> <span class="pre">Py(</span>                                 <span class="pre">0x00007f936b87b180,</span>                             <span class="pre">),</span>                             <span class="pre">path:</span> <span class="pre">LookupPath(</span>                                 <span class="pre">[</span>                                     <span class="pre">S(</span>                                         <span class="pre">"type",</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007f936b87b120,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                 <span class="pre">],</span>                             <span class="pre">),</span>                         <span class="pre">},</span>                         <span class="pre">name_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007f936f623938,</span>                         <span class="pre">),</span>                         <span class="pre">validator:</span> <span class="pre">WithDefault(</span>                             <span class="pre">WithDefaultValidator</span> <span class="pre">{</span>                                 <span class="pre">default:</span> <span class="pre">Default(</span>                                     <span class="pre">Py(</span>                                         <span class="pre">0x00007f936f621a68,</span>                                     <span class="pre">),</span>                                 <span class="pre">),</span>                                 <span class="pre">on_error:</span> <span class="pre">Raise,</span>                                 <span class="pre">validator:</span> <span class="pre">Literal(</span>                                     <span class="pre">LiteralValidator</span> <span class="pre">{</span>                                         <span class="pre">lookup:</span> <span class="pre">LiteralLookup</span> <span class="pre">{</span>                                             <span class="pre">expected_bool:</span> <span class="pre">None,</span>                                             <span class="pre">expected_int:</span> <span class="pre">None,</span>                                             <span class="pre">expected_str:</span> <span class="pre">Some(</span>                                                 <span class="pre">{</span>                                                     <span class="pre">"obj":</span> <span class="pre">0,</span>                                                 <span class="pre">},</span>                                             <span class="pre">),</span>                                             <span class="pre">expected_py_dict:</span> <span class="pre">None,</span>                                             <span class="pre">expected_py_values:</span> <span class="pre">None,</span>                                             <span class="pre">values:</span> <span class="pre">[</span>                                                 <span class="pre">Py(</span>                                                     <span class="pre">0x00007f936f621a68,</span>                                                 <span class="pre">),</span>                                             <span class="pre">],</span>                                         <span class="pre">},</span>                                         <span class="pre">expected_repr:</span> <span class="pre">"'obj'",</span>                                         <span class="pre">name:</span> <span class="pre">"literal['obj']",</span>                                     <span class="pre">},</span>                                 <span class="pre">),</span>                                 <span class="pre">validate_default:</span> <span class="pre">false,</span>                                 <span class="pre">copy_default:</span> <span class="pre">false,</span>                                 <span class="pre">name:</span> <span class="pre">"default[literal['obj']]",</span>                                 <span class="pre">undefined:</span> <span class="pre">Py(</span>                                     <span class="pre">0x00007f936d406320,</span>                                 <span class="pre">),</span>                             <span class="pre">},</span>                         <span class="pre">),</span>                         <span class="pre">frozen:</span> <span class="pre">false,</span>                     <span class="pre">},</span>                     <span class="pre">Field</span> <span class="pre">{</span>                         <span class="pre">name:</span> <span class="pre">"units",</span>                         <span class="pre">lookup_key:</span> <span class="pre">Simple</span> <span class="pre">{</span>                             <span class="pre">key:</span> <span class="pre">"units",</span>                             <span class="pre">py_key:</span> <span class="pre">Py(</span>                                 <span class="pre">0x00007f936b87b1b0,</span>                             <span class="pre">),</span>                             <span class="pre">path:</span> <span class="pre">LookupPath(</span>                                 <span class="pre">[</span>                                     <span class="pre">S(</span>                                         <span class="pre">"units",</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007f936b87b1e0,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                 <span class="pre">],</span>                             <span class="pre">),</span>                         <span class="pre">},</span>                         <span class="pre">name_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007f936e37aa30,</span>                         <span class="pre">),</span>                         <span class="pre">validator:</span> <span class="pre">StrEnum(</span>                             <span class="pre">EnumValidator</span> <span class="pre">{</span>                                 <span class="pre">phantom:</span> <span class="pre">PhantomData<_pydantic_core::validators::enum_::StrEnumValidator>,</span>                                 <span class="pre">class:</span> <span class="pre">Py(</span>                                     <span class="pre">0x0000562a9a090fc0,</span>                                 <span class="pre">),</span>                                 <span class="pre">lookup:</span> <span class="pre">LiteralLookup</span> <span class="pre">{</span>                                     <span class="pre">expected_bool:</span> <span class="pre">None,</span>                                     <span class="pre">expected_int:</span> <span class="pre">None,</span>                                     <span class="pre">expected_str:</span> <span class="pre">Some(</span>                                         <span class="pre">{</span>                                             <span class="pre">"in":</span> <span class="pre">2,</span>                                             <span class="pre">"mm":</span> <span class="pre">4,</span>                                             <span class="pre">"yd":</span> <span class="pre">5,</span>                                             <span class="pre">"cm":</span> <span class="pre">0,</span>                                             <span class="pre">"m":</span> <span class="pre">3,</span>                                             <span class="pre">"ft":</span> <span class="pre">1,</span>                                         <span class="pre">},</span>                                     <span class="pre">),</span>                                     <span class="pre">expected_py_dict:</span> <span class="pre">None,</span>                                     <span class="pre">expected_py_values:</span> <span class="pre">None,</span>                                     <span class="pre">values:</span> <span class="pre">[</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007f936aeac890,</span>                                         <span class="pre">),</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007f936aeace30,</span>                                         <span class="pre">),</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007f936aeacef0,</span>                                         <span class="pre">),</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007f936aeacf50,</span>                                         <span class="pre">),</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007f936aeacfb0,</span>                                         <span class="pre">),</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007f936aead010,</span>                                         <span class="pre">),</span>                                     <span class="pre">],</span>                                 <span class="pre">},</span>                                 <span class="pre">missing:</span> <span class="pre">None,</span>                                 <span class="pre">expected_repr:</span> <span class="pre">"'cm',</span> <span class="pre">'ft',</span> <span class="pre">'in',</span> <span class="pre">'m',</span> <span class="pre">'mm'</span> <span class="pre">or</span> <span class="pre">'yd'",</span>                                 <span class="pre">strict:</span> <span class="pre">false,</span>                                 <span class="pre">class_repr:</span> <span class="pre">"UnitLength",</span>                                 <span class="pre">name:</span> <span class="pre">"str-enum[UnitLength]",</span>                             <span class="pre">},</span>                         <span class="pre">),</span>                         <span class="pre">frozen:</span> <span class="pre">false,</span>                     <span class="pre">},</span>                 <span class="pre">],</span>                 <span class="pre">model_name:</span> <span class="pre">"OptionObj",</span>                 <span class="pre">extra_behavior:</span> <span class="pre">Ignore,</span>                 <span class="pre">extras_validator:</span> <span class="pre">None,</span>                 <span class="pre">strict:</span> <span class="pre">false,</span>                 <span class="pre">from_attributes:</span> <span class="pre">false,</span>                 <span class="pre">loc_by_alias:</span> <span class="pre">true,</span>             <span class="pre">},</span>         <span class="pre">),</span>         <span class="pre">class:</span> <span class="pre">Py(</span>             <span class="pre">0x0000562a9a1e2dd0,</span>         <span class="pre">),</span>         <span class="pre">post_init:</span> <span class="pre">None,</span>         <span class="pre">frozen:</span> <span class="pre">false,</span>         <span class="pre">custom_init:</span> <span class="pre">false,</span>         <span class="pre">root_model:</span> <span class="pre">false,</span>         <span class="pre">undefined:</span> <span class="pre">Py(</span>             <span class="pre">0x00007f936d406320,</span>         <span class="pre">),</span>         <span class="pre">name:</span> <span class="pre">"OptionObj",</span>     <span class="pre">},</span> <span class="pre">),</span> <span class="pre">definitions=[StrEnum(EnumValidator</span> <span class="pre">{</span> <span class="pre">phantom:</span> <span class="pre">PhantomData<_pydantic_core::validators::enum_::StrEnumValidator>,</span> <span class="pre">class:</span> <span class="pre">Py(0x562a9a437650),</span> <span class="pre">lookup:</span> <span class="pre">LiteralLookup</span> <span class="pre">{</span> <span class="pre">expected_bool:</span> <span class="pre">None,</span> <span class="pre">expected_int:</span> <span class="pre">None,</span> <span class="pre">expected_str:</span> <span class="pre">Some({"z":</span> <span class="pre">1,</span> <span class="pre">"y":</span> <span class="pre">0}),</span> <span class="pre">expected_py_dict:</span> <span class="pre">None,</span> <span class="pre">expected_py_values:</span> <span class="pre">None,</span> <span class="pre">values:</span> <span class="pre">[Py(0x7f936aeacad0),</span> <span class="pre">Py(0x7f936aeacb30)]</span> <span class="pre">},</span> <span class="pre">missing:</span> <span class="pre">None,</span> <span class="pre">expected_repr:</span> <span class="pre">"'y'</span> <span class="pre">or</span> <span class="pre">'z'",</span> <span class="pre">strict:</span> <span class="pre">false,</span> <span class="pre">class_repr:</span> <span class="pre">"Axis",</span> <span class="pre">name:</span> <span class="pre">"str-enum[Axis]"</span> <span class="pre">}),</span> <span class="pre">Model(ModelValidator</span> <span class="pre">{</span> <span class="pre">revalidate:</span> <span class="pre">Never,</span> <span class="pre">validator:</span> <span class="pre">ModelFields(ModelFieldsValidator</span> <span class="pre">{</span> <span class="pre">fields:</span> <span class="pre">[Field</span> <span class="pre">{</span> <span class="pre">name:</span> <span class="pre">"axis",</span> <span class="pre">lookup_key:</span> <span class="pre">Simple</span> <span class="pre">{</span> <span class="pre">key:</span> <span class="pre">"axis",</span> <span class="pre">py_key:</span> <span class="pre">Py(0x7f936b87adf0),</span> <span class="pre">path:</span> <span class="pre">LookupPath([S("axis",</span> <span class="pre">Py(0x7f936b87af70))])</span> <span class="pre">},</span> <span class="pre">name_py:</span> <span class="pre">Py(0x7f936bc3a310),</span> <span class="pre">validator:</span> <span class="pre">DefinitionRef(DefinitionRefValidator</span> <span class="pre">{</span> <span class="pre">definition:</span> <span class="pre">"..."</span> <span class="pre">}),</span> <span class="pre">frozen:</span> <span class="pre">false</span> <span class="pre">},</span> <span class="pre">Field</span> <span class="pre">{</span> <span class="pre">name:</span> <span class="pre">"direction",</span> <span class="pre">lookup_key:</span> <span class="pre">Simple</span> <span class="pre">{</span> <span class="pre">key:</span> <span class="pre">"direction",</span> <span class="pre">py_key:</span> <span class="pre">Py(0x7f936af76370),</span> <span class="pre">path:</span> <span class="pre">LookupPath([S("direction",</span> <span class="pre">Py(0x7f936af763b0))])</span> <span class="pre">},</span> <span class="pre">name_py:</span> <span class="pre">Py(0x7f936e0debf0),</span> <span class="pre">validator:</span> <span class="pre">DefinitionRef(DefinitionRefValidator</span> <span class="pre">{</span> <span class="pre">definition:</span> <span class="pre">"..."</span> <span class="pre">}),</span> <span class="pre">frozen:</span> <span class="pre">false</span> <span class="pre">}],</span> <span class="pre">model_name:</span> <span class="pre">"AxisDirectionPair",</span> <span class="pre">extra_behavior:</span> <span class="pre">Ignore,</span> <span class="pre">extras_validator:</span> <span class="pre">None,</span> <span class="pre">strict:</span> <span class="pre">false,</span> <span class="pre">from_attributes:</span> <span class="pre">false,</span> <span class="pre">loc_by_alias:</span> <span class="pre">true</span> <span class="pre">}),</span> <span class="pre">class:</span> <span class="pre">Py(0x562a9a438a50),</span> <span class="pre">post_init:</span> <span class="pre">None,</span> <span class="pre">frozen:</span> <span class="pre">false,</span> <span class="pre">custom_init:</span> <span class="pre">false,</span> <span class="pre">root_model:</span> <span class="pre">false,</span> <span class="pre">undefined:</span> <span class="pre">Py(0x7f936d406320),</span> <span class="pre">name:</span> <span class="pre">"AxisDirectionPair"</span> <span class="pre">}),</span> <span class="pre">StrEnum(EnumValidator</span> <span class="pre">{</span> <span class="pre">phantom:</span> <span class="pre">PhantomData<_pydantic_core::validators::enum_::StrEnumValidator>,</span> <span class="pre">class:</span> <span class="pre">Py(0x562a9a438050),</span> <span class="pre">lookup:</span> <span class="pre">LiteralLookup</span> <span class="pre">{</span> <span class="pre">expected_bool:</span> <span class="pre">None,</span> <span class="pre">expected_int:</span> <span class="pre">None,</span> <span class="pre">expected_str:</span> <span class="pre">Some({"positive":</span> <span class="pre">0,</span> <span class="pre">"negative":</span> <span class="pre">1}),</span> <span class="pre">expected_py_dict:</span> <span class="pre">None,</span> <span class="pre">expected_py_values:</span> <span class="pre">None,</span> <span class="pre">values:</span> <span class="pre">[Py(0x7f936aeacc50),</span> <span class="pre">Py(0x7f936aeaccb0)]</span> <span class="pre">},</span> <span class="pre">missing:</span> <span class="pre">None,</span> <span class="pre">expected_repr:</span> <span class="pre">"'positive'</span> <span class="pre">or</span> <span class="pre">'negative'",</span> <span class="pre">strict:</span> <span class="pre">false,</span> <span class="pre">class_repr:</span> <span class="pre">"Direction",</span> <span class="pre">name:</span> <span class="pre">"str-enum[Direction]"</span> <span class="pre">})],</span> <span class="pre">cache_strings=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.OptionObj.__pydantic_validator__" title="Link to this definition"></a></dt>
|
||
<dd><p>The <code class="xref any docutils literal notranslate"><span class="pre">pydantic-core</span></code> <code class="xref any docutils literal notranslate"><span class="pre">SchemaValidator</span></code> used to validate instances of the model.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionObj.__repr__">
|
||
<span class="sig-name descname"><span class="pre">__repr__</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionObj.__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>
|
||
<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.OptionObj.__repr_args__">
|
||
<span class="sig-name descname"><span class="pre">__repr_args__</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionObj.__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/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/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/typing.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.OptionObj.__repr_name__">
|
||
<span class="sig-name descname"><span class="pre">__repr_name__</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionObj.__repr_name__" title="Link to this definition"></a></dt>
|
||
<dd><p>Name of the instance’s class, used in __repr__.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><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.OptionObj.__repr_str__">
|
||
<span class="sig-name descname"><span class="pre">__repr_str__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">join_str</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionObj.__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>
|
||
<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.OptionObj.__rich_repr__">
|
||
<span class="sig-name descname"><span class="pre">__rich_repr__</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionObj.__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>
|
||
<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.OptionObj.__setattr__">
|
||
<span class="sig-name descname"><span class="pre">__setattr__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionObj.__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>
|
||
<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.OptionObj.__setstate__">
|
||
<span class="sig-name descname"><span class="pre">__setstate__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">state</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionObj.__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>
|
||
<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.OptionObj.__signature__">
|
||
<span class="sig-name descname"><span class="pre">__signature__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[Signature]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre"><Signature</span> <span class="pre">(*,</span> <span class="pre">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">-></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.OptionObj.__signature__" title="Link to this definition"></a></dt>
|
||
<dd><p>The synthesized <a class="reference internal" href="kittycad.models.input_format.OptionObj.html#id0" title="kittycad.models.input_format.OptionObj.__init__"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">__init__</span></code></a> [<code class="xref any docutils literal notranslate"><span class="pre">Signature</span></code>][inspect.Signature] of the model.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionObj.__slots__">
|
||
<span class="sig-name descname"><span class="pre">__slots__</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">('__dict__',</span> <span class="pre">'__pydantic_fields_set__',</span> <span class="pre">'__pydantic_extra__',</span> <span class="pre">'__pydantic_private__')</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionObj.__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.OptionObj.__str__">
|
||
<span class="sig-name descname"><span class="pre">__str__</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionObj.__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>
|
||
<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.OptionObj._abc_impl">
|
||
<span class="sig-name descname"><span class="pre">_abc_impl</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre"><_abc._abc_data</span> <span class="pre">object></span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionObj._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.OptionObj._calculate_keys">
|
||
<span class="sig-name descname"><span class="pre">_calculate_keys</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionObj._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>
|
||
<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.OptionObj._check_frozen">
|
||
<span class="sig-name descname"><span class="pre">_check_frozen</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionObj._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>
|
||
<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.OptionObj._copy_and_set_values">
|
||
<span class="sig-name descname"><span class="pre">_copy_and_set_values</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionObj._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>
|
||
<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.OptionObj._get_value">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">_get_value</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="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.OptionObj._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>
|
||
<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.OptionObj._iter">
|
||
<span class="sig-name descname"><span class="pre">_iter</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionObj._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>
|
||
<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.OptionObj.construct">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">construct</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_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.OptionObj.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>
|
||
<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.OptionObj.coords">
|
||
<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.OptionObj.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.OptionObj.copy">
|
||
<span class="sig-name descname"><span class="pre">copy</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">include</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exclude</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">update</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">deep</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionObj.copy" title="Link to this definition"></a></dt>
|
||
<dd><p>Returns a copy of the model.</p>
|
||
<dl class="simple">
|
||
<dt>!!! warning “Deprecated”</dt><dd><p>This method is now deprecated; use <a class="reference internal" href="kittycad.models.input_format.OptionObj.html#kittycad.models.input_format.OptionObj.model_copy" title="kittycad.models.input_format.OptionObj.model_copy"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">model_copy</span></code></a> instead.</p>
|
||
</dd>
|
||
</dl>
|
||
<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">
|
||
<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>
|
||
<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.OptionObj.dict">
|
||
<span class="sig-name descname"><span class="pre">dict</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">include</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exclude</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">by_alias</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exclude_unset</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exclude_defaults</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exclude_none</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionObj.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>
|
||
<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.OptionObj.from_orm">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_orm</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">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.OptionObj.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>
|
||
<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.OptionObj.json">
|
||
<span class="sig-name descname"><span class="pre">json</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">include</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exclude</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">by_alias</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exclude_unset</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exclude_defaults</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exclude_none</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">encoder</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">PydanticUndefined</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">models_as_dict</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">PydanticUndefined</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">dumps_kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionObj.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>
|
||
<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.OptionObj.model_computed_fields">
|
||
<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.OptionObj.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.OptionObj.model_config">
|
||
<span class="sig-name descname"><span class="pre">model_config</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[ConfigDict]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'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.OptionObj.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.OptionObj.model_construct">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">model_construct</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_fields_set</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">values</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionObj.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.OptionObj.html#kittycad.models.input_format.OptionObj.__dict__" title="kittycad.models.input_format.OptionObj.__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.OptionObj.html#kittycad.models.input_format.OptionObj.__pydantic_fields_set__" title="kittycad.models.input_format.OptionObj.__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.OptionObj.html#kittycad.models.input_format.OptionObj.model_construct" title="kittycad.models.input_format.OptionObj.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 instance’s <a class="reference internal" href="kittycad.models.input_format.OptionObj.html#kittycad.models.input_format.OptionObj.__dict__" title="kittycad.models.input_format.OptionObj.__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.OptionObj.html#kittycad.models.input_format.OptionObj.__pydantic_extra__" title="kittycad.models.input_format.OptionObj.__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.OptionObj.html#kittycad.models.input_format.OptionObj.model_construct" title="kittycad.models.input_format.OptionObj.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">
|
||
<li><p><strong>_fields_set</strong> (<span class="sphinx_autodoc_typehints-type"><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>] | <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 field names that were originally explicitly set during instantiation. If provided,
|
||
this is directly used for the [<a class="reference internal" href="kittycad.models.input_format.OptionObj.html#kittycad.models.input_format.OptionObj.model_fields_set" title="kittycad.models.input_format.OptionObj.model_fields_set"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">model_fields_set</span></code></a>][pydantic.BaseModel.model_fields_set] attribute.
|
||
Otherwise, the field names from the <code class="xref any docutils literal notranslate"><span class="pre">values</span></code> argument will be used.</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>
|
||
<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>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.OptionObj.model_copy">
|
||
<span class="sig-name descname"><span class="pre">model_copy</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">update</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">deep</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionObj.model_copy" title="Link to this definition"></a></dt>
|
||
<dd><p>Usage docs: <a class="reference external" href="https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy">https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy</a></p>
|
||
<p>Returns a copy of the model.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>update</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference internal" href="kittycad.models.input_format.OptionObj.html#kittycad.models.input_format.OptionObj.dict" title="kittycad.models.input_format.OptionObj.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>] | <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>) – Values to change/add in the new model. Note: the data is not validated
|
||
before creating the new model. You should trust this data.</p></li>
|
||
<li><p><strong>deep</strong> (<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>
|
||
<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.OptionObj.model_dump">
|
||
<span class="sig-name descname"><span class="pre">model_dump</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mode</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'python'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">include</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exclude</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">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.OptionObj.model_dump" title="Link to this definition"></a></dt>
|
||
<dd><p>Usage docs: <a class="reference external" href="https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump">https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump</a></p>
|
||
<p>Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>mode</strong> (<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.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.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.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[IncEx, <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">True</span></code>]]], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[IncEx, <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">True</span></code>]]], <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">True</span></code>]]], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.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.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[IncEx, <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">True</span></code>]]], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[IncEx, <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">True</span></code>]]], <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">True</span></code>]]], <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.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.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.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[IncEx, <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">True</span></code>]]], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[IncEx, <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">True</span></code>]]], <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">True</span></code>]]], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.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.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[IncEx, <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">True</span></code>]]], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[IncEx, <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">True</span></code>]]], <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">True</span></code>]]], <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.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>) – 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 field’s 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>
|
||
<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.OptionObj.html#kittycad.models.input_format.OptionObj.dict" title="kittycad.models.input_format.OptionObj.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.OptionObj.model_dump_json">
|
||
<span class="sig-name descname"><span class="pre">model_dump_json</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">indent</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">include</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exclude</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">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.OptionObj.model_dump_json" title="Link to this definition"></a></dt>
|
||
<dd><p>Usage docs: <a class="reference external" href="https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json">https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json</a></p>
|
||
<p>Generates a JSON representation of the model using Pydantic’s <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">
|
||
<li><p><strong>indent</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> | <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>) – 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.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.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.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[IncEx, <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">True</span></code>]]], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[IncEx, <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">True</span></code>]]], <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">True</span></code>]]], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.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.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[IncEx, <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">True</span></code>]]], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[IncEx, <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">True</span></code>]]], <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">True</span></code>]]], <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.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.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.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[IncEx, <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">True</span></code>]]], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[IncEx, <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">True</span></code>]]], <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">True</span></code>]]], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.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.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[IncEx, <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">True</span></code>]]], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[IncEx, <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">True</span></code>]]], <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">True</span></code>]]], <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.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>) – 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>
|
||
<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.OptionObj.model_extra">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">model_extra</span></span><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.OptionObj.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>
|
||
<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">"allow"</span></code>.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionObj.model_fields">
|
||
<span class="sig-name descname"><span class="pre">model_fields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[Dict[str,</span> <span class="pre">FieldInfo]]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'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.OptionObj.model_fields" title="Link to this definition"></a></dt>
|
||
<dd><p>Metadata about the fields defined on the model,
|
||
mapping of field names to [<code class="xref any docutils literal notranslate"><span class="pre">FieldInfo</span></code>][pydantic.fields.FieldInfo] objects.</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.OptionObj.model_fields_set">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">model_fields_set</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#set" title="(in Python v3.12)"><span class="pre">set</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionObj.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.OptionObj.model_json_schema">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">model_json_schema</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">by_alias=True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ref_template='#/$defs/{model}'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">schema_generator=<class</span> <span class="pre">'pydantic.json_schema.GenerateJsonSchema'></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mode='validation'</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionObj.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">
|
||
<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.OptionObj.html#kittycad.models.input_format.OptionObj.type" title="kittycad.models.input_format.OptionObj.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>
|
||
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><a class="reference internal" href="kittycad.models.input_format.OptionObj.html#kittycad.models.input_format.OptionObj.dict" title="kittycad.models.input_format.OptionObj.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.OptionObj.model_parametrized_name">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">model_parametrized_name</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">params</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionObj.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>
|
||
<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.OptionObj.html#kittycad.models.input_format.OptionObj.type" title="kittycad.models.input_format.OptionObj.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>
|
||
<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>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.OptionObj.model_post_init">
|
||
<span class="sig-name descname"><span class="pre">model_post_init</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_BaseModel__context</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionObj.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.OptionObj.html#id0" title="kittycad.models.input_format.OptionObj.__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.OptionObj.html#kittycad.models.input_format.OptionObj.model_construct" title="kittycad.models.input_format.OptionObj.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>
|
||
<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.OptionObj.model_rebuild">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">model_rebuild</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">force</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">raise_errors</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_parent_namespace_depth</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">2</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_types_namespace</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionObj.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">
|
||
<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 internal" href="kittycad.models.input_format.OptionObj.html#kittycad.models.input_format.OptionObj.dict" title="kittycad.models.input_format.OptionObj.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>] | <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>) – 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>
|
||
<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/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/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>
|
||
<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.OptionObj.model_validate">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">model_validate</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">obj</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">strict</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">from_attributes</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">context</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionObj.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">
|
||
<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/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/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>) – 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/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/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>) – 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.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>) – Additional context to pass to the validator.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><strong>ValidationError</strong> – If the object could not be validated.</p>
|
||
</dd>
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><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.OptionObj.model_validate_json">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">model_validate_json</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">json_data</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">strict</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">context</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionObj.model_validate_json" title="Link to this definition"></a></dt>
|
||
<dd><p>Usage docs: <a class="reference external" href="https://docs.pydantic.dev/2.9/concepts/json/#json-parsing">https://docs.pydantic.dev/2.9/concepts/json/#json-parsing</a></p>
|
||
<p>Validate the given JSON data against the Pydantic model.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>json_data</strong> (<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/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/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>) – 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.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>) – Extra variables to pass to the validator.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><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>
|
||
<dd class="field-even"><p><strong>ValidationError</strong> – If <code class="xref any docutils literal notranslate"><span class="pre">json_data</span></code> is not a JSON string or the object could not be validated.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionObj.model_validate_strings">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">model_validate_strings</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">obj</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">strict</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">context</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionObj.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">
|
||
<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/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/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>) – 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.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>) – Extra variables to pass to the validator.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><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.OptionObj.parse_file">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">parse_file</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">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.OptionObj.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>
|
||
<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.OptionObj.parse_obj">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">parse_obj</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">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.OptionObj.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>
|
||
<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.OptionObj.parse_raw">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">parse_raw</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">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.OptionObj.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>
|
||
<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.OptionObj.schema">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">schema</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">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.OptionObj.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>
|
||
<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.OptionObj.schema_json">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">schema_json</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="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.OptionObj.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>
|
||
<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.OptionObj.type">
|
||
<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.OptionObj.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.OptionObj.units">
|
||
<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.OptionObj.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.OptionObj.update_forward_refs">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">update_forward_refs</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="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.OptionObj.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>
|
||
<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.OptionObj.validate">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">validate</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">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.OptionObj.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>
|
||
<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.OptionPly">
|
||
<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">OptionPly</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#OptionPly"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionPly" 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>
|
||
<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>
|
||
<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.OptionPly.__abstractmethods__">
|
||
<span class="sig-name descname"><span class="pre">__abstractmethods__</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">frozenset({})</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionPly.__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.OptionPly.__annotations__">
|
||
<span class="sig-name descname"><span class="pre">__annotations__</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'__class_vars__':</span> <span class="pre">'ClassVar[set[str]]',</span> <span class="pre">'__private_attributes__':</span> <span class="pre">'ClassVar[Dict[str,</span> <span class="pre">ModelPrivateAttr]]',</span> <span class="pre">'__pydantic_complete__':</span> <span class="pre">'ClassVar[bool]',</span> <span class="pre">'__pydantic_core_schema__':</span> <span class="pre">'ClassVar[CoreSchema]',</span> <span class="pre">'__pydantic_custom_init__':</span> <span class="pre">'ClassVar[bool]',</span> <span class="pre">'__pydantic_decorators__':</span> <span class="pre">'ClassVar[_decorators.DecoratorInfos]',</span> <span class="pre">'__pydantic_extra__':</span> <span class="pre">'dict[str,</span> <span class="pre">Any]</span> <span class="pre">|</span> <span class="pre">None',</span> <span class="pre">'__pydantic_fields_set__':</span> <span class="pre">'set[str]',</span> <span class="pre">'__pydantic_generic_metadata__':</span> <span class="pre">'ClassVar[_generics.PydanticGenericMetadata]',</span> <span class="pre">'__pydantic_parent_namespace__':</span> <span class="pre">'ClassVar[Dict[str,</span> <span class="pre">Any]</span> <span class="pre">|</span> <span class="pre">None]',</span> <span class="pre">'__pydantic_post_init__':</span> <span class="pre">"ClassVar[None</span> <span class="pre">|</span> <span class="pre">Literal['model_post_init']]",</span> <span class="pre">'__pydantic_private__':</span> <span class="pre">'dict[str,</span> <span class="pre">Any]</span> <span class="pre">|</span> <span class="pre">None',</span> <span class="pre">'__pydantic_root_model__':</span> <span class="pre">'ClassVar[bool]',</span> <span class="pre">'__pydantic_serializer__':</span> <span class="pre">'ClassVar[SchemaSerializer]',</span> <span class="pre">'__pydantic_validator__':</span> <span class="pre">'ClassVar[SchemaValidator</span> <span class="pre">|</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"><class</span> <span class="pre">'kittycad.models.system.System'>,</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"><enum</span> <span class="pre">'UnitLength'>}</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.OptionPly.__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.OptionPly.__class_getitem__">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">__class_getitem__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">typevar_values</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionPly.__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.OptionPly.html#kittycad.models.input_format.OptionPly.type" title="kittycad.models.input_format.OptionPly.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.OptionPly.__class_vars__">
|
||
<span class="sig-name descname"><span class="pre">__class_vars__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[set[str]]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionPly.__class_vars__" title="Link to this definition"></a></dt>
|
||
<dd><p>The names of the class variables defined on the model.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionPly.__copy__">
|
||
<span class="sig-name descname"><span class="pre">__copy__</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionPly.__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>
|
||
<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.OptionPly.__deepcopy__">
|
||
<span class="sig-name descname"><span class="pre">__deepcopy__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">memo</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionPly.__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>
|
||
<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.OptionPly.__delattr__">
|
||
<span class="sig-name descname"><span class="pre">__delattr__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">item</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionPly.__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>
|
||
<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.OptionPly.__dict__">
|
||
<span class="sig-name descname"><span class="pre">__dict__</span></span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionPly.__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.OptionPly.__eq__">
|
||
<span class="sig-name descname"><span class="pre">__eq__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">other</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionPly.__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>
|
||
<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.OptionPly.__fields_set__">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">__fields_set__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#set" title="(in Python v3.12)"><span class="pre">set</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionPly.__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.OptionPly.__get_pydantic_core_schema__">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">__get_pydantic_core_schema__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">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.OptionPly.__get_pydantic_core_schema__" title="Link to this definition"></a></dt>
|
||
<dd><p>Hook into generating the model’s CoreSchema.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>source</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference internal" href="kittycad.models.input_format.OptionPly.html#kittycad.models.input_format.OptionPly.type" title="kittycad.models.input_format.OptionPly.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 Pydantic’s internal CoreSchema generation logic.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><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 class="xref py py-class docutils literal notranslate"><span class="pre">ModelFieldsSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">ModelSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">DataclassArgsSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">DataclassSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">ArgumentsSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">CallSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">CustomErrorSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">JsonSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">UrlSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">MultiHostUrlSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">DefinitionsSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">DefinitionReferenceSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">UuidSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">ComplexSchema</span></code>]</span></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<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.OptionPly.__get_pydantic_json_schema__">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">__get_pydantic_json_schema__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">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.OptionPly.__get_pydantic_json_schema__" title="Link to this definition"></a></dt>
|
||
<dd><p>Hook into generating the model’s JSON schema.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>core_schema</strong> (<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 class="xref py py-class docutils literal notranslate"><span class="pre">ModelFieldsSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">ModelSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">DataclassArgsSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">DataclassSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">ArgumentsSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">CallSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">CustomErrorSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">JsonSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">UrlSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">MultiHostUrlSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">DefinitionsSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">DefinitionReferenceSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">UuidSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">ComplexSchema</span></code>]</span>) – A <code class="xref any docutils literal notranslate"><span class="pre">pydantic-core</span></code> CoreSchema.
|
||
You can ignore this argument and call the handler with a new CoreSchema,
|
||
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>
|
||
<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 Pydantic’s 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.
|
||
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>
|
||
<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.OptionPly.__getattr__">
|
||
<span class="sig-name descname"><span class="pre">__getattr__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">item</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionPly.__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>
|
||
<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.OptionPly.__getstate__">
|
||
<span class="sig-name descname"><span class="pre">__getstate__</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionPly.__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>
|
||
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><a class="reference internal" href="kittycad.models.input_format.OptionPly.html#kittycad.models.input_format.OptionPly.dict" title="kittycad.models.input_format.OptionPly.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.OptionPly.__hash__">
|
||
<span class="sig-name descname"><span class="pre">__hash__</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionPly.__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.OptionPly.__init__">
|
||
<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">data</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionPly.__init__" title="Link to this definition"></a></dt>
|
||
<dd><p>Create a new model by parsing and validating input data from keyword arguments.</p>
|
||
<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>
|
||
<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.OptionPly.__iter__">
|
||
<span class="sig-name descname"><span class="pre">__iter__</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionPly.__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>
|
||
<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.OptionPly.__module__">
|
||
<span class="sig-name descname"><span class="pre">__module__</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'kittycad.models.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.OptionPly.__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.OptionPly.__pretty__">
|
||
<span class="sig-name descname"><span class="pre">__pretty__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">fmt</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionPly.__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>
|
||
<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.OptionPly.__private_attributes__">
|
||
<span class="sig-name descname"><span class="pre">__private_attributes__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[Dict[str,</span> <span class="pre">ModelPrivateAttr]]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionPly.__private_attributes__" title="Link to this definition"></a></dt>
|
||
<dd><p>Metadata about the private attributes of the model.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionPly.__pydantic_complete__">
|
||
<span class="sig-name descname"><span class="pre">__pydantic_complete__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[bool]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">True</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionPly.__pydantic_complete__" title="Link to this definition"></a></dt>
|
||
<dd><p>Whether model building is completed, or if there are still undefined fields.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionPly.__pydantic_core_schema__">
|
||
<span class="sig-name descname"><span class="pre">__pydantic_core_schema__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[CoreSchema]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'definitions':</span> <span class="pre">[{'cls':</span> <span class="pre"><class</span> <span class="pre">'kittycad.models.axis_direction_pair.AxisDirectionPair'>,</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(<function</span> <span class="pre">modify_model_json_schema>,</span> <span class="pre">cls=<class</span> <span class="pre">'kittycad.models.axis_direction_pair.AxisDirectionPair'>,</span> <span class="pre">title=None),</span> <span class="pre"><bound</span> <span class="pre">method</span> <span class="pre">BaseModel.__get_pydantic_json_schema__</span> <span class="pre">of</span> <span class="pre"><class</span> <span class="pre">'kittycad.models.axis_direction_pair.AxisDirectionPair'>>]},</span> <span class="pre">'ref':</span> <span class="pre">'kittycad.models.axis_direction_pair.AxisDirectionPair:94740976732752',</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">[<function</span> <span class="pre">get_json_schema_update_func.<locals>.json_schema_update_func>],</span> <span class="pre">'pydantic_js_functions':</span> <span class="pre">[]},</span> <span class="pre">'schema':</span> <span class="pre">{'schema_ref':</span> <span class="pre">'kittycad.models.axis.Axis:94740976727632',</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">[<function</span> <span class="pre">get_json_schema_update_func.<locals>.json_schema_update_func>],</span> <span class="pre">'pydantic_js_functions':</span> <span class="pre">[]},</span> <span class="pre">'schema':</span> <span class="pre">{'schema_ref':</span> <span class="pre">'kittycad.models.direction.Direction:94740976730192',</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"><enum</span> <span class="pre">'Axis'>,</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">[<function</span> <span class="pre">GenerateSchema._enum_schema.<locals>.get_json_schema>]},</span> <span class="pre">'ref':</span> <span class="pre">'kittycad.models.axis.Axis:94740976727632',</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"><enum</span> <span class="pre">'Direction'>,</span> <span class="pre">'members':</span> <span class="pre">[Direction.POSITIVE,</span> <span class="pre">Direction.NEGATIVE],</span> <span class="pre">'metadata':</span> <span class="pre">{'pydantic_js_functions':</span> <span class="pre">[<function</span> <span class="pre">GenerateSchema._enum_schema.<locals>.get_json_schema>]},</span> <span class="pre">'ref':</span> <span class="pre">'kittycad.models.direction.Direction:94740976730192',</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">'schema':</span> <span class="pre">{'cls':</span> <span class="pre"><class</span> <span class="pre">'kittycad.models.input_format.OptionPly'>,</span> <span class="pre">'config':</span> <span class="pre">{'title':</span> <span class="pre">'OptionPly'},</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(<function</span> <span class="pre">modify_model_json_schema>,</span> <span class="pre">cls=<class</span> <span class="pre">'kittycad.models.input_format.OptionPly'>,</span> <span class="pre">title=None),</span> <span class="pre"><bound</span> <span class="pre">method</span> <span class="pre">BaseModel.__get_pydantic_json_schema__</span> <span class="pre">of</span> <span class="pre"><class</span> <span class="pre">'kittycad.models.input_format.OptionPly'>>]},</span> <span class="pre">'ref':</span> <span class="pre">'kittycad.models.input_format.OptionPly:94740972920320',</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">{'coords':</span> <span class="pre">{'metadata':</span> <span class="pre">{'pydantic_js_annotation_functions':</span> <span class="pre">[<function</span> <span class="pre">get_json_schema_update_func.<locals>.json_schema_update_func>],</span> <span class="pre">'pydantic_js_functions':</span> <span class="pre">[]},</span> <span class="pre">'schema':</span> <span class="pre">{'cls':</span> <span class="pre"><class</span> <span class="pre">'kittycad.models.system.System'>,</span> <span class="pre">'config':</span> <span class="pre">{'title':</span> <span class="pre">'System'},</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(<function</span> <span class="pre">modify_model_json_schema>,</span> <span class="pre">cls=<class</span> <span class="pre">'kittycad.models.system.System'>,</span> <span class="pre">title=None),</span> <span class="pre"><bound</span> <span class="pre">method</span> <span class="pre">BaseModel.__get_pydantic_json_schema__</span> <span class="pre">of</span> <span class="pre"><class</span> <span class="pre">'kittycad.models.system.System'>>]},</span> <span class="pre">'ref':</span> <span class="pre">'kittycad.models.system.System:94740976742480',</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">{'forward':</span> <span class="pre">{'metadata':</span> <span class="pre">{'pydantic_js_annotation_functions':</span> <span class="pre">[<function</span> <span class="pre">get_json_schema_update_func.<locals>.json_schema_update_func>],</span> <span class="pre">'pydantic_js_functions':</span> <span class="pre">[]},</span> <span class="pre">'schema':</span> <span class="pre">{'schema_ref':</span> <span class="pre">'kittycad.models.axis_direction_pair.AxisDirectionPair:94740976732752',</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">'up':</span> <span class="pre">{'metadata':</span> <span class="pre">{'pydantic_js_annotation_functions':</span> <span class="pre">[<function</span> <span class="pre">get_json_schema_update_func.<locals>.json_schema_update_func>],</span> <span class="pre">'pydantic_js_functions':</span> <span class="pre">[]},</span> <span class="pre">'schema':</span> <span class="pre">{'schema_ref':</span> <span class="pre">'kittycad.models.axis_direction_pair.AxisDirectionPair:94740976732752',</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">'System',</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">'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">[<function</span> <span class="pre">get_json_schema_update_func.<locals>.json_schema_update_func>],</span> <span class="pre">'pydantic_js_functions':</span> <span class="pre">[]},</span> <span class="pre">'schema':</span> <span class="pre">{'default':</span> <span class="pre">'ply',</span> <span class="pre">'schema':</span> <span class="pre">{'expected':</span> <span class="pre">['ply'],</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">'units':</span> <span class="pre">{'metadata':</span> <span class="pre">{'pydantic_js_annotation_functions':</span> <span class="pre">[<function</span> <span class="pre">get_json_schema_update_func.<locals>.json_schema_update_func>],</span> <span class="pre">'pydantic_js_functions':</span> <span class="pre">[]},</span> <span class="pre">'schema':</span> <span class="pre">{'cls':</span> <span class="pre"><enum</span> <span class="pre">'UnitLength'>,</span> <span class="pre">'members':</span> <span class="pre">[UnitLength.CM,</span> <span class="pre">UnitLength.FT,</span> <span class="pre">UnitLength.IN,</span> <span class="pre">UnitLength.M,</span> <span class="pre">UnitLength.MM,</span> <span class="pre">UnitLength.YD],</span> <span class="pre">'metadata':</span> <span class="pre">{'pydantic_js_functions':</span> <span class="pre">[<function</span> <span class="pre">GenerateSchema._enum_schema.<locals>.get_json_schema>]},</span> <span class="pre">'ref':</span> <span class="pre">'kittycad.models.unit_length.UnitLength:94740972900288',</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">'type':</span> <span class="pre">'model-field'}},</span> <span class="pre">'model_name':</span> <span class="pre">'OptionPly',</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">'type':</span> <span class="pre">'definitions'}</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.OptionPly.__pydantic_core_schema__" title="Link to this definition"></a></dt>
|
||
<dd><p>The core schema of the model.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionPly.__pydantic_custom_init__">
|
||
<span class="sig-name descname"><span class="pre">__pydantic_custom_init__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[bool]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">False</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionPly.__pydantic_custom_init__" title="Link to this definition"></a></dt>
|
||
<dd><p>Whether the model has a custom <a class="reference internal" href="kittycad.models.input_format.OptionPly.html#id0" title="kittycad.models.input_format.OptionPly.__init__"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">__init__</span></code></a> method.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionPly.__pydantic_decorators__">
|
||
<span class="sig-name descname"><span class="pre">__pydantic_decorators__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[_decorators.DecoratorInfos]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">DecoratorInfos(validators={},</span> <span class="pre">field_validators={},</span> <span class="pre">root_validators={},</span> <span class="pre">field_serializers={},</span> <span class="pre">model_serializers={},</span> <span class="pre">model_validators={},</span> <span class="pre">computed_fields={})</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionPly.__pydantic_decorators__" title="Link to this definition"></a></dt>
|
||
<dd><p>Metadata containing the decorators defined on the model.
|
||
This replaces <code class="xref any docutils literal notranslate"><span class="pre">Model.__validators__</span></code> and <code class="xref any docutils literal notranslate"><span class="pre">Model.__root_validators__</span></code> from Pydantic V1.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionPly.__pydantic_extra__">
|
||
<span class="sig-name descname"><span class="pre">__pydantic_extra__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">dict[str,</span> <span class="pre">Any]</span> <span class="pre">|</span> <span class="pre">None</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionPly.__pydantic_extra__" title="Link to this definition"></a></dt>
|
||
<dd><p>A dictionary containing extra values, if [<a class="reference internal" href="kittycad.models.kcl_code_completion_request.KclCodeCompletionRequest.html#kittycad.models.kcl_code_completion_request.KclCodeCompletionRequest.extra" title="kittycad.models.kcl_code_completion_request.KclCodeCompletionRequest.extra"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">extra</span></code></a>][pydantic.config.ConfigDict.extra] is set to <code class="xref any docutils literal notranslate"><span class="pre">'allow'</span></code>.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionPly.__pydantic_fields_set__">
|
||
<span class="sig-name descname"><span class="pre">__pydantic_fields_set__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">set[str]</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionPly.__pydantic_fields_set__" title="Link to this definition"></a></dt>
|
||
<dd><p>The names of fields explicitly set during instantiation.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionPly.__pydantic_generic_metadata__">
|
||
<span class="sig-name descname"><span class="pre">__pydantic_generic_metadata__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[_generics.PydanticGenericMetadata]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'args':</span> <span class="pre">(),</span> <span class="pre">'origin':</span> <span class="pre">None,</span> <span class="pre">'parameters':</span> <span class="pre">()}</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionPly.__pydantic_generic_metadata__" title="Link to this definition"></a></dt>
|
||
<dd><p>Metadata for generic models; contains data used for a similar purpose to
|
||
__args__, __origin__, __parameters__ in typing-module generics. May eventually be replaced by these.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionPly.__pydantic_init_subclass__">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">__pydantic_init_subclass__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionPly.__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.OptionPly.html#kittycad.models.input_format.OptionPly.model_fields" title="kittycad.models.input_format.OptionPly.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>
|
||
<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 aren’t used internally by pydantic.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>**kwargs</strong> (<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 aren’t used internally
|
||
by pydantic.</p>
|
||
</dd>
|
||
<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/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.OptionPly.__pydantic_parent_namespace__">
|
||
<span class="sig-name descname"><span class="pre">__pydantic_parent_namespace__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[Dict[str,</span> <span class="pre">Any]</span> <span class="pre">|</span> <span class="pre">None]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">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.OptionPly.__pydantic_parent_namespace__" title="Link to this definition"></a></dt>
|
||
<dd><p>Parent namespace of the model, used for automatic rebuilding of models.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionPly.__pydantic_post_init__">
|
||
<span class="sig-name descname"><span class="pre">__pydantic_post_init__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[None</span> <span class="pre">|</span> <span class="pre">Literal['model_post_init']]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionPly.__pydantic_post_init__" title="Link to this definition"></a></dt>
|
||
<dd><p>The name of the post-init method for the model, if defined.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionPly.__pydantic_private__">
|
||
<span class="sig-name descname"><span class="pre">__pydantic_private__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">dict[str,</span> <span class="pre">Any]</span> <span class="pre">|</span> <span class="pre">None</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionPly.__pydantic_private__" title="Link to this definition"></a></dt>
|
||
<dd><p>Values of private attributes set on the model instance.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionPly.__pydantic_root_model__">
|
||
<span class="sig-name descname"><span class="pre">__pydantic_root_model__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[bool]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">False</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionPly.__pydantic_root_model__" title="Link to this definition"></a></dt>
|
||
<dd><p>Whether the model is a [<code class="xref any docutils literal notranslate"><span class="pre">RootModel</span></code>][pydantic.root_model.RootModel].</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionPly.__pydantic_serializer__">
|
||
<span class="sig-name descname"><span class="pre">__pydantic_serializer__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[SchemaSerializer]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">SchemaSerializer(serializer=Model(</span>     <span class="pre">ModelSerializer</span> <span class="pre">{</span>         <span class="pre">class:</span> <span class="pre">Py(</span>             <span class="pre">0x0000562a9a095e00,</span>         <span class="pre">),</span>         <span class="pre">serializer:</span> <span class="pre">Fields(</span>             <span class="pre">GeneralFieldsSerializer</span> <span class="pre">{</span>                 <span class="pre">fields:</span> <span class="pre">{</span>                     <span class="pre">"units":</span> <span class="pre">SerField</span> <span class="pre">{</span>                         <span class="pre">key_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007f936e37aa30,</span>                         <span class="pre">),</span>                         <span class="pre">alias:</span> <span class="pre">None,</span>                         <span class="pre">alias_py:</span> <span class="pre">None,</span>                         <span class="pre">serializer:</span> <span class="pre">Some(</span>                             <span class="pre">Enum(</span>                                 <span class="pre">EnumSerializer</span> <span class="pre">{</span>                                     <span class="pre">class:</span> <span class="pre">Py(</span>                                         <span class="pre">0x0000562a9a090fc0,</span>                                     <span class="pre">),</span>                                     <span class="pre">serializer:</span> <span class="pre">Some(</span>                                         <span class="pre">Str(</span>                                             <span class="pre">StrSerializer,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                 <span class="pre">},</span>                             <span class="pre">),</span>                         <span class="pre">),</span>                         <span class="pre">required:</span> <span class="pre">true,</span>                     <span class="pre">},</span>                     <span class="pre">"coords":</span> <span class="pre">SerField</span> <span class="pre">{</span>                         <span class="pre">key_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007f936b87a2e0,</span>                         <span class="pre">),</span>                         <span class="pre">alias:</span> <span class="pre">None,</span>                         <span class="pre">alias_py:</span> <span class="pre">None,</span>                         <span class="pre">serializer:</span> <span class="pre">Some(</span>                             <span class="pre">Model(</span>                                 <span class="pre">ModelSerializer</span> <span class="pre">{</span>                                     <span class="pre">class:</span> <span class="pre">Py(</span>                                         <span class="pre">0x0000562a9a43b050,</span>                                     <span class="pre">),</span>                                     <span class="pre">serializer:</span> <span class="pre">Fields(</span>                                         <span class="pre">GeneralFieldsSerializer</span> <span class="pre">{</span>                                             <span class="pre">fields:</span> <span class="pre">{</span>                                                 <span class="pre">"forward":</span> <span class="pre">SerField</span> <span class="pre">{</span>                                                     <span class="pre">key_py:</span> <span class="pre">Py(</span>                                                         <span class="pre">0x00007f936b879b00,</span>                                                     <span class="pre">),</span>                                                     <span class="pre">alias:</span> <span class="pre">None,</span>                                                     <span class="pre">alias_py:</span> <span class="pre">None,</span>                                                     <span class="pre">serializer:</span> <span class="pre">Some(</span>                                                         <span class="pre">Recursive(</span>                                                             <span class="pre">DefinitionRefSerializer</span> <span class="pre">{</span>                                                                 <span class="pre">definition:</span> <span class="pre">"...",</span>                                                                 <span class="pre">retry_with_lax_check:</span> <span class="pre">true,</span>                                                             <span class="pre">},</span>                                                         <span class="pre">),</span>                                                     <span class="pre">),</span>                                                     <span class="pre">required:</span> <span class="pre">true,</span>                                                 <span class="pre">},</span>                                                 <span class="pre">"up":</span> <span class="pre">SerField</span> <span class="pre">{</span>                                                     <span class="pre">key_py:</span> <span class="pre">Py(</span>                                                         <span class="pre">0x00007f936e3777e0,</span>                                                     <span class="pre">),</span>                                                     <span class="pre">alias:</span> <span class="pre">None,</span>                                                     <span class="pre">alias_py:</span> <span class="pre">None,</span>                                                     <span class="pre">serializer:</span> <span class="pre">Some(</span>                                                         <span class="pre">Recursive(</span>                                                             <span class="pre">DefinitionRefSerializer</span> <span class="pre">{</span>                                                                 <span class="pre">definition:</span> <span class="pre">"...",</span>                                                                 <span class="pre">retry_with_lax_check:</span> <span class="pre">true,</span>                                                             <span class="pre">},</span>                                                         <span class="pre">),</span>                                                     <span class="pre">),</span>                                                     <span class="pre">required:</span> <span class="pre">true,</span>                                                 <span class="pre">},</span>                                             <span class="pre">},</span>                                             <span class="pre">computed_fields:</span> <span class="pre">Some(</span>                                                 <span class="pre">ComputedFields(</span>                                                     <span class="pre">[],</span>                                                 <span class="pre">),</span>                                             <span class="pre">),</span>                                             <span class="pre">mode:</span> <span class="pre">SimpleDict,</span>                                             <span class="pre">extra_serializer:</span> <span class="pre">None,</span>                                             <span class="pre">filter:</span> <span class="pre">SchemaFilter</span> <span class="pre">{</span>                                                 <span class="pre">include:</span> <span class="pre">None,</span>                                                 <span class="pre">exclude:</span> <span class="pre">None,</span>                                             <span class="pre">},</span>                                             <span class="pre">required_fields:</span> <span class="pre">2,</span>                                         <span class="pre">},</span>                                     <span class="pre">),</span>                                     <span class="pre">has_extra:</span> <span class="pre">false,</span>                                     <span class="pre">root_model:</span> <span class="pre">false,</span>                                     <span class="pre">name:</span> <span class="pre">"System",</span>                                 <span class="pre">},</span>                             <span class="pre">),</span>                         <span class="pre">),</span>                         <span class="pre">required:</span> <span class="pre">true,</span>                     <span class="pre">},</span>                     <span class="pre">"type":</span> <span class="pre">SerField</span> <span class="pre">{</span>                         <span class="pre">key_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007f936f623938,</span>                         <span class="pre">),</span>                         <span class="pre">alias:</span> <span class="pre">None,</span>                         <span class="pre">alias_py:</span> <span class="pre">None,</span>                         <span class="pre">serializer:</span> <span class="pre">Some(</span>                             <span class="pre">WithDefault(</span>                                 <span class="pre">WithDefaultSerializer</span> <span class="pre">{</span>                                     <span class="pre">default:</span> <span class="pre">Default(</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007f936b879bc0,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                     <span class="pre">serializer:</span> <span class="pre">Literal(</span>                                         <span class="pre">LiteralSerializer</span> <span class="pre">{</span>                                             <span class="pre">expected_int:</span> <span class="pre">{},</span>                                             <span class="pre">expected_str:</span> <span class="pre">{</span>                                                 <span class="pre">"ply",</span>                                             <span class="pre">},</span>                                             <span class="pre">expected_py:</span> <span class="pre">None,</span>                                             <span class="pre">name:</span> <span class="pre">"literal['ply']",</span>                                         <span class="pre">},</span>                                     <span class="pre">),</span>                                 <span class="pre">},</span>                             <span class="pre">),</span>                         <span class="pre">),</span>                         <span class="pre">required:</span> <span class="pre">true,</span>                     <span class="pre">},</span>                 <span class="pre">},</span>                 <span class="pre">computed_fields:</span> <span class="pre">Some(</span>                     <span class="pre">ComputedFields(</span>                         <span class="pre">[],</span>                     <span class="pre">),</span>                 <span class="pre">),</span>                 <span class="pre">mode:</span> <span class="pre">SimpleDict,</span>                 <span class="pre">extra_serializer:</span> <span class="pre">None,</span>                 <span class="pre">filter:</span> <span class="pre">SchemaFilter</span> <span class="pre">{</span>                     <span class="pre">include:</span> <span class="pre">None,</span>                     <span class="pre">exclude:</span> <span class="pre">None,</span>                 <span class="pre">},</span>                 <span class="pre">required_fields:</span> <span class="pre">3,</span>             <span class="pre">},</span>         <span class="pre">),</span>         <span class="pre">has_extra:</span> <span class="pre">false,</span>         <span class="pre">root_model:</span> <span class="pre">false,</span>         <span class="pre">name:</span> <span class="pre">"OptionPly",</span>     <span class="pre">},</span> <span class="pre">),</span> <span class="pre">definitions=[Enum(EnumSerializer</span> <span class="pre">{</span> <span class="pre">class:</span> <span class="pre">Py(0x562a9a437650),</span> <span class="pre">serializer:</span> <span class="pre">Some(Str(StrSerializer))</span> <span class="pre">}),</span> <span class="pre">Model(ModelSerializer</span> <span class="pre">{</span> <span class="pre">class:</span> <span class="pre">Py(0x562a9a438a50),</span> <span class="pre">serializer:</span> <span class="pre">Fields(GeneralFieldsSerializer</span> <span class="pre">{</span> <span class="pre">fields:</span> <span class="pre">{"axis":</span> <span class="pre">SerField</span> <span class="pre">{</span> <span class="pre">key_py:</span> <span class="pre">Py(0x7f936bc3a310),</span> <span class="pre">alias:</span> <span class="pre">None,</span> <span class="pre">alias_py:</span> <span class="pre">None,</span> <span class="pre">serializer:</span> <span class="pre">Some(Recursive(DefinitionRefSerializer</span> <span class="pre">{</span> <span class="pre">definition:</span> <span class="pre">"...",</span> <span class="pre">retry_with_lax_check:</span> <span class="pre">false</span> <span class="pre">})),</span> <span class="pre">required:</span> <span class="pre">true</span> <span class="pre">},</span> <span class="pre">"direction":</span> <span class="pre">SerField</span> <span class="pre">{</span> <span class="pre">key_py:</span> <span class="pre">Py(0x7f936e0debf0),</span> <span class="pre">alias:</span> <span class="pre">None,</span> <span class="pre">alias_py:</span> <span class="pre">None,</span> <span class="pre">serializer:</span> <span class="pre">Some(Recursive(DefinitionRefSerializer</span> <span class="pre">{</span> <span class="pre">definition:</span> <span class="pre">"...",</span> <span class="pre">retry_with_lax_check:</span> <span class="pre">false</span> <span class="pre">})),</span> <span class="pre">required:</span> <span class="pre">true</span> <span class="pre">}},</span> <span class="pre">computed_fields:</span> <span class="pre">Some(ComputedFields([])),</span> <span class="pre">mode:</span> <span class="pre">SimpleDict,</span> <span class="pre">extra_serializer:</span> <span class="pre">None,</span> <span class="pre">filter:</span> <span class="pre">SchemaFilter</span> <span class="pre">{</span> <span class="pre">include:</span> <span class="pre">None,</span> <span class="pre">exclude:</span> <span class="pre">None</span> <span class="pre">},</span> <span class="pre">required_fields:</span> <span class="pre">2</span> <span class="pre">}),</span> <span class="pre">has_extra:</span> <span class="pre">false,</span> <span class="pre">root_model:</span> <span class="pre">false,</span> <span class="pre">name:</span> <span class="pre">"AxisDirectionPair"</span> <span class="pre">}),</span> <span class="pre">Enum(EnumSerializer</span> <span class="pre">{</span> <span class="pre">class:</span> <span class="pre">Py(0x562a9a438050),</span> <span class="pre">serializer:</span> <span class="pre">Some(Str(StrSerializer))</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.OptionPly.__pydantic_serializer__" title="Link to this definition"></a></dt>
|
||
<dd><p>The <code class="xref any docutils literal notranslate"><span class="pre">pydantic-core</span></code> <code class="xref any docutils literal notranslate"><span class="pre">SchemaSerializer</span></code> used to dump instances of the model.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionPly.__pydantic_validator__">
|
||
<span class="sig-name descname"><span class="pre">__pydantic_validator__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[SchemaValidator</span> <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="OptionPly",</span> <span class="pre">validator=Model(</span>     <span class="pre">ModelValidator</span> <span class="pre">{</span>         <span class="pre">revalidate:</span> <span class="pre">Never,</span>         <span class="pre">validator:</span> <span class="pre">ModelFields(</span>             <span class="pre">ModelFieldsValidator</span> <span class="pre">{</span>                 <span class="pre">fields:</span> <span class="pre">[</span>                     <span class="pre">Field</span> <span class="pre">{</span>                         <span class="pre">name:</span> <span class="pre">"coords",</span>                         <span class="pre">lookup_key:</span> <span class="pre">Simple</span> <span class="pre">{</span>                             <span class="pre">key:</span> <span class="pre">"coords",</span>                             <span class="pre">py_key:</span> <span class="pre">Py(</span>                                 <span class="pre">0x00007f936b87b9f0,</span>                             <span class="pre">),</span>                             <span class="pre">path:</span> <span class="pre">LookupPath(</span>                                 <span class="pre">[</span>                                     <span class="pre">S(</span>                                         <span class="pre">"coords",</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007f936b87ba20,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                 <span class="pre">],</span>                             <span class="pre">),</span>                         <span class="pre">},</span>                         <span class="pre">name_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007f936b87a2e0,</span>                         <span class="pre">),</span>                         <span class="pre">validator:</span> <span class="pre">Model(</span>                             <span class="pre">ModelValidator</span> <span class="pre">{</span>                                 <span class="pre">revalidate:</span> <span class="pre">Never,</span>                                 <span class="pre">validator:</span> <span class="pre">ModelFields(</span>                                     <span class="pre">ModelFieldsValidator</span> <span class="pre">{</span>                                         <span class="pre">fields:</span> <span class="pre">[</span>                                             <span class="pre">Field</span> <span class="pre">{</span>                                                 <span class="pre">name:</span> <span class="pre">"forward",</span>                                                 <span class="pre">lookup_key:</span> <span class="pre">Simple</span> <span class="pre">{</span>                                                     <span class="pre">key:</span> <span class="pre">"forward",</span>                                                     <span class="pre">py_key:</span> <span class="pre">Py(</span>                                                         <span class="pre">0x00007f936b87b930,</span>                                                     <span class="pre">),</span>                                                     <span class="pre">path:</span> <span class="pre">LookupPath(</span>                                                         <span class="pre">[</span>                                                             <span class="pre">S(</span>                                                                 <span class="pre">"forward",</span>                                                                 <span class="pre">Py(</span>                                                                     <span class="pre">0x00007f936b87b960,</span>                                                                 <span class="pre">),</span>                                                             <span class="pre">),</span>                                                         <span class="pre">],</span>                                                     <span class="pre">),</span>                                                 <span class="pre">},</span>                                                 <span class="pre">name_py:</span> <span class="pre">Py(</span>                                                     <span class="pre">0x00007f936b879b00,</span>                                                 <span class="pre">),</span>                                                 <span class="pre">validator:</span> <span class="pre">DefinitionRef(</span>                                                     <span class="pre">DefinitionRefValidator</span> <span class="pre">{</span>                                                         <span class="pre">definition:</span> <span class="pre">"...",</span>                                                     <span class="pre">},</span>                                                 <span class="pre">),</span>                                                 <span class="pre">frozen:</span> <span class="pre">false,</span>                                             <span class="pre">},</span>                                             <span class="pre">Field</span> <span class="pre">{</span>                                                 <span class="pre">name:</span> <span class="pre">"up",</span>                                                 <span class="pre">lookup_key:</span> <span class="pre">Simple</span> <span class="pre">{</span>                                                     <span class="pre">key:</span> <span class="pre">"up",</span>                                                     <span class="pre">py_key:</span> <span class="pre">Py(</span>                                                         <span class="pre">0x00007f936b87b990,</span>                                                     <span class="pre">),</span>                                                     <span class="pre">path:</span> <span class="pre">LookupPath(</span>                                                         <span class="pre">[</span>                                                             <span class="pre">S(</span>                                                                 <span class="pre">"up",</span>                                                                 <span class="pre">Py(</span>                                                                     <span class="pre">0x00007f936b87b9c0,</span>                                                                 <span class="pre">),</span>                                                             <span class="pre">),</span>                                                         <span class="pre">],</span>                                                     <span class="pre">),</span>                                                 <span class="pre">},</span>                                                 <span class="pre">name_py:</span> <span class="pre">Py(</span>                                                     <span class="pre">0x00007f936e3777e0,</span>                                                 <span class="pre">),</span>                                                 <span class="pre">validator:</span> <span class="pre">DefinitionRef(</span>                                                     <span class="pre">DefinitionRefValidator</span> <span class="pre">{</span>                                                         <span class="pre">definition:</span> <span class="pre">"...",</span>                                                     <span class="pre">},</span>                                                 <span class="pre">),</span>                                                 <span class="pre">frozen:</span> <span class="pre">false,</span>                                             <span class="pre">},</span>                                         <span class="pre">],</span>                                         <span class="pre">model_name:</span> <span class="pre">"System",</span>                                         <span class="pre">extra_behavior:</span> <span class="pre">Ignore,</span>                                         <span class="pre">extras_validator:</span> <span class="pre">None,</span>                                         <span class="pre">strict:</span> <span class="pre">false,</span>                                         <span class="pre">from_attributes:</span> <span class="pre">false,</span>                                         <span class="pre">loc_by_alias:</span> <span class="pre">true,</span>                                     <span class="pre">},</span>                                 <span class="pre">),</span>                                 <span class="pre">class:</span> <span class="pre">Py(</span>                                     <span class="pre">0x0000562a9a43b050,</span>                                 <span class="pre">),</span>                                 <span class="pre">post_init:</span> <span class="pre">None,</span>                                 <span class="pre">frozen:</span> <span class="pre">false,</span>                                 <span class="pre">custom_init:</span> <span class="pre">false,</span>                                 <span class="pre">root_model:</span> <span class="pre">false,</span>                                 <span class="pre">undefined:</span> <span class="pre">Py(</span>                                     <span class="pre">0x00007f936d406320,</span>                                 <span class="pre">),</span>                                 <span class="pre">name:</span> <span class="pre">"System",</span>                             <span class="pre">},</span>                         <span class="pre">),</span>                         <span class="pre">frozen:</span> <span class="pre">false,</span>                     <span class="pre">},</span>                     <span class="pre">Field</span> <span class="pre">{</span>                         <span class="pre">name:</span> <span class="pre">"type",</span>                         <span class="pre">lookup_key:</span> <span class="pre">Simple</span> <span class="pre">{</span>                             <span class="pre">key:</span> <span class="pre">"type",</span>                             <span class="pre">py_key:</span> <span class="pre">Py(</span>                                 <span class="pre">0x00007f936b87ba50,</span>                             <span class="pre">),</span>                             <span class="pre">path:</span> <span class="pre">LookupPath(</span>                                 <span class="pre">[</span>                                     <span class="pre">S(</span>                                         <span class="pre">"type",</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007f936b87ba80,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                 <span class="pre">],</span>                             <span class="pre">),</span>                         <span class="pre">},</span>                         <span class="pre">name_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007f936f623938,</span>                         <span class="pre">),</span>                         <span class="pre">validator:</span> <span class="pre">WithDefault(</span>                             <span class="pre">WithDefaultValidator</span> <span class="pre">{</span>                                 <span class="pre">default:</span> <span class="pre">Default(</span>                                     <span class="pre">Py(</span>                                         <span class="pre">0x00007f936b879bc0,</span>                                     <span class="pre">),</span>                                 <span class="pre">),</span>                                 <span class="pre">on_error:</span> <span class="pre">Raise,</span>                                 <span class="pre">validator:</span> <span class="pre">Literal(</span>                                     <span class="pre">LiteralValidator</span> <span class="pre">{</span>                                         <span class="pre">lookup:</span> <span class="pre">LiteralLookup</span> <span class="pre">{</span>                                             <span class="pre">expected_bool:</span> <span class="pre">None,</span>                                             <span class="pre">expected_int:</span> <span class="pre">None,</span>                                             <span class="pre">expected_str:</span> <span class="pre">Some(</span>                                                 <span class="pre">{</span>                                                     <span class="pre">"ply":</span> <span class="pre">0,</span>                                                 <span class="pre">},</span>                                             <span class="pre">),</span>                                             <span class="pre">expected_py_dict:</span> <span class="pre">None,</span>                                             <span class="pre">expected_py_values:</span> <span class="pre">None,</span>                                             <span class="pre">values:</span> <span class="pre">[</span>                                                 <span class="pre">Py(</span>                                                     <span class="pre">0x00007f936b879bc0,</span>                                                 <span class="pre">),</span>                                             <span class="pre">],</span>                                         <span class="pre">},</span>                                         <span class="pre">expected_repr:</span> <span class="pre">"'ply'",</span>                                         <span class="pre">name:</span> <span class="pre">"literal['ply']",</span>                                     <span class="pre">},</span>                                 <span class="pre">),</span>                                 <span class="pre">validate_default:</span> <span class="pre">false,</span>                                 <span class="pre">copy_default:</span> <span class="pre">false,</span>                                 <span class="pre">name:</span> <span class="pre">"default[literal['ply']]",</span>                                 <span class="pre">undefined:</span> <span class="pre">Py(</span>                                     <span class="pre">0x00007f936d406320,</span>                                 <span class="pre">),</span>                             <span class="pre">},</span>                         <span class="pre">),</span>                         <span class="pre">frozen:</span> <span class="pre">false,</span>                     <span class="pre">},</span>                     <span class="pre">Field</span> <span class="pre">{</span>                         <span class="pre">name:</span> <span class="pre">"units",</span>                         <span class="pre">lookup_key:</span> <span class="pre">Simple</span> <span class="pre">{</span>                             <span class="pre">key:</span> <span class="pre">"units",</span>                             <span class="pre">py_key:</span> <span class="pre">Py(</span>                                 <span class="pre">0x00007f936b87bab0,</span>                             <span class="pre">),</span>                             <span class="pre">path:</span> <span class="pre">LookupPath(</span>                                 <span class="pre">[</span>                                     <span class="pre">S(</span>                                         <span class="pre">"units",</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007f936b87bae0,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                 <span class="pre">],</span>                             <span class="pre">),</span>                         <span class="pre">},</span>                         <span class="pre">name_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007f936e37aa30,</span>                         <span class="pre">),</span>                         <span class="pre">validator:</span> <span class="pre">StrEnum(</span>                             <span class="pre">EnumValidator</span> <span class="pre">{</span>                                 <span class="pre">phantom:</span> <span class="pre">PhantomData<_pydantic_core::validators::enum_::StrEnumValidator>,</span>                                 <span class="pre">class:</span> <span class="pre">Py(</span>                                     <span class="pre">0x0000562a9a090fc0,</span>                                 <span class="pre">),</span>                                 <span class="pre">lookup:</span> <span class="pre">LiteralLookup</span> <span class="pre">{</span>                                     <span class="pre">expected_bool:</span> <span class="pre">None,</span>                                     <span class="pre">expected_int:</span> <span class="pre">None,</span>                                     <span class="pre">expected_str:</span> <span class="pre">Some(</span>                                         <span class="pre">{</span>                                             <span class="pre">"cm":</span> <span class="pre">0,</span>                                             <span class="pre">"yd":</span> <span class="pre">5,</span>                                             <span class="pre">"ft":</span> <span class="pre">1,</span>                                             <span class="pre">"m":</span> <span class="pre">3,</span>                                             <span class="pre">"in":</span> <span class="pre">2,</span>                                             <span class="pre">"mm":</span> <span class="pre">4,</span>                                         <span class="pre">},</span>                                     <span class="pre">),</span>                                     <span class="pre">expected_py_dict:</span> <span class="pre">None,</span>                                     <span class="pre">expected_py_values:</span> <span class="pre">None,</span>                                     <span class="pre">values:</span> <span class="pre">[</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007f936aeac890,</span>                                         <span class="pre">),</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007f936aeace30,</span>                                         <span class="pre">),</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007f936aeacef0,</span>                                         <span class="pre">),</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007f936aeacf50,</span>                                         <span class="pre">),</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007f936aeacfb0,</span>                                         <span class="pre">),</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007f936aead010,</span>                                         <span class="pre">),</span>                                     <span class="pre">],</span>                                 <span class="pre">},</span>                                 <span class="pre">missing:</span> <span class="pre">None,</span>                                 <span class="pre">expected_repr:</span> <span class="pre">"'cm',</span> <span class="pre">'ft',</span> <span class="pre">'in',</span> <span class="pre">'m',</span> <span class="pre">'mm'</span> <span class="pre">or</span> <span class="pre">'yd'",</span>                                 <span class="pre">strict:</span> <span class="pre">false,</span>                                 <span class="pre">class_repr:</span> <span class="pre">"UnitLength",</span>                                 <span class="pre">name:</span> <span class="pre">"str-enum[UnitLength]",</span>                             <span class="pre">},</span>                         <span class="pre">),</span>                         <span class="pre">frozen:</span> <span class="pre">false,</span>                     <span class="pre">},</span>                 <span class="pre">],</span>                 <span class="pre">model_name:</span> <span class="pre">"OptionPly",</span>                 <span class="pre">extra_behavior:</span> <span class="pre">Ignore,</span>                 <span class="pre">extras_validator:</span> <span class="pre">None,</span>                 <span class="pre">strict:</span> <span class="pre">false,</span>                 <span class="pre">from_attributes:</span> <span class="pre">false,</span>                 <span class="pre">loc_by_alias:</span> <span class="pre">true,</span>             <span class="pre">},</span>         <span class="pre">),</span>         <span class="pre">class:</span> <span class="pre">Py(</span>             <span class="pre">0x0000562a9a095e00,</span>         <span class="pre">),</span>         <span class="pre">post_init:</span> <span class="pre">None,</span>         <span class="pre">frozen:</span> <span class="pre">false,</span>         <span class="pre">custom_init:</span> <span class="pre">false,</span>         <span class="pre">root_model:</span> <span class="pre">false,</span>         <span class="pre">undefined:</span> <span class="pre">Py(</span>             <span class="pre">0x00007f936d406320,</span>         <span class="pre">),</span>         <span class="pre">name:</span> <span class="pre">"OptionPly",</span>     <span class="pre">},</span> <span class="pre">),</span> <span class="pre">definitions=[StrEnum(EnumValidator</span> <span class="pre">{</span> <span class="pre">phantom:</span> <span class="pre">PhantomData<_pydantic_core::validators::enum_::StrEnumValidator>,</span> <span class="pre">class:</span> <span class="pre">Py(0x562a9a437650),</span> <span class="pre">lookup:</span> <span class="pre">LiteralLookup</span> <span class="pre">{</span> <span class="pre">expected_bool:</span> <span class="pre">None,</span> <span class="pre">expected_int:</span> <span class="pre">None,</span> <span class="pre">expected_str:</span> <span class="pre">Some({"y":</span> <span class="pre">0,</span> <span class="pre">"z":</span> <span class="pre">1}),</span> <span class="pre">expected_py_dict:</span> <span class="pre">None,</span> <span class="pre">expected_py_values:</span> <span class="pre">None,</span> <span class="pre">values:</span> <span class="pre">[Py(0x7f936aeacad0),</span> <span class="pre">Py(0x7f936aeacb30)]</span> <span class="pre">},</span> <span class="pre">missing:</span> <span class="pre">None,</span> <span class="pre">expected_repr:</span> <span class="pre">"'y'</span> <span class="pre">or</span> <span class="pre">'z'",</span> <span class="pre">strict:</span> <span class="pre">false,</span> <span class="pre">class_repr:</span> <span class="pre">"Axis",</span> <span class="pre">name:</span> <span class="pre">"str-enum[Axis]"</span> <span class="pre">}),</span> <span class="pre">StrEnum(EnumValidator</span> <span class="pre">{</span> <span class="pre">phantom:</span> <span class="pre">PhantomData<_pydantic_core::validators::enum_::StrEnumValidator>,</span> <span class="pre">class:</span> <span class="pre">Py(0x562a9a438050),</span> <span class="pre">lookup:</span> <span class="pre">LiteralLookup</span> <span class="pre">{</span> <span class="pre">expected_bool:</span> <span class="pre">None,</span> <span class="pre">expected_int:</span> <span class="pre">None,</span> <span class="pre">expected_str:</span> <span class="pre">Some({"negative":</span> <span class="pre">1,</span> <span class="pre">"positive":</span> <span class="pre">0}),</span> <span class="pre">expected_py_dict:</span> <span class="pre">None,</span> <span class="pre">expected_py_values:</span> <span class="pre">None,</span> <span class="pre">values:</span> <span class="pre">[Py(0x7f936aeacc50),</span> <span class="pre">Py(0x7f936aeaccb0)]</span> <span class="pre">},</span> <span class="pre">missing:</span> <span class="pre">None,</span> <span class="pre">expected_repr:</span> <span class="pre">"'positive'</span> <span class="pre">or</span> <span class="pre">'negative'",</span> <span class="pre">strict:</span> <span class="pre">false,</span> <span class="pre">class_repr:</span> <span class="pre">"Direction",</span> <span class="pre">name:</span> <span class="pre">"str-enum[Direction]"</span> <span class="pre">}),</span> <span class="pre">Model(ModelValidator</span> <span class="pre">{</span> <span class="pre">revalidate:</span> <span class="pre">Never,</span> <span class="pre">validator:</span> <span class="pre">ModelFields(ModelFieldsValidator</span> <span class="pre">{</span> <span class="pre">fields:</span> <span class="pre">[Field</span> <span class="pre">{</span> <span class="pre">name:</span> <span class="pre">"axis",</span> <span class="pre">lookup_key:</span> <span class="pre">Simple</span> <span class="pre">{</span> <span class="pre">key:</span> <span class="pre">"axis",</span> <span class="pre">py_key:</span> <span class="pre">Py(0x7f936b87b7e0),</span> <span class="pre">path:</span> <span class="pre">LookupPath([S("axis",</span> <span class="pre">Py(0x7f936b87b900))])</span> <span class="pre">},</span> <span class="pre">name_py:</span> <span class="pre">Py(0x7f936bc3a310),</span> <span class="pre">validator:</span> <span class="pre">DefinitionRef(DefinitionRefValidator</span> <span class="pre">{</span> <span class="pre">definition:</span> <span class="pre">"..."</span> <span class="pre">}),</span> <span class="pre">frozen:</span> <span class="pre">false</span> <span class="pre">},</span> <span class="pre">Field</span> <span class="pre">{</span> <span class="pre">name:</span> <span class="pre">"direction",</span> <span class="pre">lookup_key:</span> <span class="pre">Simple</span> <span class="pre">{</span> <span class="pre">key:</span> <span class="pre">"direction",</span> <span class="pre">py_key:</span> <span class="pre">Py(0x7f936af37f70),</span> <span class="pre">path:</span> <span class="pre">LookupPath([S("direction",</span> <span class="pre">Py(0x7f936af37e30))])</span> <span class="pre">},</span> <span class="pre">name_py:</span> <span class="pre">Py(0x7f936e0debf0),</span> <span class="pre">validator:</span> <span class="pre">DefinitionRef(DefinitionRefValidator</span> <span class="pre">{</span> <span class="pre">definition:</span> <span class="pre">"..."</span> <span class="pre">}),</span> <span class="pre">frozen:</span> <span class="pre">false</span> <span class="pre">}],</span> <span class="pre">model_name:</span> <span class="pre">"AxisDirectionPair",</span> <span class="pre">extra_behavior:</span> <span class="pre">Ignore,</span> <span class="pre">extras_validator:</span> <span class="pre">None,</span> <span class="pre">strict:</span> <span class="pre">false,</span> <span class="pre">from_attributes:</span> <span class="pre">false,</span> <span class="pre">loc_by_alias:</span> <span class="pre">true</span> <span class="pre">}),</span> <span class="pre">class:</span> <span class="pre">Py(0x562a9a438a50),</span> <span class="pre">post_init:</span> <span class="pre">None,</span> <span class="pre">frozen:</span> <span class="pre">false,</span> <span class="pre">custom_init:</span> <span class="pre">false,</span> <span class="pre">root_model:</span> <span class="pre">false,</span> <span class="pre">undefined:</span> <span class="pre">Py(0x7f936d406320),</span> <span class="pre">name:</span> <span class="pre">"AxisDirectionPair"</span> <span class="pre">})],</span> <span class="pre">cache_strings=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.OptionPly.__pydantic_validator__" title="Link to this definition"></a></dt>
|
||
<dd><p>The <code class="xref any docutils literal notranslate"><span class="pre">pydantic-core</span></code> <code class="xref any docutils literal notranslate"><span class="pre">SchemaValidator</span></code> used to validate instances of the model.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionPly.__repr__">
|
||
<span class="sig-name descname"><span class="pre">__repr__</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionPly.__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>
|
||
<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.OptionPly.__repr_args__">
|
||
<span class="sig-name descname"><span class="pre">__repr_args__</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionPly.__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/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/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/typing.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.OptionPly.__repr_name__">
|
||
<span class="sig-name descname"><span class="pre">__repr_name__</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionPly.__repr_name__" title="Link to this definition"></a></dt>
|
||
<dd><p>Name of the instance’s class, used in __repr__.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><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.OptionPly.__repr_str__">
|
||
<span class="sig-name descname"><span class="pre">__repr_str__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">join_str</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionPly.__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>
|
||
<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.OptionPly.__rich_repr__">
|
||
<span class="sig-name descname"><span class="pre">__rich_repr__</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionPly.__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>
|
||
<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.OptionPly.__setattr__">
|
||
<span class="sig-name descname"><span class="pre">__setattr__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionPly.__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>
|
||
<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.OptionPly.__setstate__">
|
||
<span class="sig-name descname"><span class="pre">__setstate__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">state</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionPly.__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>
|
||
<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.OptionPly.__signature__">
|
||
<span class="sig-name descname"><span class="pre">__signature__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[Signature]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre"><Signature</span> <span class="pre">(*,</span> <span class="pre">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">-></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.OptionPly.__signature__" title="Link to this definition"></a></dt>
|
||
<dd><p>The synthesized <a class="reference internal" href="kittycad.models.input_format.OptionPly.html#id0" title="kittycad.models.input_format.OptionPly.__init__"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">__init__</span></code></a> [<code class="xref any docutils literal notranslate"><span class="pre">Signature</span></code>][inspect.Signature] of the model.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionPly.__slots__">
|
||
<span class="sig-name descname"><span class="pre">__slots__</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">('__dict__',</span> <span class="pre">'__pydantic_fields_set__',</span> <span class="pre">'__pydantic_extra__',</span> <span class="pre">'__pydantic_private__')</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionPly.__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.OptionPly.__str__">
|
||
<span class="sig-name descname"><span class="pre">__str__</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionPly.__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>
|
||
<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.OptionPly._abc_impl">
|
||
<span class="sig-name descname"><span class="pre">_abc_impl</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre"><_abc._abc_data</span> <span class="pre">object></span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionPly._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.OptionPly._calculate_keys">
|
||
<span class="sig-name descname"><span class="pre">_calculate_keys</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionPly._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>
|
||
<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.OptionPly._check_frozen">
|
||
<span class="sig-name descname"><span class="pre">_check_frozen</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionPly._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>
|
||
<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.OptionPly._copy_and_set_values">
|
||
<span class="sig-name descname"><span class="pre">_copy_and_set_values</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionPly._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>
|
||
<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.OptionPly._get_value">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">_get_value</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="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.OptionPly._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>
|
||
<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.OptionPly._iter">
|
||
<span class="sig-name descname"><span class="pre">_iter</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionPly._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>
|
||
<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.OptionPly.construct">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">construct</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_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.OptionPly.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>
|
||
<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.OptionPly.coords">
|
||
<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.OptionPly.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.OptionPly.copy">
|
||
<span class="sig-name descname"><span class="pre">copy</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">include</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exclude</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">update</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">deep</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionPly.copy" title="Link to this definition"></a></dt>
|
||
<dd><p>Returns a copy of the model.</p>
|
||
<dl class="simple">
|
||
<dt>!!! warning “Deprecated”</dt><dd><p>This method is now deprecated; use <a class="reference internal" href="kittycad.models.input_format.OptionPly.html#kittycad.models.input_format.OptionPly.model_copy" title="kittycad.models.input_format.OptionPly.model_copy"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">model_copy</span></code></a> instead.</p>
|
||
</dd>
|
||
</dl>
|
||
<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">
|
||
<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>
|
||
<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.OptionPly.dict">
|
||
<span class="sig-name descname"><span class="pre">dict</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">include</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exclude</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">by_alias</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exclude_unset</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exclude_defaults</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exclude_none</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionPly.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>
|
||
<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.OptionPly.from_orm">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_orm</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">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.OptionPly.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>
|
||
<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.OptionPly.json">
|
||
<span class="sig-name descname"><span class="pre">json</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">include</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exclude</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">by_alias</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exclude_unset</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exclude_defaults</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exclude_none</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">encoder</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">PydanticUndefined</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">models_as_dict</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">PydanticUndefined</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">dumps_kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionPly.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>
|
||
<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.OptionPly.model_computed_fields">
|
||
<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.OptionPly.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.OptionPly.model_config">
|
||
<span class="sig-name descname"><span class="pre">model_config</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[ConfigDict]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'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.OptionPly.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.OptionPly.model_construct">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">model_construct</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_fields_set</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">values</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionPly.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.OptionPly.html#kittycad.models.input_format.OptionPly.__dict__" title="kittycad.models.input_format.OptionPly.__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.OptionPly.html#kittycad.models.input_format.OptionPly.__pydantic_fields_set__" title="kittycad.models.input_format.OptionPly.__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.OptionPly.html#kittycad.models.input_format.OptionPly.model_construct" title="kittycad.models.input_format.OptionPly.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 instance’s <a class="reference internal" href="kittycad.models.input_format.OptionPly.html#kittycad.models.input_format.OptionPly.__dict__" title="kittycad.models.input_format.OptionPly.__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.OptionPly.html#kittycad.models.input_format.OptionPly.__pydantic_extra__" title="kittycad.models.input_format.OptionPly.__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.OptionPly.html#kittycad.models.input_format.OptionPly.model_construct" title="kittycad.models.input_format.OptionPly.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">
|
||
<li><p><strong>_fields_set</strong> (<span class="sphinx_autodoc_typehints-type"><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>] | <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 field names that were originally explicitly set during instantiation. If provided,
|
||
this is directly used for the [<a class="reference internal" href="kittycad.models.input_format.OptionPly.html#kittycad.models.input_format.OptionPly.model_fields_set" title="kittycad.models.input_format.OptionPly.model_fields_set"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">model_fields_set</span></code></a>][pydantic.BaseModel.model_fields_set] attribute.
|
||
Otherwise, the field names from the <code class="xref any docutils literal notranslate"><span class="pre">values</span></code> argument will be used.</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>
|
||
<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>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.OptionPly.model_copy">
|
||
<span class="sig-name descname"><span class="pre">model_copy</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">update</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">deep</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionPly.model_copy" title="Link to this definition"></a></dt>
|
||
<dd><p>Usage docs: <a class="reference external" href="https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy">https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy</a></p>
|
||
<p>Returns a copy of the model.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>update</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference internal" href="kittycad.models.input_format.OptionPly.html#kittycad.models.input_format.OptionPly.dict" title="kittycad.models.input_format.OptionPly.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>] | <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>) – Values to change/add in the new model. Note: the data is not validated
|
||
before creating the new model. You should trust this data.</p></li>
|
||
<li><p><strong>deep</strong> (<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>
|
||
<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.OptionPly.model_dump">
|
||
<span class="sig-name descname"><span class="pre">model_dump</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mode</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'python'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">include</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exclude</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">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.OptionPly.model_dump" title="Link to this definition"></a></dt>
|
||
<dd><p>Usage docs: <a class="reference external" href="https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump">https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump</a></p>
|
||
<p>Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>mode</strong> (<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.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.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.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[IncEx, <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">True</span></code>]]], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[IncEx, <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">True</span></code>]]], <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">True</span></code>]]], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.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.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[IncEx, <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">True</span></code>]]], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[IncEx, <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">True</span></code>]]], <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">True</span></code>]]], <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.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.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.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[IncEx, <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">True</span></code>]]], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[IncEx, <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">True</span></code>]]], <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">True</span></code>]]], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.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.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[IncEx, <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">True</span></code>]]], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[IncEx, <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">True</span></code>]]], <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">True</span></code>]]], <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.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>) – 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 field’s 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>
|
||
<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.OptionPly.html#kittycad.models.input_format.OptionPly.dict" title="kittycad.models.input_format.OptionPly.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.OptionPly.model_dump_json">
|
||
<span class="sig-name descname"><span class="pre">model_dump_json</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">indent</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">include</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exclude</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">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.OptionPly.model_dump_json" title="Link to this definition"></a></dt>
|
||
<dd><p>Usage docs: <a class="reference external" href="https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json">https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json</a></p>
|
||
<p>Generates a JSON representation of the model using Pydantic’s <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">
|
||
<li><p><strong>indent</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> | <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>) – 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.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.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.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[IncEx, <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">True</span></code>]]], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[IncEx, <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">True</span></code>]]], <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">True</span></code>]]], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.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.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[IncEx, <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">True</span></code>]]], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[IncEx, <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">True</span></code>]]], <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">True</span></code>]]], <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.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.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.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[IncEx, <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">True</span></code>]]], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[IncEx, <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">True</span></code>]]], <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">True</span></code>]]], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.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.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[IncEx, <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">True</span></code>]]], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[IncEx, <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">True</span></code>]]], <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">True</span></code>]]], <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.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>) – 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>
|
||
<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.OptionPly.model_extra">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">model_extra</span></span><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.OptionPly.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>
|
||
<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">"allow"</span></code>.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionPly.model_fields">
|
||
<span class="sig-name descname"><span class="pre">model_fields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[Dict[str,</span> <span class="pre">FieldInfo]]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'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.OptionPly.model_fields" title="Link to this definition"></a></dt>
|
||
<dd><p>Metadata about the fields defined on the model,
|
||
mapping of field names to [<code class="xref any docutils literal notranslate"><span class="pre">FieldInfo</span></code>][pydantic.fields.FieldInfo] objects.</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.OptionPly.model_fields_set">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">model_fields_set</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#set" title="(in Python v3.12)"><span class="pre">set</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionPly.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.OptionPly.model_json_schema">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">model_json_schema</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">by_alias=True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ref_template='#/$defs/{model}'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">schema_generator=<class</span> <span class="pre">'pydantic.json_schema.GenerateJsonSchema'></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mode='validation'</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionPly.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">
|
||
<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.OptionPly.html#kittycad.models.input_format.OptionPly.type" title="kittycad.models.input_format.OptionPly.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>
|
||
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><a class="reference internal" href="kittycad.models.input_format.OptionPly.html#kittycad.models.input_format.OptionPly.dict" title="kittycad.models.input_format.OptionPly.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.OptionPly.model_parametrized_name">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">model_parametrized_name</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">params</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionPly.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>
|
||
<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.OptionPly.html#kittycad.models.input_format.OptionPly.type" title="kittycad.models.input_format.OptionPly.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>
|
||
<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>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.OptionPly.model_post_init">
|
||
<span class="sig-name descname"><span class="pre">model_post_init</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_BaseModel__context</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionPly.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.OptionPly.html#id0" title="kittycad.models.input_format.OptionPly.__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.OptionPly.html#kittycad.models.input_format.OptionPly.model_construct" title="kittycad.models.input_format.OptionPly.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>
|
||
<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.OptionPly.model_rebuild">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">model_rebuild</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">force</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">raise_errors</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_parent_namespace_depth</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">2</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_types_namespace</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionPly.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">
|
||
<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 internal" href="kittycad.models.input_format.OptionPly.html#kittycad.models.input_format.OptionPly.dict" title="kittycad.models.input_format.OptionPly.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>] | <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>) – 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>
|
||
<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/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/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>
|
||
<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.OptionPly.model_validate">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">model_validate</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">obj</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">strict</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">from_attributes</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">context</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionPly.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">
|
||
<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/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/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>) – 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/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/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>) – 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.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>) – Additional context to pass to the validator.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><strong>ValidationError</strong> – If the object could not be validated.</p>
|
||
</dd>
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><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.OptionPly.model_validate_json">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">model_validate_json</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">json_data</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">strict</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">context</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionPly.model_validate_json" title="Link to this definition"></a></dt>
|
||
<dd><p>Usage docs: <a class="reference external" href="https://docs.pydantic.dev/2.9/concepts/json/#json-parsing">https://docs.pydantic.dev/2.9/concepts/json/#json-parsing</a></p>
|
||
<p>Validate the given JSON data against the Pydantic model.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>json_data</strong> (<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/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/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>) – 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.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>) – Extra variables to pass to the validator.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><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>
|
||
<dd class="field-even"><p><strong>ValidationError</strong> – If <code class="xref any docutils literal notranslate"><span class="pre">json_data</span></code> is not a JSON string or the object could not be validated.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionPly.model_validate_strings">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">model_validate_strings</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">obj</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">strict</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">context</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionPly.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">
|
||
<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/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/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>) – 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.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>) – Extra variables to pass to the validator.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><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.OptionPly.parse_file">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">parse_file</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">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.OptionPly.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>
|
||
<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.OptionPly.parse_obj">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">parse_obj</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">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.OptionPly.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>
|
||
<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.OptionPly.parse_raw">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">parse_raw</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">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.OptionPly.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>
|
||
<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.OptionPly.schema">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">schema</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">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.OptionPly.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>
|
||
<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.OptionPly.schema_json">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">schema_json</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="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.OptionPly.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>
|
||
<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.OptionPly.type">
|
||
<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.OptionPly.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.OptionPly.units">
|
||
<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.OptionPly.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.OptionPly.update_forward_refs">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">update_forward_refs</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="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.OptionPly.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>
|
||
<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.OptionPly.validate">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">validate</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">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.OptionPly.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>
|
||
<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.OptionSldprt">
|
||
<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">OptionSldprt</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#OptionSldprt"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionSldprt" 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>
|
||
<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>
|
||
<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.OptionSldprt.__abstractmethods__">
|
||
<span class="sig-name descname"><span class="pre">__abstractmethods__</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">frozenset({})</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionSldprt.__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.OptionSldprt.__annotations__">
|
||
<span class="sig-name descname"><span class="pre">__annotations__</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'__class_vars__':</span> <span class="pre">'ClassVar[set[str]]',</span> <span class="pre">'__private_attributes__':</span> <span class="pre">'ClassVar[Dict[str,</span> <span class="pre">ModelPrivateAttr]]',</span> <span class="pre">'__pydantic_complete__':</span> <span class="pre">'ClassVar[bool]',</span> <span class="pre">'__pydantic_core_schema__':</span> <span class="pre">'ClassVar[CoreSchema]',</span> <span class="pre">'__pydantic_custom_init__':</span> <span class="pre">'ClassVar[bool]',</span> <span class="pre">'__pydantic_decorators__':</span> <span class="pre">'ClassVar[_decorators.DecoratorInfos]',</span> <span class="pre">'__pydantic_extra__':</span> <span class="pre">'dict[str,</span> <span class="pre">Any]</span> <span class="pre">|</span> <span class="pre">None',</span> <span class="pre">'__pydantic_fields_set__':</span> <span class="pre">'set[str]',</span> <span class="pre">'__pydantic_generic_metadata__':</span> <span class="pre">'ClassVar[_generics.PydanticGenericMetadata]',</span> <span class="pre">'__pydantic_parent_namespace__':</span> <span class="pre">'ClassVar[Dict[str,</span> <span class="pre">Any]</span> <span class="pre">|</span> <span class="pre">None]',</span> <span class="pre">'__pydantic_post_init__':</span> <span class="pre">"ClassVar[None</span> <span class="pre">|</span> <span class="pre">Literal['model_post_init']]",</span> <span class="pre">'__pydantic_private__':</span> <span class="pre">'dict[str,</span> <span class="pre">Any]</span> <span class="pre">|</span> <span class="pre">None',</span> <span class="pre">'__pydantic_root_model__':</span> <span class="pre">'ClassVar[bool]',</span> <span class="pre">'__pydantic_serializer__':</span> <span class="pre">'ClassVar[SchemaSerializer]',</span> <span class="pre">'__pydantic_validator__':</span> <span class="pre">'ClassVar[SchemaValidator</span> <span class="pre">|</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"><class</span> <span class="pre">'bool'>,</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.OptionSldprt.__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.OptionSldprt.__class_getitem__">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">__class_getitem__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">typevar_values</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionSldprt.__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.OptionSldprt.html#kittycad.models.input_format.OptionSldprt.type" title="kittycad.models.input_format.OptionSldprt.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.OptionSldprt.__class_vars__">
|
||
<span class="sig-name descname"><span class="pre">__class_vars__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[set[str]]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionSldprt.__class_vars__" title="Link to this definition"></a></dt>
|
||
<dd><p>The names of the class variables defined on the model.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionSldprt.__copy__">
|
||
<span class="sig-name descname"><span class="pre">__copy__</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionSldprt.__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>
|
||
<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.OptionSldprt.__deepcopy__">
|
||
<span class="sig-name descname"><span class="pre">__deepcopy__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">memo</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionSldprt.__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>
|
||
<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.OptionSldprt.__delattr__">
|
||
<span class="sig-name descname"><span class="pre">__delattr__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">item</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionSldprt.__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>
|
||
<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.OptionSldprt.__dict__">
|
||
<span class="sig-name descname"><span class="pre">__dict__</span></span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionSldprt.__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.OptionSldprt.__eq__">
|
||
<span class="sig-name descname"><span class="pre">__eq__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">other</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionSldprt.__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>
|
||
<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.OptionSldprt.__fields_set__">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">__fields_set__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#set" title="(in Python v3.12)"><span class="pre">set</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionSldprt.__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.OptionSldprt.__get_pydantic_core_schema__">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">__get_pydantic_core_schema__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">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.OptionSldprt.__get_pydantic_core_schema__" title="Link to this definition"></a></dt>
|
||
<dd><p>Hook into generating the model’s CoreSchema.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>source</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference internal" href="kittycad.models.input_format.OptionSldprt.html#kittycad.models.input_format.OptionSldprt.type" title="kittycad.models.input_format.OptionSldprt.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 Pydantic’s internal CoreSchema generation logic.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><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 class="xref py py-class docutils literal notranslate"><span class="pre">ModelFieldsSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">ModelSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">DataclassArgsSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">DataclassSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">ArgumentsSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">CallSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">CustomErrorSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">JsonSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">UrlSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">MultiHostUrlSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">DefinitionsSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">DefinitionReferenceSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">UuidSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">ComplexSchema</span></code>]</span></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<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.OptionSldprt.__get_pydantic_json_schema__">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">__get_pydantic_json_schema__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">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.OptionSldprt.__get_pydantic_json_schema__" title="Link to this definition"></a></dt>
|
||
<dd><p>Hook into generating the model’s JSON schema.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>core_schema</strong> (<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 class="xref py py-class docutils literal notranslate"><span class="pre">ModelFieldsSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">ModelSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">DataclassArgsSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">DataclassSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">ArgumentsSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">CallSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">CustomErrorSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">JsonSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">UrlSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">MultiHostUrlSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">DefinitionsSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">DefinitionReferenceSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">UuidSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">ComplexSchema</span></code>]</span>) – A <code class="xref any docutils literal notranslate"><span class="pre">pydantic-core</span></code> CoreSchema.
|
||
You can ignore this argument and call the handler with a new CoreSchema,
|
||
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>
|
||
<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 Pydantic’s 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.
|
||
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>
|
||
<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.OptionSldprt.__getattr__">
|
||
<span class="sig-name descname"><span class="pre">__getattr__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">item</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionSldprt.__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>
|
||
<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.OptionSldprt.__getstate__">
|
||
<span class="sig-name descname"><span class="pre">__getstate__</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionSldprt.__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>
|
||
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><a class="reference internal" href="kittycad.models.input_format.OptionSldprt.html#kittycad.models.input_format.OptionSldprt.dict" title="kittycad.models.input_format.OptionSldprt.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.OptionSldprt.__hash__">
|
||
<span class="sig-name descname"><span class="pre">__hash__</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionSldprt.__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.OptionSldprt.__init__">
|
||
<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">data</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionSldprt.__init__" title="Link to this definition"></a></dt>
|
||
<dd><p>Create a new model by parsing and validating input data from keyword arguments.</p>
|
||
<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>
|
||
<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.OptionSldprt.__iter__">
|
||
<span class="sig-name descname"><span class="pre">__iter__</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionSldprt.__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>
|
||
<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.OptionSldprt.__module__">
|
||
<span class="sig-name descname"><span class="pre">__module__</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'kittycad.models.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.OptionSldprt.__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.OptionSldprt.__pretty__">
|
||
<span class="sig-name descname"><span class="pre">__pretty__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">fmt</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionSldprt.__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>
|
||
<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.OptionSldprt.__private_attributes__">
|
||
<span class="sig-name descname"><span class="pre">__private_attributes__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[Dict[str,</span> <span class="pre">ModelPrivateAttr]]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionSldprt.__private_attributes__" title="Link to this definition"></a></dt>
|
||
<dd><p>Metadata about the private attributes of the model.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionSldprt.__pydantic_complete__">
|
||
<span class="sig-name descname"><span class="pre">__pydantic_complete__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[bool]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">True</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionSldprt.__pydantic_complete__" title="Link to this definition"></a></dt>
|
||
<dd><p>Whether model building is completed, or if there are still undefined fields.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionSldprt.__pydantic_core_schema__">
|
||
<span class="sig-name descname"><span class="pre">__pydantic_core_schema__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[CoreSchema]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'cls':</span> <span class="pre"><class</span> <span class="pre">'kittycad.models.input_format.OptionSldprt'>,</span> <span class="pre">'config':</span> <span class="pre">{'title':</span> <span class="pre">'OptionSldprt'},</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(<function</span> <span class="pre">modify_model_json_schema>,</span> <span class="pre">cls=<class</span> <span class="pre">'kittycad.models.input_format.OptionSldprt'>,</span> <span class="pre">title=None),</span> <span class="pre"><bound</span> <span class="pre">method</span> <span class="pre">BaseModel.__get_pydantic_json_schema__</span> <span class="pre">of</span> <span class="pre"><class</span> <span class="pre">'kittycad.models.input_format.OptionSldprt'>>]},</span> <span class="pre">'ref':</span> <span class="pre">'kittycad.models.input_format.OptionSldprt:94740972942384',</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">[<function</span> <span class="pre">get_json_schema_update_func.<locals>.json_schema_update_func>],</span> <span class="pre">'pydantic_js_functions':</span> <span class="pre">[]},</span> <span class="pre">'schema':</span> <span class="pre">{'default':</span> <span class="pre">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">[<function</span> <span class="pre">get_json_schema_update_func.<locals>.json_schema_update_func>],</span> <span class="pre">'pydantic_js_functions':</span> <span class="pre">[]},</span> <span class="pre">'schema':</span> <span class="pre">{'default':</span> <span class="pre">'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">'OptionSldprt',</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.OptionSldprt.__pydantic_core_schema__" title="Link to this definition"></a></dt>
|
||
<dd><p>The core schema of the model.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionSldprt.__pydantic_custom_init__">
|
||
<span class="sig-name descname"><span class="pre">__pydantic_custom_init__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[bool]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">False</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionSldprt.__pydantic_custom_init__" title="Link to this definition"></a></dt>
|
||
<dd><p>Whether the model has a custom <a class="reference internal" href="kittycad.models.input_format.OptionSldprt.html#id0" title="kittycad.models.input_format.OptionSldprt.__init__"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">__init__</span></code></a> method.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionSldprt.__pydantic_decorators__">
|
||
<span class="sig-name descname"><span class="pre">__pydantic_decorators__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[_decorators.DecoratorInfos]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">DecoratorInfos(validators={},</span> <span class="pre">field_validators={},</span> <span class="pre">root_validators={},</span> <span class="pre">field_serializers={},</span> <span class="pre">model_serializers={},</span> <span class="pre">model_validators={},</span> <span class="pre">computed_fields={})</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionSldprt.__pydantic_decorators__" title="Link to this definition"></a></dt>
|
||
<dd><p>Metadata containing the decorators defined on the model.
|
||
This replaces <code class="xref any docutils literal notranslate"><span class="pre">Model.__validators__</span></code> and <code class="xref any docutils literal notranslate"><span class="pre">Model.__root_validators__</span></code> from Pydantic V1.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionSldprt.__pydantic_extra__">
|
||
<span class="sig-name descname"><span class="pre">__pydantic_extra__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">dict[str,</span> <span class="pre">Any]</span> <span class="pre">|</span> <span class="pre">None</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionSldprt.__pydantic_extra__" title="Link to this definition"></a></dt>
|
||
<dd><p>A dictionary containing extra values, if [<a class="reference internal" href="kittycad.models.kcl_code_completion_request.KclCodeCompletionRequest.html#kittycad.models.kcl_code_completion_request.KclCodeCompletionRequest.extra" title="kittycad.models.kcl_code_completion_request.KclCodeCompletionRequest.extra"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">extra</span></code></a>][pydantic.config.ConfigDict.extra] is set to <code class="xref any docutils literal notranslate"><span class="pre">'allow'</span></code>.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionSldprt.__pydantic_fields_set__">
|
||
<span class="sig-name descname"><span class="pre">__pydantic_fields_set__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">set[str]</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionSldprt.__pydantic_fields_set__" title="Link to this definition"></a></dt>
|
||
<dd><p>The names of fields explicitly set during instantiation.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionSldprt.__pydantic_generic_metadata__">
|
||
<span class="sig-name descname"><span class="pre">__pydantic_generic_metadata__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[_generics.PydanticGenericMetadata]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'args':</span> <span class="pre">(),</span> <span class="pre">'origin':</span> <span class="pre">None,</span> <span class="pre">'parameters':</span> <span class="pre">()}</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionSldprt.__pydantic_generic_metadata__" title="Link to this definition"></a></dt>
|
||
<dd><p>Metadata for generic models; contains data used for a similar purpose to
|
||
__args__, __origin__, __parameters__ in typing-module generics. May eventually be replaced by these.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionSldprt.__pydantic_init_subclass__">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">__pydantic_init_subclass__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionSldprt.__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.OptionSldprt.html#kittycad.models.input_format.OptionSldprt.model_fields" title="kittycad.models.input_format.OptionSldprt.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>
|
||
<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 aren’t used internally by pydantic.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>**kwargs</strong> (<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 aren’t used internally
|
||
by pydantic.</p>
|
||
</dd>
|
||
<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/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.OptionSldprt.__pydantic_parent_namespace__">
|
||
<span class="sig-name descname"><span class="pre">__pydantic_parent_namespace__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[Dict[str,</span> <span class="pre">Any]</span> <span class="pre">|</span> <span class="pre">None]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">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.OptionSldprt.__pydantic_parent_namespace__" title="Link to this definition"></a></dt>
|
||
<dd><p>Parent namespace of the model, used for automatic rebuilding of models.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionSldprt.__pydantic_post_init__">
|
||
<span class="sig-name descname"><span class="pre">__pydantic_post_init__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[None</span> <span class="pre">|</span> <span class="pre">Literal['model_post_init']]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionSldprt.__pydantic_post_init__" title="Link to this definition"></a></dt>
|
||
<dd><p>The name of the post-init method for the model, if defined.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionSldprt.__pydantic_private__">
|
||
<span class="sig-name descname"><span class="pre">__pydantic_private__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">dict[str,</span> <span class="pre">Any]</span> <span class="pre">|</span> <span class="pre">None</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionSldprt.__pydantic_private__" title="Link to this definition"></a></dt>
|
||
<dd><p>Values of private attributes set on the model instance.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionSldprt.__pydantic_root_model__">
|
||
<span class="sig-name descname"><span class="pre">__pydantic_root_model__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[bool]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">False</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionSldprt.__pydantic_root_model__" title="Link to this definition"></a></dt>
|
||
<dd><p>Whether the model is a [<code class="xref any docutils literal notranslate"><span class="pre">RootModel</span></code>][pydantic.root_model.RootModel].</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionSldprt.__pydantic_serializer__">
|
||
<span class="sig-name descname"><span class="pre">__pydantic_serializer__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[SchemaSerializer]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">SchemaSerializer(serializer=Model(</span>     <span class="pre">ModelSerializer</span> <span class="pre">{</span>         <span class="pre">class:</span> <span class="pre">Py(</span>             <span class="pre">0x0000562a9a09b430,</span>         <span class="pre">),</span>         <span class="pre">serializer:</span> <span class="pre">Fields(</span>             <span class="pre">GeneralFieldsSerializer</span> <span class="pre">{</span>                 <span class="pre">fields:</span> <span class="pre">{</span>                     <span class="pre">"type":</span> <span class="pre">SerField</span> <span class="pre">{</span>                         <span class="pre">key_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007f936f623938,</span>                         <span class="pre">),</span>                         <span class="pre">alias:</span> <span class="pre">None,</span>                         <span class="pre">alias_py:</span> <span class="pre">None,</span>                         <span class="pre">serializer:</span> <span class="pre">Some(</span>                             <span class="pre">WithDefault(</span>                                 <span class="pre">WithDefaultSerializer</span> <span class="pre">{</span>                                     <span class="pre">default:</span> <span class="pre">Default(</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007f936b879d70,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                     <span class="pre">serializer:</span> <span class="pre">Literal(</span>                                         <span class="pre">LiteralSerializer</span> <span class="pre">{</span>                                             <span class="pre">expected_int:</span> <span class="pre">{},</span>                                             <span class="pre">expected_str:</span> <span class="pre">{</span>                                                 <span class="pre">"sldprt",</span>                                             <span class="pre">},</span>                                             <span class="pre">expected_py:</span> <span class="pre">None,</span>                                             <span class="pre">name:</span> <span class="pre">"literal['sldprt']",</span>                                         <span class="pre">},</span>                                     <span class="pre">),</span>                                 <span class="pre">},</span>                             <span class="pre">),</span>                         <span class="pre">),</span>                         <span class="pre">required:</span> <span class="pre">true,</span>                     <span class="pre">},</span>                     <span class="pre">"split_closed_faces":</span> <span class="pre">SerField</span> <span class="pre">{</span>                         <span class="pre">key_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007f936af742b0,</span>                         <span class="pre">),</span>                         <span class="pre">alias:</span> <span class="pre">None,</span>                         <span class="pre">alias_py:</span> <span class="pre">None,</span>                         <span class="pre">serializer:</span> <span class="pre">Some(</span>                             <span class="pre">WithDefault(</span>                                 <span class="pre">WithDefaultSerializer</span> <span class="pre">{</span>                                     <span class="pre">default:</span> <span class="pre">Default(</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007f936f517d00,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                     <span class="pre">serializer:</span> <span class="pre">Bool(</span>                                         <span class="pre">BoolSerializer,</span>                                     <span class="pre">),</span>                                 <span class="pre">},</span>                             <span class="pre">),</span>                         <span class="pre">),</span>                         <span class="pre">required:</span> <span class="pre">true,</span>                     <span class="pre">},</span>                 <span class="pre">},</span>                 <span class="pre">computed_fields:</span> <span class="pre">Some(</span>                     <span class="pre">ComputedFields(</span>                         <span class="pre">[],</span>                     <span class="pre">),</span>                 <span class="pre">),</span>                 <span class="pre">mode:</span> <span class="pre">SimpleDict,</span>                 <span class="pre">extra_serializer:</span> <span class="pre">None,</span>                 <span class="pre">filter:</span> <span class="pre">SchemaFilter</span> <span class="pre">{</span>                     <span class="pre">include:</span> <span class="pre">None,</span>                     <span class="pre">exclude:</span> <span class="pre">None,</span>                 <span class="pre">},</span>                 <span class="pre">required_fields:</span> <span class="pre">2,</span>             <span class="pre">},</span>         <span class="pre">),</span>         <span class="pre">has_extra:</span> <span class="pre">false,</span>         <span class="pre">root_model:</span> <span class="pre">false,</span>         <span class="pre">name:</span> <span class="pre">"OptionSldprt",</span>     <span class="pre">},</span> <span class="pre">),</span> <span class="pre">definitions=[])</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.OptionSldprt.__pydantic_serializer__" title="Link to this definition"></a></dt>
|
||
<dd><p>The <code class="xref any docutils literal notranslate"><span class="pre">pydantic-core</span></code> <code class="xref any docutils literal notranslate"><span class="pre">SchemaSerializer</span></code> used to dump instances of the model.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionSldprt.__pydantic_validator__">
|
||
<span class="sig-name descname"><span class="pre">__pydantic_validator__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[SchemaValidator</span> <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="OptionSldprt",</span> <span class="pre">validator=Model(</span>     <span class="pre">ModelValidator</span> <span class="pre">{</span>         <span class="pre">revalidate:</span> <span class="pre">Never,</span>         <span class="pre">validator:</span> <span class="pre">ModelFields(</span>             <span class="pre">ModelFieldsValidator</span> <span class="pre">{</span>                 <span class="pre">fields:</span> <span class="pre">[</span>                     <span class="pre">Field</span> <span class="pre">{</span>                         <span class="pre">name:</span> <span class="pre">"split_closed_faces",</span>                         <span class="pre">lookup_key:</span> <span class="pre">Simple</span> <span class="pre">{</span>                             <span class="pre">key:</span> <span class="pre">"split_closed_faces",</span>                             <span class="pre">py_key:</span> <span class="pre">Py(</span>                                 <span class="pre">0x00007f936b004830,</span>                             <span class="pre">),</span>                             <span class="pre">path:</span> <span class="pre">LookupPath(</span>                                 <span class="pre">[</span>                                     <span class="pre">S(</span>                                         <span class="pre">"split_closed_faces",</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007f936b004770,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                 <span class="pre">],</span>                             <span class="pre">),</span>                         <span class="pre">},</span>                         <span class="pre">name_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007f936af742b0,</span>                         <span class="pre">),</span>                         <span class="pre">validator:</span> <span class="pre">WithDefault(</span>                             <span class="pre">WithDefaultValidator</span> <span class="pre">{</span>                                 <span class="pre">default:</span> <span class="pre">Default(</span>                                     <span class="pre">Py(</span>                                         <span class="pre">0x00007f936f517d00,</span>                                     <span class="pre">),</span>                                 <span class="pre">),</span>                                 <span class="pre">on_error:</span> <span class="pre">Raise,</span>                                 <span class="pre">validator:</span> <span class="pre">Bool(</span>                                     <span class="pre">BoolValidator</span> <span class="pre">{</span>                                         <span class="pre">strict:</span> <span class="pre">false,</span>                                     <span class="pre">},</span>                                 <span class="pre">),</span>                                 <span class="pre">validate_default:</span> <span class="pre">false,</span>                                 <span class="pre">copy_default:</span> <span class="pre">false,</span>                                 <span class="pre">name:</span> <span class="pre">"default[bool]",</span>                                 <span class="pre">undefined:</span> <span class="pre">Py(</span>                                     <span class="pre">0x00007f936d406320,</span>                                 <span class="pre">),</span>                             <span class="pre">},</span>                         <span class="pre">),</span>                         <span class="pre">frozen:</span> <span class="pre">false,</span>                     <span class="pre">},</span>                     <span class="pre">Field</span> <span class="pre">{</span>                         <span class="pre">name:</span> <span class="pre">"type",</span>                         <span class="pre">lookup_key:</span> <span class="pre">Simple</span> <span class="pre">{</span>                             <span class="pre">key:</span> <span class="pre">"type",</span>                             <span class="pre">py_key:</span> <span class="pre">Py(</span>                                 <span class="pre">0x00007f936b781410,</span>                             <span class="pre">),</span>                             <span class="pre">path:</span> <span class="pre">LookupPath(</span>                                 <span class="pre">[</span>                                     <span class="pre">S(</span>                                         <span class="pre">"type",</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007f936b781470,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                 <span class="pre">],</span>                             <span class="pre">),</span>                         <span class="pre">},</span>                         <span class="pre">name_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007f936f623938,</span>                         <span class="pre">),</span>                         <span class="pre">validator:</span> <span class="pre">WithDefault(</span>                             <span class="pre">WithDefaultValidator</span> <span class="pre">{</span>                                 <span class="pre">default:</span> <span class="pre">Default(</span>                                     <span class="pre">Py(</span>                                         <span class="pre">0x00007f936b879d70,</span>                                     <span class="pre">),</span>                                 <span class="pre">),</span>                                 <span class="pre">on_error:</span> <span class="pre">Raise,</span>                                 <span class="pre">validator:</span> <span class="pre">Literal(</span>                                     <span class="pre">LiteralValidator</span> <span class="pre">{</span>                                         <span class="pre">lookup:</span> <span class="pre">LiteralLookup</span> <span class="pre">{</span>                                             <span class="pre">expected_bool:</span> <span class="pre">None,</span>                                             <span class="pre">expected_int:</span> <span class="pre">None,</span>                                             <span class="pre">expected_str:</span> <span class="pre">Some(</span>                                                 <span class="pre">{</span>                                                     <span class="pre">"sldprt":</span> <span class="pre">0,</span>                                                 <span class="pre">},</span>                                             <span class="pre">),</span>                                             <span class="pre">expected_py_dict:</span> <span class="pre">None,</span>                                             <span class="pre">expected_py_values:</span> <span class="pre">None,</span>                                             <span class="pre">values:</span> <span class="pre">[</span>                                                 <span class="pre">Py(</span>                                                     <span class="pre">0x00007f936b879d70,</span>                                                 <span class="pre">),</span>                                             <span class="pre">],</span>                                         <span class="pre">},</span>                                         <span class="pre">expected_repr:</span> <span class="pre">"'sldprt'",</span>                                         <span class="pre">name:</span> <span class="pre">"literal['sldprt']",</span>                                     <span class="pre">},</span>                                 <span class="pre">),</span>                                 <span class="pre">validate_default:</span> <span class="pre">false,</span>                                 <span class="pre">copy_default:</span> <span class="pre">false,</span>                                 <span class="pre">name:</span> <span class="pre">"default[literal['sldprt']]",</span>                                 <span class="pre">undefined:</span> <span class="pre">Py(</span>                                     <span class="pre">0x00007f936d406320,</span>                                 <span class="pre">),</span>                             <span class="pre">},</span>                         <span class="pre">),</span>                         <span class="pre">frozen:</span> <span class="pre">false,</span>                     <span class="pre">},</span>                 <span class="pre">],</span>                 <span class="pre">model_name:</span> <span class="pre">"OptionSldprt",</span>                 <span class="pre">extra_behavior:</span> <span class="pre">Ignore,</span>                 <span class="pre">extras_validator:</span> <span class="pre">None,</span>                 <span class="pre">strict:</span> <span class="pre">false,</span>                 <span class="pre">from_attributes:</span> <span class="pre">false,</span>                 <span class="pre">loc_by_alias:</span> <span class="pre">true,</span>             <span class="pre">},</span>         <span class="pre">),</span>         <span class="pre">class:</span> <span class="pre">Py(</span>             <span class="pre">0x0000562a9a09b430,</span>         <span class="pre">),</span>         <span class="pre">post_init:</span> <span class="pre">None,</span>         <span class="pre">frozen:</span> <span class="pre">false,</span>         <span class="pre">custom_init:</span> <span class="pre">false,</span>         <span class="pre">root_model:</span> <span class="pre">false,</span>         <span class="pre">undefined:</span> <span class="pre">Py(</span>             <span class="pre">0x00007f936d406320,</span>         <span class="pre">),</span>         <span class="pre">name:</span> <span class="pre">"OptionSldprt",</span>     <span class="pre">},</span> <span class="pre">),</span> <span class="pre">definitions=[],</span> <span class="pre">cache_strings=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.OptionSldprt.__pydantic_validator__" title="Link to this definition"></a></dt>
|
||
<dd><p>The <code class="xref any docutils literal notranslate"><span class="pre">pydantic-core</span></code> <code class="xref any docutils literal notranslate"><span class="pre">SchemaValidator</span></code> used to validate instances of the model.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionSldprt.__repr__">
|
||
<span class="sig-name descname"><span class="pre">__repr__</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionSldprt.__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>
|
||
<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.OptionSldprt.__repr_args__">
|
||
<span class="sig-name descname"><span class="pre">__repr_args__</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionSldprt.__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/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/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/typing.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.OptionSldprt.__repr_name__">
|
||
<span class="sig-name descname"><span class="pre">__repr_name__</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionSldprt.__repr_name__" title="Link to this definition"></a></dt>
|
||
<dd><p>Name of the instance’s class, used in __repr__.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><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.OptionSldprt.__repr_str__">
|
||
<span class="sig-name descname"><span class="pre">__repr_str__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">join_str</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionSldprt.__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>
|
||
<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.OptionSldprt.__rich_repr__">
|
||
<span class="sig-name descname"><span class="pre">__rich_repr__</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionSldprt.__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>
|
||
<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.OptionSldprt.__setattr__">
|
||
<span class="sig-name descname"><span class="pre">__setattr__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionSldprt.__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>
|
||
<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.OptionSldprt.__setstate__">
|
||
<span class="sig-name descname"><span class="pre">__setstate__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">state</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionSldprt.__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>
|
||
<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.OptionSldprt.__signature__">
|
||
<span class="sig-name descname"><span class="pre">__signature__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[Signature]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre"><Signature</span> <span class="pre">(*,</span> <span class="pre">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">-></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.OptionSldprt.__signature__" title="Link to this definition"></a></dt>
|
||
<dd><p>The synthesized <a class="reference internal" href="kittycad.models.input_format.OptionSldprt.html#id0" title="kittycad.models.input_format.OptionSldprt.__init__"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">__init__</span></code></a> [<code class="xref any docutils literal notranslate"><span class="pre">Signature</span></code>][inspect.Signature] of the model.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionSldprt.__slots__">
|
||
<span class="sig-name descname"><span class="pre">__slots__</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">('__dict__',</span> <span class="pre">'__pydantic_fields_set__',</span> <span class="pre">'__pydantic_extra__',</span> <span class="pre">'__pydantic_private__')</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionSldprt.__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.OptionSldprt.__str__">
|
||
<span class="sig-name descname"><span class="pre">__str__</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionSldprt.__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>
|
||
<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.OptionSldprt._abc_impl">
|
||
<span class="sig-name descname"><span class="pre">_abc_impl</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre"><_abc._abc_data</span> <span class="pre">object></span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionSldprt._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.OptionSldprt._calculate_keys">
|
||
<span class="sig-name descname"><span class="pre">_calculate_keys</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionSldprt._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>
|
||
<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.OptionSldprt._check_frozen">
|
||
<span class="sig-name descname"><span class="pre">_check_frozen</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionSldprt._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>
|
||
<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.OptionSldprt._copy_and_set_values">
|
||
<span class="sig-name descname"><span class="pre">_copy_and_set_values</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionSldprt._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>
|
||
<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.OptionSldprt._get_value">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">_get_value</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="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.OptionSldprt._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>
|
||
<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.OptionSldprt._iter">
|
||
<span class="sig-name descname"><span class="pre">_iter</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionSldprt._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>
|
||
<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.OptionSldprt.construct">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">construct</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_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.OptionSldprt.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>
|
||
<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.OptionSldprt.copy">
|
||
<span class="sig-name descname"><span class="pre">copy</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">include</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exclude</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">update</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">deep</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionSldprt.copy" title="Link to this definition"></a></dt>
|
||
<dd><p>Returns a copy of the model.</p>
|
||
<dl class="simple">
|
||
<dt>!!! warning “Deprecated”</dt><dd><p>This method is now deprecated; use <a class="reference internal" href="kittycad.models.input_format.OptionSldprt.html#kittycad.models.input_format.OptionSldprt.model_copy" title="kittycad.models.input_format.OptionSldprt.model_copy"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">model_copy</span></code></a> instead.</p>
|
||
</dd>
|
||
</dl>
|
||
<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">
|
||
<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>
|
||
<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.OptionSldprt.dict">
|
||
<span class="sig-name descname"><span class="pre">dict</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">include</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exclude</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">by_alias</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exclude_unset</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exclude_defaults</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exclude_none</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionSldprt.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>
|
||
<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.OptionSldprt.from_orm">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_orm</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">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.OptionSldprt.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>
|
||
<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.OptionSldprt.json">
|
||
<span class="sig-name descname"><span class="pre">json</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">include</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exclude</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">by_alias</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exclude_unset</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exclude_defaults</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exclude_none</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">encoder</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">PydanticUndefined</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">models_as_dict</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">PydanticUndefined</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">dumps_kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionSldprt.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>
|
||
<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.OptionSldprt.model_computed_fields">
|
||
<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.OptionSldprt.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.OptionSldprt.model_config">
|
||
<span class="sig-name descname"><span class="pre">model_config</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[ConfigDict]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'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.OptionSldprt.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.OptionSldprt.model_construct">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">model_construct</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_fields_set</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">values</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionSldprt.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.OptionSldprt.html#kittycad.models.input_format.OptionSldprt.__dict__" title="kittycad.models.input_format.OptionSldprt.__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.OptionSldprt.html#kittycad.models.input_format.OptionSldprt.__pydantic_fields_set__" title="kittycad.models.input_format.OptionSldprt.__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.OptionSldprt.html#kittycad.models.input_format.OptionSldprt.model_construct" title="kittycad.models.input_format.OptionSldprt.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 instance’s <a class="reference internal" href="kittycad.models.input_format.OptionSldprt.html#kittycad.models.input_format.OptionSldprt.__dict__" title="kittycad.models.input_format.OptionSldprt.__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.OptionSldprt.html#kittycad.models.input_format.OptionSldprt.__pydantic_extra__" title="kittycad.models.input_format.OptionSldprt.__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.OptionSldprt.html#kittycad.models.input_format.OptionSldprt.model_construct" title="kittycad.models.input_format.OptionSldprt.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">
|
||
<li><p><strong>_fields_set</strong> (<span class="sphinx_autodoc_typehints-type"><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>] | <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 field names that were originally explicitly set during instantiation. If provided,
|
||
this is directly used for the [<a class="reference internal" href="kittycad.models.input_format.OptionSldprt.html#kittycad.models.input_format.OptionSldprt.model_fields_set" title="kittycad.models.input_format.OptionSldprt.model_fields_set"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">model_fields_set</span></code></a>][pydantic.BaseModel.model_fields_set] attribute.
|
||
Otherwise, the field names from the <code class="xref any docutils literal notranslate"><span class="pre">values</span></code> argument will be used.</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>
|
||
<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>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.OptionSldprt.model_copy">
|
||
<span class="sig-name descname"><span class="pre">model_copy</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">update</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">deep</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionSldprt.model_copy" title="Link to this definition"></a></dt>
|
||
<dd><p>Usage docs: <a class="reference external" href="https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy">https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy</a></p>
|
||
<p>Returns a copy of the model.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>update</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference internal" href="kittycad.models.input_format.OptionSldprt.html#kittycad.models.input_format.OptionSldprt.dict" title="kittycad.models.input_format.OptionSldprt.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>] | <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>) – Values to change/add in the new model. Note: the data is not validated
|
||
before creating the new model. You should trust this data.</p></li>
|
||
<li><p><strong>deep</strong> (<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>
|
||
<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.OptionSldprt.model_dump">
|
||
<span class="sig-name descname"><span class="pre">model_dump</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mode</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'python'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">include</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exclude</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">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.OptionSldprt.model_dump" title="Link to this definition"></a></dt>
|
||
<dd><p>Usage docs: <a class="reference external" href="https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump">https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump</a></p>
|
||
<p>Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>mode</strong> (<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.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.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.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[IncEx, <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">True</span></code>]]], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[IncEx, <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">True</span></code>]]], <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">True</span></code>]]], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.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.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[IncEx, <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">True</span></code>]]], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[IncEx, <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">True</span></code>]]], <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">True</span></code>]]], <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.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.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.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[IncEx, <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">True</span></code>]]], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[IncEx, <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">True</span></code>]]], <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">True</span></code>]]], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.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.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[IncEx, <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">True</span></code>]]], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[IncEx, <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">True</span></code>]]], <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">True</span></code>]]], <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.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>) – 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 field’s 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>
|
||
<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.OptionSldprt.html#kittycad.models.input_format.OptionSldprt.dict" title="kittycad.models.input_format.OptionSldprt.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.OptionSldprt.model_dump_json">
|
||
<span class="sig-name descname"><span class="pre">model_dump_json</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">indent</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">include</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exclude</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">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.OptionSldprt.model_dump_json" title="Link to this definition"></a></dt>
|
||
<dd><p>Usage docs: <a class="reference external" href="https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json">https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json</a></p>
|
||
<p>Generates a JSON representation of the model using Pydantic’s <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">
|
||
<li><p><strong>indent</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> | <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>) – 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.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.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.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[IncEx, <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">True</span></code>]]], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[IncEx, <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">True</span></code>]]], <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">True</span></code>]]], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.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.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[IncEx, <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">True</span></code>]]], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[IncEx, <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">True</span></code>]]], <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">True</span></code>]]], <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.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.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.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[IncEx, <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">True</span></code>]]], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[IncEx, <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">True</span></code>]]], <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">True</span></code>]]], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.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.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[IncEx, <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">True</span></code>]]], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[IncEx, <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">True</span></code>]]], <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">True</span></code>]]], <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.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>) – 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>
|
||
<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.OptionSldprt.model_extra">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">model_extra</span></span><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.OptionSldprt.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>
|
||
<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">"allow"</span></code>.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionSldprt.model_fields">
|
||
<span class="sig-name descname"><span class="pre">model_fields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[Dict[str,</span> <span class="pre">FieldInfo]]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'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.OptionSldprt.model_fields" title="Link to this definition"></a></dt>
|
||
<dd><p>Metadata about the fields defined on the model,
|
||
mapping of field names to [<code class="xref any docutils literal notranslate"><span class="pre">FieldInfo</span></code>][pydantic.fields.FieldInfo] objects.</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.OptionSldprt.model_fields_set">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">model_fields_set</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#set" title="(in Python v3.12)"><span class="pre">set</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionSldprt.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.OptionSldprt.model_json_schema">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">model_json_schema</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">by_alias=True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ref_template='#/$defs/{model}'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">schema_generator=<class</span> <span class="pre">'pydantic.json_schema.GenerateJsonSchema'></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mode='validation'</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionSldprt.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">
|
||
<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.OptionSldprt.html#kittycad.models.input_format.OptionSldprt.type" title="kittycad.models.input_format.OptionSldprt.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>
|
||
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><a class="reference internal" href="kittycad.models.input_format.OptionSldprt.html#kittycad.models.input_format.OptionSldprt.dict" title="kittycad.models.input_format.OptionSldprt.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.OptionSldprt.model_parametrized_name">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">model_parametrized_name</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">params</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionSldprt.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>
|
||
<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.OptionSldprt.html#kittycad.models.input_format.OptionSldprt.type" title="kittycad.models.input_format.OptionSldprt.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>
|
||
<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>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.OptionSldprt.model_post_init">
|
||
<span class="sig-name descname"><span class="pre">model_post_init</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_BaseModel__context</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionSldprt.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.OptionSldprt.html#id0" title="kittycad.models.input_format.OptionSldprt.__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.OptionSldprt.html#kittycad.models.input_format.OptionSldprt.model_construct" title="kittycad.models.input_format.OptionSldprt.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>
|
||
<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.OptionSldprt.model_rebuild">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">model_rebuild</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">force</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">raise_errors</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_parent_namespace_depth</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">2</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_types_namespace</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionSldprt.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">
|
||
<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 internal" href="kittycad.models.input_format.OptionSldprt.html#kittycad.models.input_format.OptionSldprt.dict" title="kittycad.models.input_format.OptionSldprt.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>] | <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>) – 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>
|
||
<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/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/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>
|
||
<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.OptionSldprt.model_validate">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">model_validate</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">obj</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">strict</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">from_attributes</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">context</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionSldprt.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">
|
||
<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/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/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>) – 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/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/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>) – 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.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>) – Additional context to pass to the validator.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><strong>ValidationError</strong> – If the object could not be validated.</p>
|
||
</dd>
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><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.OptionSldprt.model_validate_json">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">model_validate_json</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">json_data</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">strict</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">context</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionSldprt.model_validate_json" title="Link to this definition"></a></dt>
|
||
<dd><p>Usage docs: <a class="reference external" href="https://docs.pydantic.dev/2.9/concepts/json/#json-parsing">https://docs.pydantic.dev/2.9/concepts/json/#json-parsing</a></p>
|
||
<p>Validate the given JSON data against the Pydantic model.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>json_data</strong> (<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/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/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>) – 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.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>) – Extra variables to pass to the validator.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><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>
|
||
<dd class="field-even"><p><strong>ValidationError</strong> – If <code class="xref any docutils literal notranslate"><span class="pre">json_data</span></code> is not a JSON string or the object could not be validated.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionSldprt.model_validate_strings">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">model_validate_strings</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">obj</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">strict</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">context</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionSldprt.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">
|
||
<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/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/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>) – 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.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>) – Extra variables to pass to the validator.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><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.OptionSldprt.parse_file">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">parse_file</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">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.OptionSldprt.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>
|
||
<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.OptionSldprt.parse_obj">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">parse_obj</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">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.OptionSldprt.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>
|
||
<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.OptionSldprt.parse_raw">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">parse_raw</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">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.OptionSldprt.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>
|
||
<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.OptionSldprt.schema">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">schema</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">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.OptionSldprt.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>
|
||
<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.OptionSldprt.schema_json">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">schema_json</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="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.OptionSldprt.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>
|
||
<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.OptionSldprt.split_closed_faces">
|
||
<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.OptionSldprt.split_closed_faces" 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.OptionSldprt.type">
|
||
<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.OptionSldprt.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.OptionSldprt.update_forward_refs">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">update_forward_refs</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="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.OptionSldprt.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>
|
||
<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.OptionSldprt.validate">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">validate</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">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.OptionSldprt.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>
|
||
<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.OptionStep">
|
||
<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">OptionStep</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#OptionStep"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionStep" 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>
|
||
<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>
|
||
<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.OptionStep.__abstractmethods__">
|
||
<span class="sig-name descname"><span class="pre">__abstractmethods__</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">frozenset({})</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionStep.__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.OptionStep.__annotations__">
|
||
<span class="sig-name descname"><span class="pre">__annotations__</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'__class_vars__':</span> <span class="pre">'ClassVar[set[str]]',</span> <span class="pre">'__private_attributes__':</span> <span class="pre">'ClassVar[Dict[str,</span> <span class="pre">ModelPrivateAttr]]',</span> <span class="pre">'__pydantic_complete__':</span> <span class="pre">'ClassVar[bool]',</span> <span class="pre">'__pydantic_core_schema__':</span> <span class="pre">'ClassVar[CoreSchema]',</span> <span class="pre">'__pydantic_custom_init__':</span> <span class="pre">'ClassVar[bool]',</span> <span class="pre">'__pydantic_decorators__':</span> <span class="pre">'ClassVar[_decorators.DecoratorInfos]',</span> <span class="pre">'__pydantic_extra__':</span> <span class="pre">'dict[str,</span> <span class="pre">Any]</span> <span class="pre">|</span> <span class="pre">None',</span> <span class="pre">'__pydantic_fields_set__':</span> <span class="pre">'set[str]',</span> <span class="pre">'__pydantic_generic_metadata__':</span> <span class="pre">'ClassVar[_generics.PydanticGenericMetadata]',</span> <span class="pre">'__pydantic_parent_namespace__':</span> <span class="pre">'ClassVar[Dict[str,</span> <span class="pre">Any]</span> <span class="pre">|</span> <span class="pre">None]',</span> <span class="pre">'__pydantic_post_init__':</span> <span class="pre">"ClassVar[None</span> <span class="pre">|</span> <span class="pre">Literal['model_post_init']]",</span> <span class="pre">'__pydantic_private__':</span> <span class="pre">'dict[str,</span> <span class="pre">Any]</span> <span class="pre">|</span> <span class="pre">None',</span> <span class="pre">'__pydantic_root_model__':</span> <span class="pre">'ClassVar[bool]',</span> <span class="pre">'__pydantic_serializer__':</span> <span class="pre">'ClassVar[SchemaSerializer]',</span> <span class="pre">'__pydantic_validator__':</span> <span class="pre">'ClassVar[SchemaValidator</span> <span class="pre">|</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"><class</span> <span class="pre">'bool'>,</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.OptionStep.__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.OptionStep.__class_getitem__">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">__class_getitem__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">typevar_values</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionStep.__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.OptionStep.html#kittycad.models.input_format.OptionStep.type" title="kittycad.models.input_format.OptionStep.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.OptionStep.__class_vars__">
|
||
<span class="sig-name descname"><span class="pre">__class_vars__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[set[str]]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionStep.__class_vars__" title="Link to this definition"></a></dt>
|
||
<dd><p>The names of the class variables defined on the model.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionStep.__copy__">
|
||
<span class="sig-name descname"><span class="pre">__copy__</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionStep.__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>
|
||
<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.OptionStep.__deepcopy__">
|
||
<span class="sig-name descname"><span class="pre">__deepcopy__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">memo</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionStep.__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>
|
||
<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.OptionStep.__delattr__">
|
||
<span class="sig-name descname"><span class="pre">__delattr__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">item</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionStep.__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>
|
||
<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.OptionStep.__dict__">
|
||
<span class="sig-name descname"><span class="pre">__dict__</span></span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionStep.__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.OptionStep.__eq__">
|
||
<span class="sig-name descname"><span class="pre">__eq__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">other</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionStep.__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>
|
||
<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.OptionStep.__fields_set__">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">__fields_set__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#set" title="(in Python v3.12)"><span class="pre">set</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionStep.__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.OptionStep.__get_pydantic_core_schema__">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">__get_pydantic_core_schema__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">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.OptionStep.__get_pydantic_core_schema__" title="Link to this definition"></a></dt>
|
||
<dd><p>Hook into generating the model’s CoreSchema.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>source</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference internal" href="kittycad.models.input_format.OptionStep.html#kittycad.models.input_format.OptionStep.type" title="kittycad.models.input_format.OptionStep.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 Pydantic’s internal CoreSchema generation logic.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><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 class="xref py py-class docutils literal notranslate"><span class="pre">ModelFieldsSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">ModelSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">DataclassArgsSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">DataclassSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">ArgumentsSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">CallSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">CustomErrorSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">JsonSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">UrlSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">MultiHostUrlSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">DefinitionsSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">DefinitionReferenceSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">UuidSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">ComplexSchema</span></code>]</span></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<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.OptionStep.__get_pydantic_json_schema__">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">__get_pydantic_json_schema__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">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.OptionStep.__get_pydantic_json_schema__" title="Link to this definition"></a></dt>
|
||
<dd><p>Hook into generating the model’s JSON schema.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>core_schema</strong> (<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 class="xref py py-class docutils literal notranslate"><span class="pre">ModelFieldsSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">ModelSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">DataclassArgsSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">DataclassSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">ArgumentsSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">CallSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">CustomErrorSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">JsonSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">UrlSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">MultiHostUrlSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">DefinitionsSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">DefinitionReferenceSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">UuidSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">ComplexSchema</span></code>]</span>) – A <code class="xref any docutils literal notranslate"><span class="pre">pydantic-core</span></code> CoreSchema.
|
||
You can ignore this argument and call the handler with a new CoreSchema,
|
||
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>
|
||
<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 Pydantic’s 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.
|
||
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>
|
||
<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.OptionStep.__getattr__">
|
||
<span class="sig-name descname"><span class="pre">__getattr__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">item</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionStep.__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>
|
||
<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.OptionStep.__getstate__">
|
||
<span class="sig-name descname"><span class="pre">__getstate__</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionStep.__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>
|
||
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><a class="reference internal" href="kittycad.models.input_format.OptionStep.html#kittycad.models.input_format.OptionStep.dict" title="kittycad.models.input_format.OptionStep.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.OptionStep.__hash__">
|
||
<span class="sig-name descname"><span class="pre">__hash__</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionStep.__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.OptionStep.__init__">
|
||
<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">data</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionStep.__init__" title="Link to this definition"></a></dt>
|
||
<dd><p>Create a new model by parsing and validating input data from keyword arguments.</p>
|
||
<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>
|
||
<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.OptionStep.__iter__">
|
||
<span class="sig-name descname"><span class="pre">__iter__</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionStep.__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>
|
||
<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.OptionStep.__module__">
|
||
<span class="sig-name descname"><span class="pre">__module__</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'kittycad.models.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.OptionStep.__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.OptionStep.__pretty__">
|
||
<span class="sig-name descname"><span class="pre">__pretty__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">fmt</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionStep.__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>
|
||
<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.OptionStep.__private_attributes__">
|
||
<span class="sig-name descname"><span class="pre">__private_attributes__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[Dict[str,</span> <span class="pre">ModelPrivateAttr]]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionStep.__private_attributes__" title="Link to this definition"></a></dt>
|
||
<dd><p>Metadata about the private attributes of the model.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionStep.__pydantic_complete__">
|
||
<span class="sig-name descname"><span class="pre">__pydantic_complete__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[bool]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">True</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionStep.__pydantic_complete__" title="Link to this definition"></a></dt>
|
||
<dd><p>Whether model building is completed, or if there are still undefined fields.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionStep.__pydantic_core_schema__">
|
||
<span class="sig-name descname"><span class="pre">__pydantic_core_schema__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[CoreSchema]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'cls':</span> <span class="pre"><class</span> <span class="pre">'kittycad.models.input_format.OptionStep'>,</span> <span class="pre">'config':</span> <span class="pre">{'title':</span> <span class="pre">'OptionStep'},</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(<function</span> <span class="pre">modify_model_json_schema>,</span> <span class="pre">cls=<class</span> <span class="pre">'kittycad.models.input_format.OptionStep'>,</span> <span class="pre">title=None),</span> <span class="pre"><bound</span> <span class="pre">method</span> <span class="pre">BaseModel.__get_pydantic_json_schema__</span> <span class="pre">of</span> <span class="pre"><class</span> <span class="pre">'kittycad.models.input_format.OptionStep'>>]},</span> <span class="pre">'ref':</span> <span class="pre">'kittycad.models.input_format.OptionStep:94740974234128',</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">[<function</span> <span class="pre">get_json_schema_update_func.<locals>.json_schema_update_func>],</span> <span class="pre">'pydantic_js_functions':</span> <span class="pre">[]},</span> <span class="pre">'schema':</span> <span class="pre">{'default':</span> <span class="pre">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">[<function</span> <span class="pre">get_json_schema_update_func.<locals>.json_schema_update_func>],</span> <span class="pre">'pydantic_js_functions':</span> <span class="pre">[]},</span> <span class="pre">'schema':</span> <span class="pre">{'default':</span> <span class="pre">'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">'OptionStep',</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.OptionStep.__pydantic_core_schema__" title="Link to this definition"></a></dt>
|
||
<dd><p>The core schema of the model.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionStep.__pydantic_custom_init__">
|
||
<span class="sig-name descname"><span class="pre">__pydantic_custom_init__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[bool]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">False</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionStep.__pydantic_custom_init__" title="Link to this definition"></a></dt>
|
||
<dd><p>Whether the model has a custom <a class="reference internal" href="kittycad.models.input_format.OptionStep.html#id0" title="kittycad.models.input_format.OptionStep.__init__"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">__init__</span></code></a> method.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionStep.__pydantic_decorators__">
|
||
<span class="sig-name descname"><span class="pre">__pydantic_decorators__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[_decorators.DecoratorInfos]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">DecoratorInfos(validators={},</span> <span class="pre">field_validators={},</span> <span class="pre">root_validators={},</span> <span class="pre">field_serializers={},</span> <span class="pre">model_serializers={},</span> <span class="pre">model_validators={},</span> <span class="pre">computed_fields={})</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionStep.__pydantic_decorators__" title="Link to this definition"></a></dt>
|
||
<dd><p>Metadata containing the decorators defined on the model.
|
||
This replaces <code class="xref any docutils literal notranslate"><span class="pre">Model.__validators__</span></code> and <code class="xref any docutils literal notranslate"><span class="pre">Model.__root_validators__</span></code> from Pydantic V1.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionStep.__pydantic_extra__">
|
||
<span class="sig-name descname"><span class="pre">__pydantic_extra__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">dict[str,</span> <span class="pre">Any]</span> <span class="pre">|</span> <span class="pre">None</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionStep.__pydantic_extra__" title="Link to this definition"></a></dt>
|
||
<dd><p>A dictionary containing extra values, if [<a class="reference internal" href="kittycad.models.kcl_code_completion_request.KclCodeCompletionRequest.html#kittycad.models.kcl_code_completion_request.KclCodeCompletionRequest.extra" title="kittycad.models.kcl_code_completion_request.KclCodeCompletionRequest.extra"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">extra</span></code></a>][pydantic.config.ConfigDict.extra] is set to <code class="xref any docutils literal notranslate"><span class="pre">'allow'</span></code>.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionStep.__pydantic_fields_set__">
|
||
<span class="sig-name descname"><span class="pre">__pydantic_fields_set__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">set[str]</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionStep.__pydantic_fields_set__" title="Link to this definition"></a></dt>
|
||
<dd><p>The names of fields explicitly set during instantiation.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionStep.__pydantic_generic_metadata__">
|
||
<span class="sig-name descname"><span class="pre">__pydantic_generic_metadata__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[_generics.PydanticGenericMetadata]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'args':</span> <span class="pre">(),</span> <span class="pre">'origin':</span> <span class="pre">None,</span> <span class="pre">'parameters':</span> <span class="pre">()}</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionStep.__pydantic_generic_metadata__" title="Link to this definition"></a></dt>
|
||
<dd><p>Metadata for generic models; contains data used for a similar purpose to
|
||
__args__, __origin__, __parameters__ in typing-module generics. May eventually be replaced by these.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionStep.__pydantic_init_subclass__">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">__pydantic_init_subclass__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionStep.__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.OptionStep.html#kittycad.models.input_format.OptionStep.model_fields" title="kittycad.models.input_format.OptionStep.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>
|
||
<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 aren’t used internally by pydantic.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>**kwargs</strong> (<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 aren’t used internally
|
||
by pydantic.</p>
|
||
</dd>
|
||
<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/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.OptionStep.__pydantic_parent_namespace__">
|
||
<span class="sig-name descname"><span class="pre">__pydantic_parent_namespace__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[Dict[str,</span> <span class="pre">Any]</span> <span class="pre">|</span> <span class="pre">None]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">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.OptionStep.__pydantic_parent_namespace__" title="Link to this definition"></a></dt>
|
||
<dd><p>Parent namespace of the model, used for automatic rebuilding of models.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionStep.__pydantic_post_init__">
|
||
<span class="sig-name descname"><span class="pre">__pydantic_post_init__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[None</span> <span class="pre">|</span> <span class="pre">Literal['model_post_init']]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionStep.__pydantic_post_init__" title="Link to this definition"></a></dt>
|
||
<dd><p>The name of the post-init method for the model, if defined.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionStep.__pydantic_private__">
|
||
<span class="sig-name descname"><span class="pre">__pydantic_private__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">dict[str,</span> <span class="pre">Any]</span> <span class="pre">|</span> <span class="pre">None</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionStep.__pydantic_private__" title="Link to this definition"></a></dt>
|
||
<dd><p>Values of private attributes set on the model instance.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionStep.__pydantic_root_model__">
|
||
<span class="sig-name descname"><span class="pre">__pydantic_root_model__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[bool]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">False</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionStep.__pydantic_root_model__" title="Link to this definition"></a></dt>
|
||
<dd><p>Whether the model is a [<code class="xref any docutils literal notranslate"><span class="pre">RootModel</span></code>][pydantic.root_model.RootModel].</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionStep.__pydantic_serializer__">
|
||
<span class="sig-name descname"><span class="pre">__pydantic_serializer__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[SchemaSerializer]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">SchemaSerializer(serializer=Model(</span>     <span class="pre">ModelSerializer</span> <span class="pre">{</span>         <span class="pre">class:</span> <span class="pre">Py(</span>             <span class="pre">0x0000562a9a1d6a10,</span>         <span class="pre">),</span>         <span class="pre">serializer:</span> <span class="pre">Fields(</span>             <span class="pre">GeneralFieldsSerializer</span> <span class="pre">{</span>                 <span class="pre">fields:</span> <span class="pre">{</span>                     <span class="pre">"type":</span> <span class="pre">SerField</span> <span class="pre">{</span>                         <span class="pre">key_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007f936f623938,</span>                         <span class="pre">),</span>                         <span class="pre">alias:</span> <span class="pre">None,</span>                         <span class="pre">alias_py:</span> <span class="pre">None,</span>                         <span class="pre">serializer:</span> <span class="pre">Some(</span>                             <span class="pre">WithDefault(</span>                                 <span class="pre">WithDefaultSerializer</span> <span class="pre">{</span>                                     <span class="pre">default:</span> <span class="pre">Default(</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007f936f6231a8,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                     <span class="pre">serializer:</span> <span class="pre">Literal(</span>                                         <span class="pre">LiteralSerializer</span> <span class="pre">{</span>                                             <span class="pre">expected_int:</span> <span class="pre">{},</span>                                             <span class="pre">expected_str:</span> <span class="pre">{</span>                                                 <span class="pre">"step",</span>                                             <span class="pre">},</span>                                             <span class="pre">expected_py:</span> <span class="pre">None,</span>                                             <span class="pre">name:</span> <span class="pre">"literal['step']",</span>                                         <span class="pre">},</span>                                     <span class="pre">),</span>                                 <span class="pre">},</span>                             <span class="pre">),</span>                         <span class="pre">),</span>                         <span class="pre">required:</span> <span class="pre">true,</span>                     <span class="pre">},</span>                     <span class="pre">"split_closed_faces":</span> <span class="pre">SerField</span> <span class="pre">{</span>                         <span class="pre">key_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007f936af742b0,</span>                         <span class="pre">),</span>                         <span class="pre">alias:</span> <span class="pre">None,</span>                         <span class="pre">alias_py:</span> <span class="pre">None,</span>                         <span class="pre">serializer:</span> <span class="pre">Some(</span>                             <span class="pre">WithDefault(</span>                                 <span class="pre">WithDefaultSerializer</span> <span class="pre">{</span>                                     <span class="pre">default:</span> <span class="pre">Default(</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007f936f517d00,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                     <span class="pre">serializer:</span> <span class="pre">Bool(</span>                                         <span class="pre">BoolSerializer,</span>                                     <span class="pre">),</span>                                 <span class="pre">},</span>                             <span class="pre">),</span>                         <span class="pre">),</span>                         <span class="pre">required:</span> <span class="pre">true,</span>                     <span class="pre">},</span>                 <span class="pre">},</span>                 <span class="pre">computed_fields:</span> <span class="pre">Some(</span>                     <span class="pre">ComputedFields(</span>                         <span class="pre">[],</span>                     <span class="pre">),</span>                 <span class="pre">),</span>                 <span class="pre">mode:</span> <span class="pre">SimpleDict,</span>                 <span class="pre">extra_serializer:</span> <span class="pre">None,</span>                 <span class="pre">filter:</span> <span class="pre">SchemaFilter</span> <span class="pre">{</span>                     <span class="pre">include:</span> <span class="pre">None,</span>                     <span class="pre">exclude:</span> <span class="pre">None,</span>                 <span class="pre">},</span>                 <span class="pre">required_fields:</span> <span class="pre">2,</span>             <span class="pre">},</span>         <span class="pre">),</span>         <span class="pre">has_extra:</span> <span class="pre">false,</span>         <span class="pre">root_model:</span> <span class="pre">false,</span>         <span class="pre">name:</span> <span class="pre">"OptionStep",</span>     <span class="pre">},</span> <span class="pre">),</span> <span class="pre">definitions=[])</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.OptionStep.__pydantic_serializer__" title="Link to this definition"></a></dt>
|
||
<dd><p>The <code class="xref any docutils literal notranslate"><span class="pre">pydantic-core</span></code> <code class="xref any docutils literal notranslate"><span class="pre">SchemaSerializer</span></code> used to dump instances of the model.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionStep.__pydantic_validator__">
|
||
<span class="sig-name descname"><span class="pre">__pydantic_validator__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[SchemaValidator</span> <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="OptionStep",</span> <span class="pre">validator=Model(</span>     <span class="pre">ModelValidator</span> <span class="pre">{</span>         <span class="pre">revalidate:</span> <span class="pre">Never,</span>         <span class="pre">validator:</span> <span class="pre">ModelFields(</span>             <span class="pre">ModelFieldsValidator</span> <span class="pre">{</span>                 <span class="pre">fields:</span> <span class="pre">[</span>                     <span class="pre">Field</span> <span class="pre">{</span>                         <span class="pre">name:</span> <span class="pre">"split_closed_faces",</span>                         <span class="pre">lookup_key:</span> <span class="pre">Simple</span> <span class="pre">{</span>                             <span class="pre">key:</span> <span class="pre">"split_closed_faces",</span>                             <span class="pre">py_key:</span> <span class="pre">Py(</span>                                 <span class="pre">0x00007f936af74fb0,</span>                             <span class="pre">),</span>                             <span class="pre">path:</span> <span class="pre">LookupPath(</span>                                 <span class="pre">[</span>                                     <span class="pre">S(</span>                                         <span class="pre">"split_closed_faces",</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007f936af75970,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                 <span class="pre">],</span>                             <span class="pre">),</span>                         <span class="pre">},</span>                         <span class="pre">name_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007f936af742b0,</span>                         <span class="pre">),</span>                         <span class="pre">validator:</span> <span class="pre">WithDefault(</span>                             <span class="pre">WithDefaultValidator</span> <span class="pre">{</span>                                 <span class="pre">default:</span> <span class="pre">Default(</span>                                     <span class="pre">Py(</span>                                         <span class="pre">0x00007f936f517d00,</span>                                     <span class="pre">),</span>                                 <span class="pre">),</span>                                 <span class="pre">on_error:</span> <span class="pre">Raise,</span>                                 <span class="pre">validator:</span> <span class="pre">Bool(</span>                                     <span class="pre">BoolValidator</span> <span class="pre">{</span>                                         <span class="pre">strict:</span> <span class="pre">false,</span>                                     <span class="pre">},</span>                                 <span class="pre">),</span>                                 <span class="pre">validate_default:</span> <span class="pre">false,</span>                                 <span class="pre">copy_default:</span> <span class="pre">false,</span>                                 <span class="pre">name:</span> <span class="pre">"default[bool]",</span>                                 <span class="pre">undefined:</span> <span class="pre">Py(</span>                                     <span class="pre">0x00007f936d406320,</span>                                 <span class="pre">),</span>                             <span class="pre">},</span>                         <span class="pre">),</span>                         <span class="pre">frozen:</span> <span class="pre">false,</span>                     <span class="pre">},</span>                     <span class="pre">Field</span> <span class="pre">{</span>                         <span class="pre">name:</span> <span class="pre">"type",</span>                         <span class="pre">lookup_key:</span> <span class="pre">Simple</span> <span class="pre">{</span>                             <span class="pre">key:</span> <span class="pre">"type",</span>                             <span class="pre">py_key:</span> <span class="pre">Py(</span>                                 <span class="pre">0x00007f936b87b8d0,</span>                             <span class="pre">),</span>                             <span class="pre">path:</span> <span class="pre">LookupPath(</span>                                 <span class="pre">[</span>                                     <span class="pre">S(</span>                                         <span class="pre">"type",</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007f936b87ab50,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                 <span class="pre">],</span>                             <span class="pre">),</span>                         <span class="pre">},</span>                         <span class="pre">name_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007f936f623938,</span>                         <span class="pre">),</span>                         <span class="pre">validator:</span> <span class="pre">WithDefault(</span>                             <span class="pre">WithDefaultValidator</span> <span class="pre">{</span>                                 <span class="pre">default:</span> <span class="pre">Default(</span>                                     <span class="pre">Py(</span>                                         <span class="pre">0x00007f936f6231a8,</span>                                     <span class="pre">),</span>                                 <span class="pre">),</span>                                 <span class="pre">on_error:</span> <span class="pre">Raise,</span>                                 <span class="pre">validator:</span> <span class="pre">Literal(</span>                                     <span class="pre">LiteralValidator</span> <span class="pre">{</span>                                         <span class="pre">lookup:</span> <span class="pre">LiteralLookup</span> <span class="pre">{</span>                                             <span class="pre">expected_bool:</span> <span class="pre">None,</span>                                             <span class="pre">expected_int:</span> <span class="pre">None,</span>                                             <span class="pre">expected_str:</span> <span class="pre">Some(</span>                                                 <span class="pre">{</span>                                                     <span class="pre">"step":</span> <span class="pre">0,</span>                                                 <span class="pre">},</span>                                             <span class="pre">),</span>                                             <span class="pre">expected_py_dict:</span> <span class="pre">None,</span>                                             <span class="pre">expected_py_values:</span> <span class="pre">None,</span>                                             <span class="pre">values:</span> <span class="pre">[</span>                                                 <span class="pre">Py(</span>                                                     <span class="pre">0x00007f936f6231a8,</span>                                                 <span class="pre">),</span>                                             <span class="pre">],</span>                                         <span class="pre">},</span>                                         <span class="pre">expected_repr:</span> <span class="pre">"'step'",</span>                                         <span class="pre">name:</span> <span class="pre">"literal['step']",</span>                                     <span class="pre">},</span>                                 <span class="pre">),</span>                                 <span class="pre">validate_default:</span> <span class="pre">false,</span>                                 <span class="pre">copy_default:</span> <span class="pre">false,</span>                                 <span class="pre">name:</span> <span class="pre">"default[literal['step']]",</span>                                 <span class="pre">undefined:</span> <span class="pre">Py(</span>                                     <span class="pre">0x00007f936d406320,</span>                                 <span class="pre">),</span>                             <span class="pre">},</span>                         <span class="pre">),</span>                         <span class="pre">frozen:</span> <span class="pre">false,</span>                     <span class="pre">},</span>                 <span class="pre">],</span>                 <span class="pre">model_name:</span> <span class="pre">"OptionStep",</span>                 <span class="pre">extra_behavior:</span> <span class="pre">Ignore,</span>                 <span class="pre">extras_validator:</span> <span class="pre">None,</span>                 <span class="pre">strict:</span> <span class="pre">false,</span>                 <span class="pre">from_attributes:</span> <span class="pre">false,</span>                 <span class="pre">loc_by_alias:</span> <span class="pre">true,</span>             <span class="pre">},</span>         <span class="pre">),</span>         <span class="pre">class:</span> <span class="pre">Py(</span>             <span class="pre">0x0000562a9a1d6a10,</span>         <span class="pre">),</span>         <span class="pre">post_init:</span> <span class="pre">None,</span>         <span class="pre">frozen:</span> <span class="pre">false,</span>         <span class="pre">custom_init:</span> <span class="pre">false,</span>         <span class="pre">root_model:</span> <span class="pre">false,</span>         <span class="pre">undefined:</span> <span class="pre">Py(</span>             <span class="pre">0x00007f936d406320,</span>         <span class="pre">),</span>         <span class="pre">name:</span> <span class="pre">"OptionStep",</span>     <span class="pre">},</span> <span class="pre">),</span> <span class="pre">definitions=[],</span> <span class="pre">cache_strings=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.OptionStep.__pydantic_validator__" title="Link to this definition"></a></dt>
|
||
<dd><p>The <code class="xref any docutils literal notranslate"><span class="pre">pydantic-core</span></code> <code class="xref any docutils literal notranslate"><span class="pre">SchemaValidator</span></code> used to validate instances of the model.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionStep.__repr__">
|
||
<span class="sig-name descname"><span class="pre">__repr__</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionStep.__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>
|
||
<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.OptionStep.__repr_args__">
|
||
<span class="sig-name descname"><span class="pre">__repr_args__</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionStep.__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/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/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/typing.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.OptionStep.__repr_name__">
|
||
<span class="sig-name descname"><span class="pre">__repr_name__</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionStep.__repr_name__" title="Link to this definition"></a></dt>
|
||
<dd><p>Name of the instance’s class, used in __repr__.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><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.OptionStep.__repr_str__">
|
||
<span class="sig-name descname"><span class="pre">__repr_str__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">join_str</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionStep.__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>
|
||
<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.OptionStep.__rich_repr__">
|
||
<span class="sig-name descname"><span class="pre">__rich_repr__</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionStep.__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>
|
||
<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.OptionStep.__setattr__">
|
||
<span class="sig-name descname"><span class="pre">__setattr__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionStep.__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>
|
||
<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.OptionStep.__setstate__">
|
||
<span class="sig-name descname"><span class="pre">__setstate__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">state</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionStep.__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>
|
||
<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.OptionStep.__signature__">
|
||
<span class="sig-name descname"><span class="pre">__signature__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[Signature]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre"><Signature</span> <span class="pre">(*,</span> <span class="pre">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">-></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.OptionStep.__signature__" title="Link to this definition"></a></dt>
|
||
<dd><p>The synthesized <a class="reference internal" href="kittycad.models.input_format.OptionStep.html#id0" title="kittycad.models.input_format.OptionStep.__init__"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">__init__</span></code></a> [<code class="xref any docutils literal notranslate"><span class="pre">Signature</span></code>][inspect.Signature] of the model.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionStep.__slots__">
|
||
<span class="sig-name descname"><span class="pre">__slots__</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">('__dict__',</span> <span class="pre">'__pydantic_fields_set__',</span> <span class="pre">'__pydantic_extra__',</span> <span class="pre">'__pydantic_private__')</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionStep.__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.OptionStep.__str__">
|
||
<span class="sig-name descname"><span class="pre">__str__</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionStep.__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>
|
||
<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.OptionStep._abc_impl">
|
||
<span class="sig-name descname"><span class="pre">_abc_impl</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre"><_abc._abc_data</span> <span class="pre">object></span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionStep._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.OptionStep._calculate_keys">
|
||
<span class="sig-name descname"><span class="pre">_calculate_keys</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionStep._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>
|
||
<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.OptionStep._check_frozen">
|
||
<span class="sig-name descname"><span class="pre">_check_frozen</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionStep._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>
|
||
<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.OptionStep._copy_and_set_values">
|
||
<span class="sig-name descname"><span class="pre">_copy_and_set_values</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionStep._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>
|
||
<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.OptionStep._get_value">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">_get_value</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="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.OptionStep._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>
|
||
<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.OptionStep._iter">
|
||
<span class="sig-name descname"><span class="pre">_iter</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionStep._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>
|
||
<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.OptionStep.construct">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">construct</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_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.OptionStep.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>
|
||
<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.OptionStep.copy">
|
||
<span class="sig-name descname"><span class="pre">copy</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">include</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exclude</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">update</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">deep</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionStep.copy" title="Link to this definition"></a></dt>
|
||
<dd><p>Returns a copy of the model.</p>
|
||
<dl class="simple">
|
||
<dt>!!! warning “Deprecated”</dt><dd><p>This method is now deprecated; use <a class="reference internal" href="kittycad.models.input_format.OptionStep.html#kittycad.models.input_format.OptionStep.model_copy" title="kittycad.models.input_format.OptionStep.model_copy"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">model_copy</span></code></a> instead.</p>
|
||
</dd>
|
||
</dl>
|
||
<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">
|
||
<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>
|
||
<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.OptionStep.dict">
|
||
<span class="sig-name descname"><span class="pre">dict</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">include</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exclude</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">by_alias</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exclude_unset</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exclude_defaults</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exclude_none</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionStep.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>
|
||
<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.OptionStep.from_orm">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_orm</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">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.OptionStep.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>
|
||
<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.OptionStep.json">
|
||
<span class="sig-name descname"><span class="pre">json</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">include</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exclude</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">by_alias</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exclude_unset</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exclude_defaults</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exclude_none</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">encoder</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">PydanticUndefined</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">models_as_dict</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">PydanticUndefined</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">dumps_kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionStep.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>
|
||
<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.OptionStep.model_computed_fields">
|
||
<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.OptionStep.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.OptionStep.model_config">
|
||
<span class="sig-name descname"><span class="pre">model_config</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[ConfigDict]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'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.OptionStep.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.OptionStep.model_construct">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">model_construct</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_fields_set</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">values</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionStep.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.OptionStep.html#kittycad.models.input_format.OptionStep.__dict__" title="kittycad.models.input_format.OptionStep.__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.OptionStep.html#kittycad.models.input_format.OptionStep.__pydantic_fields_set__" title="kittycad.models.input_format.OptionStep.__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.OptionStep.html#kittycad.models.input_format.OptionStep.model_construct" title="kittycad.models.input_format.OptionStep.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 instance’s <a class="reference internal" href="kittycad.models.input_format.OptionStep.html#kittycad.models.input_format.OptionStep.__dict__" title="kittycad.models.input_format.OptionStep.__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.OptionStep.html#kittycad.models.input_format.OptionStep.__pydantic_extra__" title="kittycad.models.input_format.OptionStep.__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.OptionStep.html#kittycad.models.input_format.OptionStep.model_construct" title="kittycad.models.input_format.OptionStep.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">
|
||
<li><p><strong>_fields_set</strong> (<span class="sphinx_autodoc_typehints-type"><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>] | <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 field names that were originally explicitly set during instantiation. If provided,
|
||
this is directly used for the [<a class="reference internal" href="kittycad.models.input_format.OptionStep.html#kittycad.models.input_format.OptionStep.model_fields_set" title="kittycad.models.input_format.OptionStep.model_fields_set"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">model_fields_set</span></code></a>][pydantic.BaseModel.model_fields_set] attribute.
|
||
Otherwise, the field names from the <code class="xref any docutils literal notranslate"><span class="pre">values</span></code> argument will be used.</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>
|
||
<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>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.OptionStep.model_copy">
|
||
<span class="sig-name descname"><span class="pre">model_copy</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">update</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">deep</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionStep.model_copy" title="Link to this definition"></a></dt>
|
||
<dd><p>Usage docs: <a class="reference external" href="https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy">https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy</a></p>
|
||
<p>Returns a copy of the model.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>update</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference internal" href="kittycad.models.input_format.OptionStep.html#kittycad.models.input_format.OptionStep.dict" title="kittycad.models.input_format.OptionStep.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>] | <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>) – Values to change/add in the new model. Note: the data is not validated
|
||
before creating the new model. You should trust this data.</p></li>
|
||
<li><p><strong>deep</strong> (<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>
|
||
<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.OptionStep.model_dump">
|
||
<span class="sig-name descname"><span class="pre">model_dump</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mode</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'python'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">include</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exclude</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">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.OptionStep.model_dump" title="Link to this definition"></a></dt>
|
||
<dd><p>Usage docs: <a class="reference external" href="https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump">https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump</a></p>
|
||
<p>Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>mode</strong> (<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.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.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.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[IncEx, <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">True</span></code>]]], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[IncEx, <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">True</span></code>]]], <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">True</span></code>]]], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.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.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[IncEx, <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">True</span></code>]]], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[IncEx, <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">True</span></code>]]], <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">True</span></code>]]], <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.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.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.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[IncEx, <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">True</span></code>]]], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[IncEx, <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">True</span></code>]]], <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">True</span></code>]]], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.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.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[IncEx, <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">True</span></code>]]], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[IncEx, <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">True</span></code>]]], <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">True</span></code>]]], <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.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>) – 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 field’s 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>
|
||
<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.OptionStep.html#kittycad.models.input_format.OptionStep.dict" title="kittycad.models.input_format.OptionStep.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.OptionStep.model_dump_json">
|
||
<span class="sig-name descname"><span class="pre">model_dump_json</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">indent</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">include</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exclude</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">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.OptionStep.model_dump_json" title="Link to this definition"></a></dt>
|
||
<dd><p>Usage docs: <a class="reference external" href="https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json">https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json</a></p>
|
||
<p>Generates a JSON representation of the model using Pydantic’s <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">
|
||
<li><p><strong>indent</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> | <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>) – 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.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.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.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[IncEx, <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">True</span></code>]]], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[IncEx, <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">True</span></code>]]], <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">True</span></code>]]], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.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.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[IncEx, <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">True</span></code>]]], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[IncEx, <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">True</span></code>]]], <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">True</span></code>]]], <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.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.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.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[IncEx, <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">True</span></code>]]], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[IncEx, <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">True</span></code>]]], <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">True</span></code>]]], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.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.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[IncEx, <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">True</span></code>]]], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[IncEx, <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">True</span></code>]]], <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">True</span></code>]]], <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.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>) – 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>
|
||
<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.OptionStep.model_extra">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">model_extra</span></span><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.OptionStep.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>
|
||
<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">"allow"</span></code>.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionStep.model_fields">
|
||
<span class="sig-name descname"><span class="pre">model_fields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[Dict[str,</span> <span class="pre">FieldInfo]]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'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.OptionStep.model_fields" title="Link to this definition"></a></dt>
|
||
<dd><p>Metadata about the fields defined on the model,
|
||
mapping of field names to [<code class="xref any docutils literal notranslate"><span class="pre">FieldInfo</span></code>][pydantic.fields.FieldInfo] objects.</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.OptionStep.model_fields_set">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">model_fields_set</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#set" title="(in Python v3.12)"><span class="pre">set</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionStep.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.OptionStep.model_json_schema">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">model_json_schema</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">by_alias=True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ref_template='#/$defs/{model}'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">schema_generator=<class</span> <span class="pre">'pydantic.json_schema.GenerateJsonSchema'></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mode='validation'</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionStep.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">
|
||
<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.OptionStep.html#kittycad.models.input_format.OptionStep.type" title="kittycad.models.input_format.OptionStep.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>
|
||
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><a class="reference internal" href="kittycad.models.input_format.OptionStep.html#kittycad.models.input_format.OptionStep.dict" title="kittycad.models.input_format.OptionStep.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.OptionStep.model_parametrized_name">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">model_parametrized_name</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">params</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionStep.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>
|
||
<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.OptionStep.html#kittycad.models.input_format.OptionStep.type" title="kittycad.models.input_format.OptionStep.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>
|
||
<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>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.OptionStep.model_post_init">
|
||
<span class="sig-name descname"><span class="pre">model_post_init</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_BaseModel__context</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionStep.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.OptionStep.html#id0" title="kittycad.models.input_format.OptionStep.__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.OptionStep.html#kittycad.models.input_format.OptionStep.model_construct" title="kittycad.models.input_format.OptionStep.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>
|
||
<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.OptionStep.model_rebuild">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">model_rebuild</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">force</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">raise_errors</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_parent_namespace_depth</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">2</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_types_namespace</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionStep.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">
|
||
<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 internal" href="kittycad.models.input_format.OptionStep.html#kittycad.models.input_format.OptionStep.dict" title="kittycad.models.input_format.OptionStep.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>] | <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>) – 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>
|
||
<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/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/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>
|
||
<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.OptionStep.model_validate">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">model_validate</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">obj</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">strict</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">from_attributes</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">context</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionStep.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">
|
||
<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/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/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>) – 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/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/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>) – 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.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>) – Additional context to pass to the validator.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><strong>ValidationError</strong> – If the object could not be validated.</p>
|
||
</dd>
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><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.OptionStep.model_validate_json">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">model_validate_json</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">json_data</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">strict</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">context</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionStep.model_validate_json" title="Link to this definition"></a></dt>
|
||
<dd><p>Usage docs: <a class="reference external" href="https://docs.pydantic.dev/2.9/concepts/json/#json-parsing">https://docs.pydantic.dev/2.9/concepts/json/#json-parsing</a></p>
|
||
<p>Validate the given JSON data against the Pydantic model.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>json_data</strong> (<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/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/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>) – 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.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>) – Extra variables to pass to the validator.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><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>
|
||
<dd class="field-even"><p><strong>ValidationError</strong> – If <code class="xref any docutils literal notranslate"><span class="pre">json_data</span></code> is not a JSON string or the object could not be validated.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionStep.model_validate_strings">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">model_validate_strings</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">obj</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">strict</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">context</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionStep.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">
|
||
<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/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/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>) – 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.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>) – Extra variables to pass to the validator.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><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.OptionStep.parse_file">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">parse_file</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">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.OptionStep.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>
|
||
<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.OptionStep.parse_obj">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">parse_obj</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">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.OptionStep.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>
|
||
<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.OptionStep.parse_raw">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">parse_raw</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">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.OptionStep.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>
|
||
<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.OptionStep.schema">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">schema</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">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.OptionStep.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>
|
||
<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.OptionStep.schema_json">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">schema_json</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="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.OptionStep.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>
|
||
<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.OptionStep.split_closed_faces">
|
||
<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.OptionStep.split_closed_faces" 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.OptionStep.type">
|
||
<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.OptionStep.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.OptionStep.update_forward_refs">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">update_forward_refs</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="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.OptionStep.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>
|
||
<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.OptionStep.validate">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">validate</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">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.OptionStep.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>
|
||
<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.OptionStl">
|
||
<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">OptionStl</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#OptionStl"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionStl" 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>
|
||
<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>
|
||
<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.OptionStl.__abstractmethods__">
|
||
<span class="sig-name descname"><span class="pre">__abstractmethods__</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">frozenset({})</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionStl.__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.OptionStl.__annotations__">
|
||
<span class="sig-name descname"><span class="pre">__annotations__</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'__class_vars__':</span> <span class="pre">'ClassVar[set[str]]',</span> <span class="pre">'__private_attributes__':</span> <span class="pre">'ClassVar[Dict[str,</span> <span class="pre">ModelPrivateAttr]]',</span> <span class="pre">'__pydantic_complete__':</span> <span class="pre">'ClassVar[bool]',</span> <span class="pre">'__pydantic_core_schema__':</span> <span class="pre">'ClassVar[CoreSchema]',</span> <span class="pre">'__pydantic_custom_init__':</span> <span class="pre">'ClassVar[bool]',</span> <span class="pre">'__pydantic_decorators__':</span> <span class="pre">'ClassVar[_decorators.DecoratorInfos]',</span> <span class="pre">'__pydantic_extra__':</span> <span class="pre">'dict[str,</span> <span class="pre">Any]</span> <span class="pre">|</span> <span class="pre">None',</span> <span class="pre">'__pydantic_fields_set__':</span> <span class="pre">'set[str]',</span> <span class="pre">'__pydantic_generic_metadata__':</span> <span class="pre">'ClassVar[_generics.PydanticGenericMetadata]',</span> <span class="pre">'__pydantic_parent_namespace__':</span> <span class="pre">'ClassVar[Dict[str,</span> <span class="pre">Any]</span> <span class="pre">|</span> <span class="pre">None]',</span> <span class="pre">'__pydantic_post_init__':</span> <span class="pre">"ClassVar[None</span> <span class="pre">|</span> <span class="pre">Literal['model_post_init']]",</span> <span class="pre">'__pydantic_private__':</span> <span class="pre">'dict[str,</span> <span class="pre">Any]</span> <span class="pre">|</span> <span class="pre">None',</span> <span class="pre">'__pydantic_root_model__':</span> <span class="pre">'ClassVar[bool]',</span> <span class="pre">'__pydantic_serializer__':</span> <span class="pre">'ClassVar[SchemaSerializer]',</span> <span class="pre">'__pydantic_validator__':</span> <span class="pre">'ClassVar[SchemaValidator</span> <span class="pre">|</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"><class</span> <span class="pre">'kittycad.models.system.System'>,</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"><enum</span> <span class="pre">'UnitLength'>}</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.OptionStl.__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.OptionStl.__class_getitem__">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">__class_getitem__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">typevar_values</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionStl.__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.OptionStl.html#kittycad.models.input_format.OptionStl.type" title="kittycad.models.input_format.OptionStl.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.OptionStl.__class_vars__">
|
||
<span class="sig-name descname"><span class="pre">__class_vars__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[set[str]]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionStl.__class_vars__" title="Link to this definition"></a></dt>
|
||
<dd><p>The names of the class variables defined on the model.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionStl.__copy__">
|
||
<span class="sig-name descname"><span class="pre">__copy__</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionStl.__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>
|
||
<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.OptionStl.__deepcopy__">
|
||
<span class="sig-name descname"><span class="pre">__deepcopy__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">memo</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionStl.__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>
|
||
<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.OptionStl.__delattr__">
|
||
<span class="sig-name descname"><span class="pre">__delattr__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">item</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionStl.__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>
|
||
<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.OptionStl.__dict__">
|
||
<span class="sig-name descname"><span class="pre">__dict__</span></span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionStl.__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.OptionStl.__eq__">
|
||
<span class="sig-name descname"><span class="pre">__eq__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">other</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionStl.__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>
|
||
<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.OptionStl.__fields_set__">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">__fields_set__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#set" title="(in Python v3.12)"><span class="pre">set</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionStl.__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.OptionStl.__get_pydantic_core_schema__">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">__get_pydantic_core_schema__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">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.OptionStl.__get_pydantic_core_schema__" title="Link to this definition"></a></dt>
|
||
<dd><p>Hook into generating the model’s CoreSchema.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>source</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference internal" href="kittycad.models.input_format.OptionStl.html#kittycad.models.input_format.OptionStl.type" title="kittycad.models.input_format.OptionStl.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 Pydantic’s internal CoreSchema generation logic.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><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 class="xref py py-class docutils literal notranslate"><span class="pre">ModelFieldsSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">ModelSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">DataclassArgsSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">DataclassSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">ArgumentsSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">CallSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">CustomErrorSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">JsonSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">UrlSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">MultiHostUrlSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">DefinitionsSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">DefinitionReferenceSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">UuidSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">ComplexSchema</span></code>]</span></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<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.OptionStl.__get_pydantic_json_schema__">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">__get_pydantic_json_schema__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">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.OptionStl.__get_pydantic_json_schema__" title="Link to this definition"></a></dt>
|
||
<dd><p>Hook into generating the model’s JSON schema.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>core_schema</strong> (<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 class="xref py py-class docutils literal notranslate"><span class="pre">ModelFieldsSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">ModelSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">DataclassArgsSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">DataclassSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">ArgumentsSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">CallSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">CustomErrorSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">JsonSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">UrlSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">MultiHostUrlSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">DefinitionsSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">DefinitionReferenceSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">UuidSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">ComplexSchema</span></code>]</span>) – A <code class="xref any docutils literal notranslate"><span class="pre">pydantic-core</span></code> CoreSchema.
|
||
You can ignore this argument and call the handler with a new CoreSchema,
|
||
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>
|
||
<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 Pydantic’s 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.
|
||
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>
|
||
<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.OptionStl.__getattr__">
|
||
<span class="sig-name descname"><span class="pre">__getattr__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">item</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionStl.__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>
|
||
<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.OptionStl.__getstate__">
|
||
<span class="sig-name descname"><span class="pre">__getstate__</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionStl.__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>
|
||
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><a class="reference internal" href="kittycad.models.input_format.OptionStl.html#kittycad.models.input_format.OptionStl.dict" title="kittycad.models.input_format.OptionStl.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.OptionStl.__hash__">
|
||
<span class="sig-name descname"><span class="pre">__hash__</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionStl.__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.OptionStl.__init__">
|
||
<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">data</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionStl.__init__" title="Link to this definition"></a></dt>
|
||
<dd><p>Create a new model by parsing and validating input data from keyword arguments.</p>
|
||
<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>
|
||
<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.OptionStl.__iter__">
|
||
<span class="sig-name descname"><span class="pre">__iter__</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionStl.__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>
|
||
<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.OptionStl.__module__">
|
||
<span class="sig-name descname"><span class="pre">__module__</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'kittycad.models.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.OptionStl.__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.OptionStl.__pretty__">
|
||
<span class="sig-name descname"><span class="pre">__pretty__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">fmt</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionStl.__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>
|
||
<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.OptionStl.__private_attributes__">
|
||
<span class="sig-name descname"><span class="pre">__private_attributes__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[Dict[str,</span> <span class="pre">ModelPrivateAttr]]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionStl.__private_attributes__" title="Link to this definition"></a></dt>
|
||
<dd><p>Metadata about the private attributes of the model.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionStl.__pydantic_complete__">
|
||
<span class="sig-name descname"><span class="pre">__pydantic_complete__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[bool]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">True</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionStl.__pydantic_complete__" title="Link to this definition"></a></dt>
|
||
<dd><p>Whether model building is completed, or if there are still undefined fields.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionStl.__pydantic_core_schema__">
|
||
<span class="sig-name descname"><span class="pre">__pydantic_core_schema__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[CoreSchema]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'definitions':</span> <span class="pre">[{'cls':</span> <span class="pre"><class</span> <span class="pre">'kittycad.models.axis_direction_pair.AxisDirectionPair'>,</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(<function</span> <span class="pre">modify_model_json_schema>,</span> <span class="pre">cls=<class</span> <span class="pre">'kittycad.models.axis_direction_pair.AxisDirectionPair'>,</span> <span class="pre">title=None),</span> <span class="pre"><bound</span> <span class="pre">method</span> <span class="pre">BaseModel.__get_pydantic_json_schema__</span> <span class="pre">of</span> <span class="pre"><class</span> <span class="pre">'kittycad.models.axis_direction_pair.AxisDirectionPair'>>]},</span> <span class="pre">'ref':</span> <span class="pre">'kittycad.models.axis_direction_pair.AxisDirectionPair:94740976732752',</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">[<function</span> <span class="pre">get_json_schema_update_func.<locals>.json_schema_update_func>],</span> <span class="pre">'pydantic_js_functions':</span> <span class="pre">[]},</span> <span class="pre">'schema':</span> <span class="pre">{'schema_ref':</span> <span class="pre">'kittycad.models.axis.Axis:94740976727632',</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">[<function</span> <span class="pre">get_json_schema_update_func.<locals>.json_schema_update_func>],</span> <span class="pre">'pydantic_js_functions':</span> <span class="pre">[]},</span> <span class="pre">'schema':</span> <span class="pre">{'schema_ref':</span> <span class="pre">'kittycad.models.direction.Direction:94740976730192',</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"><enum</span> <span class="pre">'Axis'>,</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">[<function</span> <span class="pre">GenerateSchema._enum_schema.<locals>.get_json_schema>]},</span> <span class="pre">'ref':</span> <span class="pre">'kittycad.models.axis.Axis:94740976727632',</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"><enum</span> <span class="pre">'Direction'>,</span> <span class="pre">'members':</span> <span class="pre">[Direction.POSITIVE,</span> <span class="pre">Direction.NEGATIVE],</span> <span class="pre">'metadata':</span> <span class="pre">{'pydantic_js_functions':</span> <span class="pre">[<function</span> <span class="pre">GenerateSchema._enum_schema.<locals>.get_json_schema>]},</span> <span class="pre">'ref':</span> <span class="pre">'kittycad.models.direction.Direction:94740976730192',</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">'schema':</span> <span class="pre">{'cls':</span> <span class="pre"><class</span> <span class="pre">'kittycad.models.input_format.OptionStl'>,</span> <span class="pre">'config':</span> <span class="pre">{'title':</span> <span class="pre">'OptionStl'},</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(<function</span> <span class="pre">modify_model_json_schema>,</span> <span class="pre">cls=<class</span> <span class="pre">'kittycad.models.input_format.OptionStl'>,</span> <span class="pre">title=None),</span> <span class="pre"><bound</span> <span class="pre">method</span> <span class="pre">BaseModel.__get_pydantic_json_schema__</span> <span class="pre">of</span> <span class="pre"><class</span> <span class="pre">'kittycad.models.input_format.OptionStl'>>]},</span> <span class="pre">'ref':</span> <span class="pre">'kittycad.models.input_format.OptionStl:94740974244144',</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">{'coords':</span> <span class="pre">{'metadata':</span> <span class="pre">{'pydantic_js_annotation_functions':</span> <span class="pre">[<function</span> <span class="pre">get_json_schema_update_func.<locals>.json_schema_update_func>],</span> <span class="pre">'pydantic_js_functions':</span> <span class="pre">[]},</span> <span class="pre">'schema':</span> <span class="pre">{'cls':</span> <span class="pre"><class</span> <span class="pre">'kittycad.models.system.System'>,</span> <span class="pre">'config':</span> <span class="pre">{'title':</span> <span class="pre">'System'},</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(<function</span> <span class="pre">modify_model_json_schema>,</span> <span class="pre">cls=<class</span> <span class="pre">'kittycad.models.system.System'>,</span> <span class="pre">title=None),</span> <span class="pre"><bound</span> <span class="pre">method</span> <span class="pre">BaseModel.__get_pydantic_json_schema__</span> <span class="pre">of</span> <span class="pre"><class</span> <span class="pre">'kittycad.models.system.System'>>]},</span> <span class="pre">'ref':</span> <span class="pre">'kittycad.models.system.System:94740976742480',</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">{'forward':</span> <span class="pre">{'metadata':</span> <span class="pre">{'pydantic_js_annotation_functions':</span> <span class="pre">[<function</span> <span class="pre">get_json_schema_update_func.<locals>.json_schema_update_func>],</span> <span class="pre">'pydantic_js_functions':</span> <span class="pre">[]},</span> <span class="pre">'schema':</span> <span class="pre">{'schema_ref':</span> <span class="pre">'kittycad.models.axis_direction_pair.AxisDirectionPair:94740976732752',</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">'up':</span> <span class="pre">{'metadata':</span> <span class="pre">{'pydantic_js_annotation_functions':</span> <span class="pre">[<function</span> <span class="pre">get_json_schema_update_func.<locals>.json_schema_update_func>],</span> <span class="pre">'pydantic_js_functions':</span> <span class="pre">[]},</span> <span class="pre">'schema':</span> <span class="pre">{'schema_ref':</span> <span class="pre">'kittycad.models.axis_direction_pair.AxisDirectionPair:94740976732752',</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">'System',</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">'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">[<function</span> <span class="pre">get_json_schema_update_func.<locals>.json_schema_update_func>],</span> <span class="pre">'pydantic_js_functions':</span> <span class="pre">[]},</span> <span class="pre">'schema':</span> <span class="pre">{'default':</span> <span class="pre">'stl',</span> <span class="pre">'schema':</span> <span class="pre">{'expected':</span> <span class="pre">['stl'],</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">'units':</span> <span class="pre">{'metadata':</span> <span class="pre">{'pydantic_js_annotation_functions':</span> <span class="pre">[<function</span> <span class="pre">get_json_schema_update_func.<locals>.json_schema_update_func>],</span> <span class="pre">'pydantic_js_functions':</span> <span class="pre">[]},</span> <span class="pre">'schema':</span> <span class="pre">{'cls':</span> <span class="pre"><enum</span> <span class="pre">'UnitLength'>,</span> <span class="pre">'members':</span> <span class="pre">[UnitLength.CM,</span> <span class="pre">UnitLength.FT,</span> <span class="pre">UnitLength.IN,</span> <span class="pre">UnitLength.M,</span> <span class="pre">UnitLength.MM,</span> <span class="pre">UnitLength.YD],</span> <span class="pre">'metadata':</span> <span class="pre">{'pydantic_js_functions':</span> <span class="pre">[<function</span> <span class="pre">GenerateSchema._enum_schema.<locals>.get_json_schema>]},</span> <span class="pre">'ref':</span> <span class="pre">'kittycad.models.unit_length.UnitLength:94740972900288',</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">'type':</span> <span class="pre">'model-field'}},</span> <span class="pre">'model_name':</span> <span class="pre">'OptionStl',</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">'type':</span> <span class="pre">'definitions'}</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.OptionStl.__pydantic_core_schema__" title="Link to this definition"></a></dt>
|
||
<dd><p>The core schema of the model.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionStl.__pydantic_custom_init__">
|
||
<span class="sig-name descname"><span class="pre">__pydantic_custom_init__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[bool]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">False</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionStl.__pydantic_custom_init__" title="Link to this definition"></a></dt>
|
||
<dd><p>Whether the model has a custom <a class="reference internal" href="kittycad.models.input_format.OptionStl.html#id0" title="kittycad.models.input_format.OptionStl.__init__"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">__init__</span></code></a> method.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionStl.__pydantic_decorators__">
|
||
<span class="sig-name descname"><span class="pre">__pydantic_decorators__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[_decorators.DecoratorInfos]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">DecoratorInfos(validators={},</span> <span class="pre">field_validators={},</span> <span class="pre">root_validators={},</span> <span class="pre">field_serializers={},</span> <span class="pre">model_serializers={},</span> <span class="pre">model_validators={},</span> <span class="pre">computed_fields={})</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionStl.__pydantic_decorators__" title="Link to this definition"></a></dt>
|
||
<dd><p>Metadata containing the decorators defined on the model.
|
||
This replaces <code class="xref any docutils literal notranslate"><span class="pre">Model.__validators__</span></code> and <code class="xref any docutils literal notranslate"><span class="pre">Model.__root_validators__</span></code> from Pydantic V1.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionStl.__pydantic_extra__">
|
||
<span class="sig-name descname"><span class="pre">__pydantic_extra__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">dict[str,</span> <span class="pre">Any]</span> <span class="pre">|</span> <span class="pre">None</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionStl.__pydantic_extra__" title="Link to this definition"></a></dt>
|
||
<dd><p>A dictionary containing extra values, if [<a class="reference internal" href="kittycad.models.kcl_code_completion_request.KclCodeCompletionRequest.html#kittycad.models.kcl_code_completion_request.KclCodeCompletionRequest.extra" title="kittycad.models.kcl_code_completion_request.KclCodeCompletionRequest.extra"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">extra</span></code></a>][pydantic.config.ConfigDict.extra] is set to <code class="xref any docutils literal notranslate"><span class="pre">'allow'</span></code>.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionStl.__pydantic_fields_set__">
|
||
<span class="sig-name descname"><span class="pre">__pydantic_fields_set__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">set[str]</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionStl.__pydantic_fields_set__" title="Link to this definition"></a></dt>
|
||
<dd><p>The names of fields explicitly set during instantiation.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionStl.__pydantic_generic_metadata__">
|
||
<span class="sig-name descname"><span class="pre">__pydantic_generic_metadata__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[_generics.PydanticGenericMetadata]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'args':</span> <span class="pre">(),</span> <span class="pre">'origin':</span> <span class="pre">None,</span> <span class="pre">'parameters':</span> <span class="pre">()}</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionStl.__pydantic_generic_metadata__" title="Link to this definition"></a></dt>
|
||
<dd><p>Metadata for generic models; contains data used for a similar purpose to
|
||
__args__, __origin__, __parameters__ in typing-module generics. May eventually be replaced by these.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionStl.__pydantic_init_subclass__">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">__pydantic_init_subclass__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionStl.__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.OptionStl.html#kittycad.models.input_format.OptionStl.model_fields" title="kittycad.models.input_format.OptionStl.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>
|
||
<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 aren’t used internally by pydantic.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>**kwargs</strong> (<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 aren’t used internally
|
||
by pydantic.</p>
|
||
</dd>
|
||
<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/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.OptionStl.__pydantic_parent_namespace__">
|
||
<span class="sig-name descname"><span class="pre">__pydantic_parent_namespace__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[Dict[str,</span> <span class="pre">Any]</span> <span class="pre">|</span> <span class="pre">None]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">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.OptionStl.__pydantic_parent_namespace__" title="Link to this definition"></a></dt>
|
||
<dd><p>Parent namespace of the model, used for automatic rebuilding of models.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionStl.__pydantic_post_init__">
|
||
<span class="sig-name descname"><span class="pre">__pydantic_post_init__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[None</span> <span class="pre">|</span> <span class="pre">Literal['model_post_init']]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionStl.__pydantic_post_init__" title="Link to this definition"></a></dt>
|
||
<dd><p>The name of the post-init method for the model, if defined.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionStl.__pydantic_private__">
|
||
<span class="sig-name descname"><span class="pre">__pydantic_private__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">dict[str,</span> <span class="pre">Any]</span> <span class="pre">|</span> <span class="pre">None</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionStl.__pydantic_private__" title="Link to this definition"></a></dt>
|
||
<dd><p>Values of private attributes set on the model instance.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionStl.__pydantic_root_model__">
|
||
<span class="sig-name descname"><span class="pre">__pydantic_root_model__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[bool]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">False</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionStl.__pydantic_root_model__" title="Link to this definition"></a></dt>
|
||
<dd><p>Whether the model is a [<code class="xref any docutils literal notranslate"><span class="pre">RootModel</span></code>][pydantic.root_model.RootModel].</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionStl.__pydantic_serializer__">
|
||
<span class="sig-name descname"><span class="pre">__pydantic_serializer__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[SchemaSerializer]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">SchemaSerializer(serializer=Model(</span>     <span class="pre">ModelSerializer</span> <span class="pre">{</span>         <span class="pre">class:</span> <span class="pre">Py(</span>             <span class="pre">0x0000562a9a1d9130,</span>         <span class="pre">),</span>         <span class="pre">serializer:</span> <span class="pre">Fields(</span>             <span class="pre">GeneralFieldsSerializer</span> <span class="pre">{</span>                 <span class="pre">fields:</span> <span class="pre">{</span>                     <span class="pre">"units":</span> <span class="pre">SerField</span> <span class="pre">{</span>                         <span class="pre">key_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007f936e37aa30,</span>                         <span class="pre">),</span>                         <span class="pre">alias:</span> <span class="pre">None,</span>                         <span class="pre">alias_py:</span> <span class="pre">None,</span>                         <span class="pre">serializer:</span> <span class="pre">Some(</span>                             <span class="pre">Enum(</span>                                 <span class="pre">EnumSerializer</span> <span class="pre">{</span>                                     <span class="pre">class:</span> <span class="pre">Py(</span>                                         <span class="pre">0x0000562a9a090fc0,</span>                                     <span class="pre">),</span>                                     <span class="pre">serializer:</span> <span class="pre">Some(</span>                                         <span class="pre">Str(</span>                                             <span class="pre">StrSerializer,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                 <span class="pre">},</span>                             <span class="pre">),</span>                         <span class="pre">),</span>                         <span class="pre">required:</span> <span class="pre">true,</span>                     <span class="pre">},</span>                     <span class="pre">"coords":</span> <span class="pre">SerField</span> <span class="pre">{</span>                         <span class="pre">key_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007f936b87a2e0,</span>                         <span class="pre">),</span>                         <span class="pre">alias:</span> <span class="pre">None,</span>                         <span class="pre">alias_py:</span> <span class="pre">None,</span>                         <span class="pre">serializer:</span> <span class="pre">Some(</span>                             <span class="pre">Model(</span>                                 <span class="pre">ModelSerializer</span> <span class="pre">{</span>                                     <span class="pre">class:</span> <span class="pre">Py(</span>                                         <span class="pre">0x0000562a9a43b050,</span>                                     <span class="pre">),</span>                                     <span class="pre">serializer:</span> <span class="pre">Fields(</span>                                         <span class="pre">GeneralFieldsSerializer</span> <span class="pre">{</span>                                             <span class="pre">fields:</span> <span class="pre">{</span>                                                 <span class="pre">"up":</span> <span class="pre">SerField</span> <span class="pre">{</span>                                                     <span class="pre">key_py:</span> <span class="pre">Py(</span>                                                         <span class="pre">0x00007f936e3777e0,</span>                                                     <span class="pre">),</span>                                                     <span class="pre">alias:</span> <span class="pre">None,</span>                                                     <span class="pre">alias_py:</span> <span class="pre">None,</span>                                                     <span class="pre">serializer:</span> <span class="pre">Some(</span>                                                         <span class="pre">Recursive(</span>                                                             <span class="pre">DefinitionRefSerializer</span> <span class="pre">{</span>                                                                 <span class="pre">definition:</span> <span class="pre">"...",</span>                                                                 <span class="pre">retry_with_lax_check:</span> <span class="pre">true,</span>                                                             <span class="pre">},</span>                                                         <span class="pre">),</span>                                                     <span class="pre">),</span>                                                     <span class="pre">required:</span> <span class="pre">true,</span>                                                 <span class="pre">},</span>                                                 <span class="pre">"forward":</span> <span class="pre">SerField</span> <span class="pre">{</span>                                                     <span class="pre">key_py:</span> <span class="pre">Py(</span>                                                         <span class="pre">0x00007f936b879b00,</span>                                                     <span class="pre">),</span>                                                     <span class="pre">alias:</span> <span class="pre">None,</span>                                                     <span class="pre">alias_py:</span> <span class="pre">None,</span>                                                     <span class="pre">serializer:</span> <span class="pre">Some(</span>                                                         <span class="pre">Recursive(</span>                                                             <span class="pre">DefinitionRefSerializer</span> <span class="pre">{</span>                                                                 <span class="pre">definition:</span> <span class="pre">"...",</span>                                                                 <span class="pre">retry_with_lax_check:</span> <span class="pre">true,</span>                                                             <span class="pre">},</span>                                                         <span class="pre">),</span>                                                     <span class="pre">),</span>                                                     <span class="pre">required:</span> <span class="pre">true,</span>                                                 <span class="pre">},</span>                                             <span class="pre">},</span>                                             <span class="pre">computed_fields:</span> <span class="pre">Some(</span>                                                 <span class="pre">ComputedFields(</span>                                                     <span class="pre">[],</span>                                                 <span class="pre">),</span>                                             <span class="pre">),</span>                                             <span class="pre">mode:</span> <span class="pre">SimpleDict,</span>                                             <span class="pre">extra_serializer:</span> <span class="pre">None,</span>                                             <span class="pre">filter:</span> <span class="pre">SchemaFilter</span> <span class="pre">{</span>                                                 <span class="pre">include:</span> <span class="pre">None,</span>                                                 <span class="pre">exclude:</span> <span class="pre">None,</span>                                             <span class="pre">},</span>                                             <span class="pre">required_fields:</span> <span class="pre">2,</span>                                         <span class="pre">},</span>                                     <span class="pre">),</span>                                     <span class="pre">has_extra:</span> <span class="pre">false,</span>                                     <span class="pre">root_model:</span> <span class="pre">false,</span>                                     <span class="pre">name:</span> <span class="pre">"System",</span>                                 <span class="pre">},</span>                             <span class="pre">),</span>                         <span class="pre">),</span>                         <span class="pre">required:</span> <span class="pre">true,</span>                     <span class="pre">},</span>                     <span class="pre">"type":</span> <span class="pre">SerField</span> <span class="pre">{</span>                         <span class="pre">key_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007f936f623938,</span>                         <span class="pre">),</span>                         <span class="pre">alias:</span> <span class="pre">None,</span>                         <span class="pre">alias_py:</span> <span class="pre">None,</span>                         <span class="pre">serializer:</span> <span class="pre">Some(</span>                             <span class="pre">WithDefault(</span>                                 <span class="pre">WithDefaultSerializer</span> <span class="pre">{</span>                                     <span class="pre">default:</span> <span class="pre">Default(</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007f936b879da0,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                     <span class="pre">serializer:</span> <span class="pre">Literal(</span>                                         <span class="pre">LiteralSerializer</span> <span class="pre">{</span>                                             <span class="pre">expected_int:</span> <span class="pre">{},</span>                                             <span class="pre">expected_str:</span> <span class="pre">{</span>                                                 <span class="pre">"stl",</span>                                             <span class="pre">},</span>                                             <span class="pre">expected_py:</span> <span class="pre">None,</span>                                             <span class="pre">name:</span> <span class="pre">"literal['stl']",</span>                                         <span class="pre">},</span>                                     <span class="pre">),</span>                                 <span class="pre">},</span>                             <span class="pre">),</span>                         <span class="pre">),</span>                         <span class="pre">required:</span> <span class="pre">true,</span>                     <span class="pre">},</span>                 <span class="pre">},</span>                 <span class="pre">computed_fields:</span> <span class="pre">Some(</span>                     <span class="pre">ComputedFields(</span>                         <span class="pre">[],</span>                     <span class="pre">),</span>                 <span class="pre">),</span>                 <span class="pre">mode:</span> <span class="pre">SimpleDict,</span>                 <span class="pre">extra_serializer:</span> <span class="pre">None,</span>                 <span class="pre">filter:</span> <span class="pre">SchemaFilter</span> <span class="pre">{</span>                     <span class="pre">include:</span> <span class="pre">None,</span>                     <span class="pre">exclude:</span> <span class="pre">None,</span>                 <span class="pre">},</span>                 <span class="pre">required_fields:</span> <span class="pre">3,</span>             <span class="pre">},</span>         <span class="pre">),</span>         <span class="pre">has_extra:</span> <span class="pre">false,</span>         <span class="pre">root_model:</span> <span class="pre">false,</span>         <span class="pre">name:</span> <span class="pre">"OptionStl",</span>     <span class="pre">},</span> <span class="pre">),</span> <span class="pre">definitions=[Enum(EnumSerializer</span> <span class="pre">{</span> <span class="pre">class:</span> <span class="pre">Py(0x562a9a437650),</span> <span class="pre">serializer:</span> <span class="pre">Some(Str(StrSerializer))</span> <span class="pre">}),</span> <span class="pre">Model(ModelSerializer</span> <span class="pre">{</span> <span class="pre">class:</span> <span class="pre">Py(0x562a9a438a50),</span> <span class="pre">serializer:</span> <span class="pre">Fields(GeneralFieldsSerializer</span> <span class="pre">{</span> <span class="pre">fields:</span> <span class="pre">{"axis":</span> <span class="pre">SerField</span> <span class="pre">{</span> <span class="pre">key_py:</span> <span class="pre">Py(0x7f936bc3a310),</span> <span class="pre">alias:</span> <span class="pre">None,</span> <span class="pre">alias_py:</span> <span class="pre">None,</span> <span class="pre">serializer:</span> <span class="pre">Some(Recursive(DefinitionRefSerializer</span> <span class="pre">{</span> <span class="pre">definition:</span> <span class="pre">"...",</span> <span class="pre">retry_with_lax_check:</span> <span class="pre">false</span> <span class="pre">})),</span> <span class="pre">required:</span> <span class="pre">true</span> <span class="pre">},</span> <span class="pre">"direction":</span> <span class="pre">SerField</span> <span class="pre">{</span> <span class="pre">key_py:</span> <span class="pre">Py(0x7f936e0debf0),</span> <span class="pre">alias:</span> <span class="pre">None,</span> <span class="pre">alias_py:</span> <span class="pre">None,</span> <span class="pre">serializer:</span> <span class="pre">Some(Recursive(DefinitionRefSerializer</span> <span class="pre">{</span> <span class="pre">definition:</span> <span class="pre">"...",</span> <span class="pre">retry_with_lax_check:</span> <span class="pre">false</span> <span class="pre">})),</span> <span class="pre">required:</span> <span class="pre">true</span> <span class="pre">}},</span> <span class="pre">computed_fields:</span> <span class="pre">Some(ComputedFields([])),</span> <span class="pre">mode:</span> <span class="pre">SimpleDict,</span> <span class="pre">extra_serializer:</span> <span class="pre">None,</span> <span class="pre">filter:</span> <span class="pre">SchemaFilter</span> <span class="pre">{</span> <span class="pre">include:</span> <span class="pre">None,</span> <span class="pre">exclude:</span> <span class="pre">None</span> <span class="pre">},</span> <span class="pre">required_fields:</span> <span class="pre">2</span> <span class="pre">}),</span> <span class="pre">has_extra:</span> <span class="pre">false,</span> <span class="pre">root_model:</span> <span class="pre">false,</span> <span class="pre">name:</span> <span class="pre">"AxisDirectionPair"</span> <span class="pre">}),</span> <span class="pre">Enum(EnumSerializer</span> <span class="pre">{</span> <span class="pre">class:</span> <span class="pre">Py(0x562a9a438050),</span> <span class="pre">serializer:</span> <span class="pre">Some(Str(StrSerializer))</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.OptionStl.__pydantic_serializer__" title="Link to this definition"></a></dt>
|
||
<dd><p>The <code class="xref any docutils literal notranslate"><span class="pre">pydantic-core</span></code> <code class="xref any docutils literal notranslate"><span class="pre">SchemaSerializer</span></code> used to dump instances of the model.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionStl.__pydantic_validator__">
|
||
<span class="sig-name descname"><span class="pre">__pydantic_validator__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[SchemaValidator</span> <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="OptionStl",</span> <span class="pre">validator=Model(</span>     <span class="pre">ModelValidator</span> <span class="pre">{</span>         <span class="pre">revalidate:</span> <span class="pre">Never,</span>         <span class="pre">validator:</span> <span class="pre">ModelFields(</span>             <span class="pre">ModelFieldsValidator</span> <span class="pre">{</span>                 <span class="pre">fields:</span> <span class="pre">[</span>                     <span class="pre">Field</span> <span class="pre">{</span>                         <span class="pre">name:</span> <span class="pre">"coords",</span>                         <span class="pre">lookup_key:</span> <span class="pre">Simple</span> <span class="pre">{</span>                             <span class="pre">key:</span> <span class="pre">"coords",</span>                             <span class="pre">py_key:</span> <span class="pre">Py(</span>                                 <span class="pre">0x00007f936b879dd0,</span>                             <span class="pre">),</span>                             <span class="pre">path:</span> <span class="pre">LookupPath(</span>                                 <span class="pre">[</span>                                     <span class="pre">S(</span>                                         <span class="pre">"coords",</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007f936b8799e0,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                 <span class="pre">],</span>                             <span class="pre">),</span>                         <span class="pre">},</span>                         <span class="pre">name_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007f936b87a2e0,</span>                         <span class="pre">),</span>                         <span class="pre">validator:</span> <span class="pre">Model(</span>                             <span class="pre">ModelValidator</span> <span class="pre">{</span>                                 <span class="pre">revalidate:</span> <span class="pre">Never,</span>                                 <span class="pre">validator:</span> <span class="pre">ModelFields(</span>                                     <span class="pre">ModelFieldsValidator</span> <span class="pre">{</span>                                         <span class="pre">fields:</span> <span class="pre">[</span>                                             <span class="pre">Field</span> <span class="pre">{</span>                                                 <span class="pre">name:</span> <span class="pre">"forward",</span>                                                 <span class="pre">lookup_key:</span> <span class="pre">Simple</span> <span class="pre">{</span>                                                     <span class="pre">key:</span> <span class="pre">"forward",</span>                                                     <span class="pre">py_key:</span> <span class="pre">Py(</span>                                                         <span class="pre">0x00007f936b8785d0,</span>                                                     <span class="pre">),</span>                                                     <span class="pre">path:</span> <span class="pre">LookupPath(</span>                                                         <span class="pre">[</span>                                                             <span class="pre">S(</span>                                                                 <span class="pre">"forward",</span>                                                                 <span class="pre">Py(</span>                                                                     <span class="pre">0x00007f936b87a520,</span>                                                                 <span class="pre">),</span>                                                             <span class="pre">),</span>                                                         <span class="pre">],</span>                                                     <span class="pre">),</span>                                                 <span class="pre">},</span>                                                 <span class="pre">name_py:</span> <span class="pre">Py(</span>                                                     <span class="pre">0x00007f936b879b00,</span>                                                 <span class="pre">),</span>                                                 <span class="pre">validator:</span> <span class="pre">DefinitionRef(</span>                                                     <span class="pre">DefinitionRefValidator</span> <span class="pre">{</span>                                                         <span class="pre">definition:</span> <span class="pre">"...",</span>                                                     <span class="pre">},</span>                                                 <span class="pre">),</span>                                                 <span class="pre">frozen:</span> <span class="pre">false,</span>                                             <span class="pre">},</span>                                             <span class="pre">Field</span> <span class="pre">{</span>                                                 <span class="pre">name:</span> <span class="pre">"up",</span>                                                 <span class="pre">lookup_key:</span> <span class="pre">Simple</span> <span class="pre">{</span>                                                     <span class="pre">key:</span> <span class="pre">"up",</span>                                                     <span class="pre">py_key:</span> <span class="pre">Py(</span>                                                         <span class="pre">0x00007f936b87a550,</span>                                                     <span class="pre">),</span>                                                     <span class="pre">path:</span> <span class="pre">LookupPath(</span>                                                         <span class="pre">[</span>                                                             <span class="pre">S(</span>                                                                 <span class="pre">"up",</span>                                                                 <span class="pre">Py(</span>                                                                     <span class="pre">0x00007f936b879e00,</span>                                                                 <span class="pre">),</span>                                                             <span class="pre">),</span>                                                         <span class="pre">],</span>                                                     <span class="pre">),</span>                                                 <span class="pre">},</span>                                                 <span class="pre">name_py:</span> <span class="pre">Py(</span>                                                     <span class="pre">0x00007f936e3777e0,</span>                                                 <span class="pre">),</span>                                                 <span class="pre">validator:</span> <span class="pre">DefinitionRef(</span>                                                     <span class="pre">DefinitionRefValidator</span> <span class="pre">{</span>                                                         <span class="pre">definition:</span> <span class="pre">"...",</span>                                                     <span class="pre">},</span>                                                 <span class="pre">),</span>                                                 <span class="pre">frozen:</span> <span class="pre">false,</span>                                             <span class="pre">},</span>                                         <span class="pre">],</span>                                         <span class="pre">model_name:</span> <span class="pre">"System",</span>                                         <span class="pre">extra_behavior:</span> <span class="pre">Ignore,</span>                                         <span class="pre">extras_validator:</span> <span class="pre">None,</span>                                         <span class="pre">strict:</span> <span class="pre">false,</span>                                         <span class="pre">from_attributes:</span> <span class="pre">false,</span>                                         <span class="pre">loc_by_alias:</span> <span class="pre">true,</span>                                     <span class="pre">},</span>                                 <span class="pre">),</span>                                 <span class="pre">class:</span> <span class="pre">Py(</span>                                     <span class="pre">0x0000562a9a43b050,</span>                                 <span class="pre">),</span>                                 <span class="pre">post_init:</span> <span class="pre">None,</span>                                 <span class="pre">frozen:</span> <span class="pre">false,</span>                                 <span class="pre">custom_init:</span> <span class="pre">false,</span>                                 <span class="pre">root_model:</span> <span class="pre">false,</span>                                 <span class="pre">undefined:</span> <span class="pre">Py(</span>                                     <span class="pre">0x00007f936d406320,</span>                                 <span class="pre">),</span>                                 <span class="pre">name:</span> <span class="pre">"System",</span>                             <span class="pre">},</span>                         <span class="pre">),</span>                         <span class="pre">frozen:</span> <span class="pre">false,</span>                     <span class="pre">},</span>                     <span class="pre">Field</span> <span class="pre">{</span>                         <span class="pre">name:</span> <span class="pre">"type",</span>                         <span class="pre">lookup_key:</span> <span class="pre">Simple</span> <span class="pre">{</span>                             <span class="pre">key:</span> <span class="pre">"type",</span>                             <span class="pre">py_key:</span> <span class="pre">Py(</span>                                 <span class="pre">0x00007f936b8796b0,</span>                             <span class="pre">),</span>                             <span class="pre">path:</span> <span class="pre">LookupPath(</span>                                 <span class="pre">[</span>                                     <span class="pre">S(</span>                                         <span class="pre">"type",</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007f936b87b330,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                 <span class="pre">],</span>                             <span class="pre">),</span>                         <span class="pre">},</span>                         <span class="pre">name_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007f936f623938,</span>                         <span class="pre">),</span>                         <span class="pre">validator:</span> <span class="pre">WithDefault(</span>                             <span class="pre">WithDefaultValidator</span> <span class="pre">{</span>                                 <span class="pre">default:</span> <span class="pre">Default(</span>                                     <span class="pre">Py(</span>                                         <span class="pre">0x00007f936b879da0,</span>                                     <span class="pre">),</span>                                 <span class="pre">),</span>                                 <span class="pre">on_error:</span> <span class="pre">Raise,</span>                                 <span class="pre">validator:</span> <span class="pre">Literal(</span>                                     <span class="pre">LiteralValidator</span> <span class="pre">{</span>                                         <span class="pre">lookup:</span> <span class="pre">LiteralLookup</span> <span class="pre">{</span>                                             <span class="pre">expected_bool:</span> <span class="pre">None,</span>                                             <span class="pre">expected_int:</span> <span class="pre">None,</span>                                             <span class="pre">expected_str:</span> <span class="pre">Some(</span>                                                 <span class="pre">{</span>                                                     <span class="pre">"stl":</span> <span class="pre">0,</span>                                                 <span class="pre">},</span>                                             <span class="pre">),</span>                                             <span class="pre">expected_py_dict:</span> <span class="pre">None,</span>                                             <span class="pre">expected_py_values:</span> <span class="pre">None,</span>                                             <span class="pre">values:</span> <span class="pre">[</span>                                                 <span class="pre">Py(</span>                                                     <span class="pre">0x00007f936b879da0,</span>                                                 <span class="pre">),</span>                                             <span class="pre">],</span>                                         <span class="pre">},</span>                                         <span class="pre">expected_repr:</span> <span class="pre">"'stl'",</span>                                         <span class="pre">name:</span> <span class="pre">"literal['stl']",</span>                                     <span class="pre">},</span>                                 <span class="pre">),</span>                                 <span class="pre">validate_default:</span> <span class="pre">false,</span>                                 <span class="pre">copy_default:</span> <span class="pre">false,</span>                                 <span class="pre">name:</span> <span class="pre">"default[literal['stl']]",</span>                                 <span class="pre">undefined:</span> <span class="pre">Py(</span>                                     <span class="pre">0x00007f936d406320,</span>                                 <span class="pre">),</span>                             <span class="pre">},</span>                         <span class="pre">),</span>                         <span class="pre">frozen:</span> <span class="pre">false,</span>                     <span class="pre">},</span>                     <span class="pre">Field</span> <span class="pre">{</span>                         <span class="pre">name:</span> <span class="pre">"units",</span>                         <span class="pre">lookup_key:</span> <span class="pre">Simple</span> <span class="pre">{</span>                             <span class="pre">key:</span> <span class="pre">"units",</span>                             <span class="pre">py_key:</span> <span class="pre">Py(</span>                                 <span class="pre">0x00007f936b878a80,</span>                             <span class="pre">),</span>                             <span class="pre">path:</span> <span class="pre">LookupPath(</span>                                 <span class="pre">[</span>                                     <span class="pre">S(</span>                                         <span class="pre">"units",</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007f936b7813e0,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                 <span class="pre">],</span>                             <span class="pre">),</span>                         <span class="pre">},</span>                         <span class="pre">name_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007f936e37aa30,</span>                         <span class="pre">),</span>                         <span class="pre">validator:</span> <span class="pre">StrEnum(</span>                             <span class="pre">EnumValidator</span> <span class="pre">{</span>                                 <span class="pre">phantom:</span> <span class="pre">PhantomData<_pydantic_core::validators::enum_::StrEnumValidator>,</span>                                 <span class="pre">class:</span> <span class="pre">Py(</span>                                     <span class="pre">0x0000562a9a090fc0,</span>                                 <span class="pre">),</span>                                 <span class="pre">lookup:</span> <span class="pre">LiteralLookup</span> <span class="pre">{</span>                                     <span class="pre">expected_bool:</span> <span class="pre">None,</span>                                     <span class="pre">expected_int:</span> <span class="pre">None,</span>                                     <span class="pre">expected_str:</span> <span class="pre">Some(</span>                                         <span class="pre">{</span>                                             <span class="pre">"mm":</span> <span class="pre">4,</span>                                             <span class="pre">"m":</span> <span class="pre">3,</span>                                             <span class="pre">"cm":</span> <span class="pre">0,</span>                                             <span class="pre">"ft":</span> <span class="pre">1,</span>                                             <span class="pre">"in":</span> <span class="pre">2,</span>                                             <span class="pre">"yd":</span> <span class="pre">5,</span>                                         <span class="pre">},</span>                                     <span class="pre">),</span>                                     <span class="pre">expected_py_dict:</span> <span class="pre">None,</span>                                     <span class="pre">expected_py_values:</span> <span class="pre">None,</span>                                     <span class="pre">values:</span> <span class="pre">[</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007f936aeac890,</span>                                         <span class="pre">),</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007f936aeace30,</span>                                         <span class="pre">),</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007f936aeacef0,</span>                                         <span class="pre">),</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007f936aeacf50,</span>                                         <span class="pre">),</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007f936aeacfb0,</span>                                         <span class="pre">),</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007f936aead010,</span>                                         <span class="pre">),</span>                                     <span class="pre">],</span>                                 <span class="pre">},</span>                                 <span class="pre">missing:</span> <span class="pre">None,</span>                                 <span class="pre">expected_repr:</span> <span class="pre">"'cm',</span> <span class="pre">'ft',</span> <span class="pre">'in',</span> <span class="pre">'m',</span> <span class="pre">'mm'</span> <span class="pre">or</span> <span class="pre">'yd'",</span>                                 <span class="pre">strict:</span> <span class="pre">false,</span>                                 <span class="pre">class_repr:</span> <span class="pre">"UnitLength",</span>                                 <span class="pre">name:</span> <span class="pre">"str-enum[UnitLength]",</span>                             <span class="pre">},</span>                         <span class="pre">),</span>                         <span class="pre">frozen:</span> <span class="pre">false,</span>                     <span class="pre">},</span>                 <span class="pre">],</span>                 <span class="pre">model_name:</span> <span class="pre">"OptionStl",</span>                 <span class="pre">extra_behavior:</span> <span class="pre">Ignore,</span>                 <span class="pre">extras_validator:</span> <span class="pre">None,</span>                 <span class="pre">strict:</span> <span class="pre">false,</span>                 <span class="pre">from_attributes:</span> <span class="pre">false,</span>                 <span class="pre">loc_by_alias:</span> <span class="pre">true,</span>             <span class="pre">},</span>         <span class="pre">),</span>         <span class="pre">class:</span> <span class="pre">Py(</span>             <span class="pre">0x0000562a9a1d9130,</span>         <span class="pre">),</span>         <span class="pre">post_init:</span> <span class="pre">None,</span>         <span class="pre">frozen:</span> <span class="pre">false,</span>         <span class="pre">custom_init:</span> <span class="pre">false,</span>         <span class="pre">root_model:</span> <span class="pre">false,</span>         <span class="pre">undefined:</span> <span class="pre">Py(</span>             <span class="pre">0x00007f936d406320,</span>         <span class="pre">),</span>         <span class="pre">name:</span> <span class="pre">"OptionStl",</span>     <span class="pre">},</span> <span class="pre">),</span> <span class="pre">definitions=[StrEnum(EnumValidator</span> <span class="pre">{</span> <span class="pre">phantom:</span> <span class="pre">PhantomData<_pydantic_core::validators::enum_::StrEnumValidator>,</span> <span class="pre">class:</span> <span class="pre">Py(0x562a9a437650),</span> <span class="pre">lookup:</span> <span class="pre">LiteralLookup</span> <span class="pre">{</span> <span class="pre">expected_bool:</span> <span class="pre">None,</span> <span class="pre">expected_int:</span> <span class="pre">None,</span> <span class="pre">expected_str:</span> <span class="pre">Some({"y":</span> <span class="pre">0,</span> <span class="pre">"z":</span> <span class="pre">1}),</span> <span class="pre">expected_py_dict:</span> <span class="pre">None,</span> <span class="pre">expected_py_values:</span> <span class="pre">None,</span> <span class="pre">values:</span> <span class="pre">[Py(0x7f936aeacad0),</span> <span class="pre">Py(0x7f936aeacb30)]</span> <span class="pre">},</span> <span class="pre">missing:</span> <span class="pre">None,</span> <span class="pre">expected_repr:</span> <span class="pre">"'y'</span> <span class="pre">or</span> <span class="pre">'z'",</span> <span class="pre">strict:</span> <span class="pre">false,</span> <span class="pre">class_repr:</span> <span class="pre">"Axis",</span> <span class="pre">name:</span> <span class="pre">"str-enum[Axis]"</span> <span class="pre">}),</span> <span class="pre">StrEnum(EnumValidator</span> <span class="pre">{</span> <span class="pre">phantom:</span> <span class="pre">PhantomData<_pydantic_core::validators::enum_::StrEnumValidator>,</span> <span class="pre">class:</span> <span class="pre">Py(0x562a9a438050),</span> <span class="pre">lookup:</span> <span class="pre">LiteralLookup</span> <span class="pre">{</span> <span class="pre">expected_bool:</span> <span class="pre">None,</span> <span class="pre">expected_int:</span> <span class="pre">None,</span> <span class="pre">expected_str:</span> <span class="pre">Some({"positive":</span> <span class="pre">0,</span> <span class="pre">"negative":</span> <span class="pre">1}),</span> <span class="pre">expected_py_dict:</span> <span class="pre">None,</span> <span class="pre">expected_py_values:</span> <span class="pre">None,</span> <span class="pre">values:</span> <span class="pre">[Py(0x7f936aeacc50),</span> <span class="pre">Py(0x7f936aeaccb0)]</span> <span class="pre">},</span> <span class="pre">missing:</span> <span class="pre">None,</span> <span class="pre">expected_repr:</span> <span class="pre">"'positive'</span> <span class="pre">or</span> <span class="pre">'negative'",</span> <span class="pre">strict:</span> <span class="pre">false,</span> <span class="pre">class_repr:</span> <span class="pre">"Direction",</span> <span class="pre">name:</span> <span class="pre">"str-enum[Direction]"</span> <span class="pre">}),</span> <span class="pre">Model(ModelValidator</span> <span class="pre">{</span> <span class="pre">revalidate:</span> <span class="pre">Never,</span> <span class="pre">validator:</span> <span class="pre">ModelFields(ModelFieldsValidator</span> <span class="pre">{</span> <span class="pre">fields:</span> <span class="pre">[Field</span> <span class="pre">{</span> <span class="pre">name:</span> <span class="pre">"axis",</span> <span class="pre">lookup_key:</span> <span class="pre">Simple</span> <span class="pre">{</span> <span class="pre">key:</span> <span class="pre">"axis",</span> <span class="pre">py_key:</span> <span class="pre">Py(0x7f936b87a4f0),</span> <span class="pre">path:</span> <span class="pre">LookupPath([S("axis",</span> <span class="pre">Py(0x7f936b879020))])</span> <span class="pre">},</span> <span class="pre">name_py:</span> <span class="pre">Py(0x7f936bc3a310),</span> <span class="pre">validator:</span> <span class="pre">DefinitionRef(DefinitionRefValidator</span> <span class="pre">{</span> <span class="pre">definition:</span> <span class="pre">"..."</span> <span class="pre">}),</span> <span class="pre">frozen:</span> <span class="pre">false</span> <span class="pre">},</span> <span class="pre">Field</span> <span class="pre">{</span> <span class="pre">name:</span> <span class="pre">"direction",</span> <span class="pre">lookup_key:</span> <span class="pre">Simple</span> <span class="pre">{</span> <span class="pre">key:</span> <span class="pre">"direction",</span> <span class="pre">py_key:</span> <span class="pre">Py(0x7f936b0067f0),</span> <span class="pre">path:</span> <span class="pre">LookupPath([S("direction",</span> <span class="pre">Py(0x7f936b006870))])</span> <span class="pre">},</span> <span class="pre">name_py:</span> <span class="pre">Py(0x7f936e0debf0),</span> <span class="pre">validator:</span> <span class="pre">DefinitionRef(DefinitionRefValidator</span> <span class="pre">{</span> <span class="pre">definition:</span> <span class="pre">"..."</span> <span class="pre">}),</span> <span class="pre">frozen:</span> <span class="pre">false</span> <span class="pre">}],</span> <span class="pre">model_name:</span> <span class="pre">"AxisDirectionPair",</span> <span class="pre">extra_behavior:</span> <span class="pre">Ignore,</span> <span class="pre">extras_validator:</span> <span class="pre">None,</span> <span class="pre">strict:</span> <span class="pre">false,</span> <span class="pre">from_attributes:</span> <span class="pre">false,</span> <span class="pre">loc_by_alias:</span> <span class="pre">true</span> <span class="pre">}),</span> <span class="pre">class:</span> <span class="pre">Py(0x562a9a438a50),</span> <span class="pre">post_init:</span> <span class="pre">None,</span> <span class="pre">frozen:</span> <span class="pre">false,</span> <span class="pre">custom_init:</span> <span class="pre">false,</span> <span class="pre">root_model:</span> <span class="pre">false,</span> <span class="pre">undefined:</span> <span class="pre">Py(0x7f936d406320),</span> <span class="pre">name:</span> <span class="pre">"AxisDirectionPair"</span> <span class="pre">})],</span> <span class="pre">cache_strings=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.OptionStl.__pydantic_validator__" title="Link to this definition"></a></dt>
|
||
<dd><p>The <code class="xref any docutils literal notranslate"><span class="pre">pydantic-core</span></code> <code class="xref any docutils literal notranslate"><span class="pre">SchemaValidator</span></code> used to validate instances of the model.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionStl.__repr__">
|
||
<span class="sig-name descname"><span class="pre">__repr__</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionStl.__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>
|
||
<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.OptionStl.__repr_args__">
|
||
<span class="sig-name descname"><span class="pre">__repr_args__</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionStl.__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/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/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/typing.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.OptionStl.__repr_name__">
|
||
<span class="sig-name descname"><span class="pre">__repr_name__</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionStl.__repr_name__" title="Link to this definition"></a></dt>
|
||
<dd><p>Name of the instance’s class, used in __repr__.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><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.OptionStl.__repr_str__">
|
||
<span class="sig-name descname"><span class="pre">__repr_str__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">join_str</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionStl.__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>
|
||
<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.OptionStl.__rich_repr__">
|
||
<span class="sig-name descname"><span class="pre">__rich_repr__</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionStl.__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>
|
||
<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.OptionStl.__setattr__">
|
||
<span class="sig-name descname"><span class="pre">__setattr__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionStl.__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>
|
||
<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.OptionStl.__setstate__">
|
||
<span class="sig-name descname"><span class="pre">__setstate__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">state</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionStl.__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>
|
||
<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.OptionStl.__signature__">
|
||
<span class="sig-name descname"><span class="pre">__signature__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[Signature]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre"><Signature</span> <span class="pre">(*,</span> <span class="pre">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">-></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.OptionStl.__signature__" title="Link to this definition"></a></dt>
|
||
<dd><p>The synthesized <a class="reference internal" href="kittycad.models.input_format.OptionStl.html#id0" title="kittycad.models.input_format.OptionStl.__init__"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">__init__</span></code></a> [<code class="xref any docutils literal notranslate"><span class="pre">Signature</span></code>][inspect.Signature] of the model.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionStl.__slots__">
|
||
<span class="sig-name descname"><span class="pre">__slots__</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">('__dict__',</span> <span class="pre">'__pydantic_fields_set__',</span> <span class="pre">'__pydantic_extra__',</span> <span class="pre">'__pydantic_private__')</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionStl.__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.OptionStl.__str__">
|
||
<span class="sig-name descname"><span class="pre">__str__</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionStl.__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>
|
||
<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.OptionStl._abc_impl">
|
||
<span class="sig-name descname"><span class="pre">_abc_impl</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre"><_abc._abc_data</span> <span class="pre">object></span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionStl._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.OptionStl._calculate_keys">
|
||
<span class="sig-name descname"><span class="pre">_calculate_keys</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionStl._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>
|
||
<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.OptionStl._check_frozen">
|
||
<span class="sig-name descname"><span class="pre">_check_frozen</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionStl._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>
|
||
<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.OptionStl._copy_and_set_values">
|
||
<span class="sig-name descname"><span class="pre">_copy_and_set_values</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionStl._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>
|
||
<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.OptionStl._get_value">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">_get_value</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="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.OptionStl._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>
|
||
<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.OptionStl._iter">
|
||
<span class="sig-name descname"><span class="pre">_iter</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionStl._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>
|
||
<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.OptionStl.construct">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">construct</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_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.OptionStl.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>
|
||
<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.OptionStl.coords">
|
||
<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.OptionStl.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.OptionStl.copy">
|
||
<span class="sig-name descname"><span class="pre">copy</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">include</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exclude</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">update</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">deep</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionStl.copy" title="Link to this definition"></a></dt>
|
||
<dd><p>Returns a copy of the model.</p>
|
||
<dl class="simple">
|
||
<dt>!!! warning “Deprecated”</dt><dd><p>This method is now deprecated; use <a class="reference internal" href="kittycad.models.input_format.OptionStl.html#kittycad.models.input_format.OptionStl.model_copy" title="kittycad.models.input_format.OptionStl.model_copy"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">model_copy</span></code></a> instead.</p>
|
||
</dd>
|
||
</dl>
|
||
<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">
|
||
<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>
|
||
<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.OptionStl.dict">
|
||
<span class="sig-name descname"><span class="pre">dict</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">include</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exclude</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">by_alias</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exclude_unset</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exclude_defaults</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exclude_none</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionStl.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>
|
||
<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.OptionStl.from_orm">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_orm</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">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.OptionStl.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>
|
||
<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.OptionStl.json">
|
||
<span class="sig-name descname"><span class="pre">json</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">include</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exclude</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">by_alias</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exclude_unset</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exclude_defaults</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exclude_none</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">encoder</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">PydanticUndefined</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">models_as_dict</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">PydanticUndefined</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">dumps_kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionStl.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>
|
||
<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.OptionStl.model_computed_fields">
|
||
<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.OptionStl.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.OptionStl.model_config">
|
||
<span class="sig-name descname"><span class="pre">model_config</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[ConfigDict]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'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.OptionStl.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.OptionStl.model_construct">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">model_construct</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_fields_set</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">values</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionStl.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.OptionStl.html#kittycad.models.input_format.OptionStl.__dict__" title="kittycad.models.input_format.OptionStl.__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.OptionStl.html#kittycad.models.input_format.OptionStl.__pydantic_fields_set__" title="kittycad.models.input_format.OptionStl.__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.OptionStl.html#kittycad.models.input_format.OptionStl.model_construct" title="kittycad.models.input_format.OptionStl.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 instance’s <a class="reference internal" href="kittycad.models.input_format.OptionStl.html#kittycad.models.input_format.OptionStl.__dict__" title="kittycad.models.input_format.OptionStl.__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.OptionStl.html#kittycad.models.input_format.OptionStl.__pydantic_extra__" title="kittycad.models.input_format.OptionStl.__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.OptionStl.html#kittycad.models.input_format.OptionStl.model_construct" title="kittycad.models.input_format.OptionStl.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">
|
||
<li><p><strong>_fields_set</strong> (<span class="sphinx_autodoc_typehints-type"><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>] | <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 field names that were originally explicitly set during instantiation. If provided,
|
||
this is directly used for the [<a class="reference internal" href="kittycad.models.input_format.OptionStl.html#kittycad.models.input_format.OptionStl.model_fields_set" title="kittycad.models.input_format.OptionStl.model_fields_set"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">model_fields_set</span></code></a>][pydantic.BaseModel.model_fields_set] attribute.
|
||
Otherwise, the field names from the <code class="xref any docutils literal notranslate"><span class="pre">values</span></code> argument will be used.</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>
|
||
<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>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.OptionStl.model_copy">
|
||
<span class="sig-name descname"><span class="pre">model_copy</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">update</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">deep</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionStl.model_copy" title="Link to this definition"></a></dt>
|
||
<dd><p>Usage docs: <a class="reference external" href="https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy">https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy</a></p>
|
||
<p>Returns a copy of the model.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>update</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference internal" href="kittycad.models.input_format.OptionStl.html#kittycad.models.input_format.OptionStl.dict" title="kittycad.models.input_format.OptionStl.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>] | <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>) – Values to change/add in the new model. Note: the data is not validated
|
||
before creating the new model. You should trust this data.</p></li>
|
||
<li><p><strong>deep</strong> (<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>
|
||
<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.OptionStl.model_dump">
|
||
<span class="sig-name descname"><span class="pre">model_dump</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mode</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'python'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">include</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exclude</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">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.OptionStl.model_dump" title="Link to this definition"></a></dt>
|
||
<dd><p>Usage docs: <a class="reference external" href="https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump">https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump</a></p>
|
||
<p>Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>mode</strong> (<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.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.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.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[IncEx, <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">True</span></code>]]], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[IncEx, <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">True</span></code>]]], <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">True</span></code>]]], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.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.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[IncEx, <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">True</span></code>]]], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[IncEx, <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">True</span></code>]]], <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">True</span></code>]]], <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.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.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.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[IncEx, <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">True</span></code>]]], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[IncEx, <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">True</span></code>]]], <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">True</span></code>]]], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.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.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[IncEx, <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">True</span></code>]]], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[IncEx, <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">True</span></code>]]], <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">True</span></code>]]], <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.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>) – 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 field’s 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>
|
||
<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.OptionStl.html#kittycad.models.input_format.OptionStl.dict" title="kittycad.models.input_format.OptionStl.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.OptionStl.model_dump_json">
|
||
<span class="sig-name descname"><span class="pre">model_dump_json</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">indent</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">include</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exclude</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">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.OptionStl.model_dump_json" title="Link to this definition"></a></dt>
|
||
<dd><p>Usage docs: <a class="reference external" href="https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json">https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json</a></p>
|
||
<p>Generates a JSON representation of the model using Pydantic’s <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">
|
||
<li><p><strong>indent</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> | <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>) – 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.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.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.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[IncEx, <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">True</span></code>]]], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[IncEx, <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">True</span></code>]]], <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">True</span></code>]]], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.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.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[IncEx, <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">True</span></code>]]], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[IncEx, <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">True</span></code>]]], <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">True</span></code>]]], <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.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.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.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[IncEx, <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">True</span></code>]]], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[IncEx, <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">True</span></code>]]], <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">True</span></code>]]], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.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.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[IncEx, <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">True</span></code>]]], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</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.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[IncEx, <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">True</span></code>]]], <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">True</span></code>]]], <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.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>) – 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>
|
||
<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.OptionStl.model_extra">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">model_extra</span></span><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.OptionStl.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>
|
||
<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">"allow"</span></code>.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionStl.model_fields">
|
||
<span class="sig-name descname"><span class="pre">model_fields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[Dict[str,</span> <span class="pre">FieldInfo]]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'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.OptionStl.model_fields" title="Link to this definition"></a></dt>
|
||
<dd><p>Metadata about the fields defined on the model,
|
||
mapping of field names to [<code class="xref any docutils literal notranslate"><span class="pre">FieldInfo</span></code>][pydantic.fields.FieldInfo] objects.</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.OptionStl.model_fields_set">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">model_fields_set</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#set" title="(in Python v3.12)"><span class="pre">set</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionStl.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.OptionStl.model_json_schema">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">model_json_schema</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">by_alias=True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ref_template='#/$defs/{model}'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">schema_generator=<class</span> <span class="pre">'pydantic.json_schema.GenerateJsonSchema'></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mode='validation'</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionStl.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">
|
||
<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.OptionStl.html#kittycad.models.input_format.OptionStl.type" title="kittycad.models.input_format.OptionStl.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>
|
||
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><a class="reference internal" href="kittycad.models.input_format.OptionStl.html#kittycad.models.input_format.OptionStl.dict" title="kittycad.models.input_format.OptionStl.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.OptionStl.model_parametrized_name">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">model_parametrized_name</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">params</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionStl.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>
|
||
<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.OptionStl.html#kittycad.models.input_format.OptionStl.type" title="kittycad.models.input_format.OptionStl.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>
|
||
<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>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.OptionStl.model_post_init">
|
||
<span class="sig-name descname"><span class="pre">model_post_init</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_BaseModel__context</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionStl.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.OptionStl.html#id0" title="kittycad.models.input_format.OptionStl.__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.OptionStl.html#kittycad.models.input_format.OptionStl.model_construct" title="kittycad.models.input_format.OptionStl.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>
|
||
<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.OptionStl.model_rebuild">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">model_rebuild</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">force</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">raise_errors</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_parent_namespace_depth</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">2</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_types_namespace</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionStl.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">
|
||
<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 internal" href="kittycad.models.input_format.OptionStl.html#kittycad.models.input_format.OptionStl.dict" title="kittycad.models.input_format.OptionStl.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>] | <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>) – 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>
|
||
<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/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/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>
|
||
<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.OptionStl.model_validate">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">model_validate</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">obj</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">strict</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">from_attributes</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">context</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionStl.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">
|
||
<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/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/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>) – 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/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/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>) – 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.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>) – Additional context to pass to the validator.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><strong>ValidationError</strong> – If the object could not be validated.</p>
|
||
</dd>
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><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.OptionStl.model_validate_json">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">model_validate_json</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">json_data</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">strict</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">context</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionStl.model_validate_json" title="Link to this definition"></a></dt>
|
||
<dd><p>Usage docs: <a class="reference external" href="https://docs.pydantic.dev/2.9/concepts/json/#json-parsing">https://docs.pydantic.dev/2.9/concepts/json/#json-parsing</a></p>
|
||
<p>Validate the given JSON data against the Pydantic model.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>json_data</strong> (<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/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/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>) – 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.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>) – Extra variables to pass to the validator.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><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>
|
||
<dd class="field-even"><p><strong>ValidationError</strong> – If <code class="xref any docutils literal notranslate"><span class="pre">json_data</span></code> is not a JSON string or the object could not be validated.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="kittycad.models.input_format.OptionStl.model_validate_strings">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">model_validate_strings</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">obj</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">strict</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">context</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.OptionStl.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">
|
||
<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/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/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>) – 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.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>) – Extra variables to pass to the validator.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><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.OptionStl.parse_file">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">parse_file</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">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.OptionStl.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>
|
||
<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.OptionStl.parse_obj">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">parse_obj</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">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.OptionStl.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>
|
||
<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.OptionStl.parse_raw">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">parse_raw</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">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.OptionStl.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>
|
||
<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.OptionStl.schema">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">schema</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">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.OptionStl.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>
|
||
<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.OptionStl.schema_json">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">schema_json</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="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.OptionStl.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>
|
||
<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.OptionStl.type">
|
||
<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.OptionStl.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.OptionStl.units">
|
||
<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.OptionStl.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.OptionStl.update_forward_refs">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">update_forward_refs</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="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.OptionStl.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>
|
||
<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.OptionStl.validate">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">validate</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">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.OptionStl.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>
|
||
<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>
|
||
|
||
</section>
|
||
|
||
|
||
</div>
|
||
</div>
|
||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||
<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.OptionFbx.html" class="btn btn-neutral float-right" title="kittycad.models.input_format.OptionFbx" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||
</div>
|
||
|
||
<hr/>
|
||
|
||
<div role="contentinfo">
|
||
<p>© Copyright 2024, KittyCAD Team Members.</p>
|
||
</div>
|
||
|
||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||
|
||
|
||
</footer>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<script>
|
||
jQuery(function () {
|
||
SphinxRtdTheme.Navigation.enable(true);
|
||
});
|
||
</script>
|
||
|
||
</body>
|
||
</html> |