1580 lines
380 KiB
HTML
1580 lines
380 KiB
HTML
|
||
|
||
<!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.kcl_code_completion_params.KclCodeCompletionParams" />
|
||
<meta property="og:type" content="website" />
|
||
<meta property="og:url" content="_autosummary/kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.html" />
|
||
<meta property="og:site_name" content="kittycad" />
|
||
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||
<title>kittycad.models.kcl_code_completion_params.KclCodeCompletionParams — kittycad v0.7.4 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=e59714d7" />
|
||
<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" />
|
||
|
||
|
||
<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=f9b80c38"></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.kcl_code_completion_request" href="kittycad.models.kcl_code_completion_request.html" />
|
||
<link rel="prev" title="kittycad.models.kcl_code_completion_params" href="kittycad.models.kcl_code_completion_params.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 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_hole_from_offset.html">kittycad.models.add_hole_from_offset</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_movement.html">kittycad.models.camera_movement</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.create_shortlink_request.html">kittycad.models.create_shortlink_request</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.create_shortlink_response.html">kittycad.models.create_shortlink_response</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_center_to_scene.html">kittycad.models.default_camera_center_to_scene</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.default_camera_center_to_selection.html">kittycad.models.default_camera_center_to_selection</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.disable_dry_run.html">kittycad.models.disable_dry_run</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.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_dry_run.html">kittycad.models.enable_dry_run</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.engine_util_evaluate_path.html">kittycad.models.engine_util_evaluate_path</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.enterprise_subscription_tier_price.html">kittycad.models.enterprise_subscription_tier_price</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_make_helix_from_params.html">kittycad.models.entity_make_helix_from_params</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.extruded_face_info.html">kittycad.models.extruded_face_info</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"><a class="reference internal" href="kittycad.models.input_format.html">kittycad.models.input_format</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.invoice.html">kittycad.models.invoice</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.invoice_line_item.html">kittycad.models.invoice_line_item</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.invoice_status.html">kittycad.models.invoice_status</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.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 current"><a class="reference internal" href="kittycad.models.kcl_code_completion_params.html">kittycad.models.kcl_code_completion_params</a><ul class="current">
|
||
<li class="toctree-l3 current"><a class="current reference internal" href="#">kittycad.models.kcl_code_completion_params.KclCodeCompletionParams</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams"><code class="docutils literal notranslate"><span class="pre">KclCodeCompletionParams</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="kittycad.models.kcl_code_completion_params.html#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams"><code class="docutils literal notranslate"><span class="pre">KclCodeCompletionParams</span></code></a></li>
|
||
</ul>
|
||
</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_offset_path.html">kittycad.models.make_offset_path</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_share_links.html">kittycad.models.modeling_app_share_links</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_uuid.html">kittycad.models.service_account_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_uuid.html">kittycad.models.session_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.shortlink.html">kittycad.models.shortlink</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.shortlink_results_page.html">kittycad.models.shortlink_results_page</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.side_face.html">kittycad.models.side_face</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_common_edge.html">kittycad.models.solid3d_get_common_edge</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.sweep.html">kittycad.models.sweep</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_shortlink_request.html">kittycad.models.update_shortlink_request</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_identifier.html">kittycad.models.user_identifier</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"><a href="kittycad.models.kcl_code_completion_params.html">kittycad.models.kcl_code_completion_params</a></li>
|
||
<li class="breadcrumb-item active">kittycad.models.kcl_code_completion_params.KclCodeCompletionParams</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="kittycad-models-kcl-code-completion-params-kclcodecompletionparams">
|
||
<h1>kittycad.models.kcl_code_completion_params.KclCodeCompletionParams<a class="headerlink" href="#kittycad-models-kcl-code-completion-params-kclcodecompletionparams" title="Link to this heading"></a></h1>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="kittycad.models.kcl_code_completion_params.KclCodeCompletionParams">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">kittycad.models.kcl_code_completion_params.</span></span><span class="sig-name descname"><span class="pre">KclCodeCompletionParams</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/kcl_code_completion_params.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="reference internal" href="../_modules/kittycad/models/kcl_code_completion_params.html#KclCodeCompletionParams"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams" title="Link to this definition"></a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">BaseModel</span></code></p>
|
||
<p>Extra params for the completions.</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 method">
|
||
<dt class="sig sig-object py" id="kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.__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/kcl_code_completion_params.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.__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>
|
||
|
||
<p class="rubric">Methods</p>
|
||
<table class="autosummary longtable docutils align-default">
|
||
<tbody>
|
||
<tr class="row-odd"><td><p><a class="reference internal" href="#id0" title="kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.__init__"><code class="xref py py-obj docutils literal notranslate"><span class="pre">__init__</span></code></a>(**data)</p></td>
|
||
<td><p>Create a new model by parsing and validating input data from keyword arguments.</p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p><a class="reference internal" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.construct" title="kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.construct"><code class="xref py py-obj docutils literal notranslate"><span class="pre">construct</span></code></a>([_fields_set])</p></td>
|
||
<td><p></p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p><a class="reference internal" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.copy" title="kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.copy"><code class="xref py py-obj docutils literal notranslate"><span class="pre">copy</span></code></a>(*[, include, exclude, update, deep])</p></td>
|
||
<td><p>Returns a copy of the model.</p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p><a class="reference internal" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.dict" title="kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.dict"><code class="xref py py-obj docutils literal notranslate"><span class="pre">dict</span></code></a>(*[, include, exclude, by_alias, ...])</p></td>
|
||
<td><p></p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p><a class="reference internal" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.from_orm" title="kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.from_orm"><code class="xref py py-obj docutils literal notranslate"><span class="pre">from_orm</span></code></a>(obj)</p></td>
|
||
<td><p></p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p><a class="reference internal" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.json" title="kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.json"><code class="xref py py-obj docutils literal notranslate"><span class="pre">json</span></code></a>(*[, include, exclude, by_alias, ...])</p></td>
|
||
<td><p></p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p><a class="reference internal" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.model_construct" title="kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.model_construct"><code class="xref py py-obj docutils literal notranslate"><span class="pre">model_construct</span></code></a>([_fields_set])</p></td>
|
||
<td><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></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p><a class="reference internal" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.model_copy" title="kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.model_copy"><code class="xref py py-obj docutils literal notranslate"><span class="pre">model_copy</span></code></a>(*[, update, deep])</p></td>
|
||
<td><p>Usage docs: <a class="reference external" href="https://docs.pydantic.dev/2.10/concepts/serialization/#model_copy">https://docs.pydantic.dev/2.10/concepts/serialization/#model_copy</a></p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p><a class="reference internal" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.model_dump" title="kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.model_dump"><code class="xref py py-obj docutils literal notranslate"><span class="pre">model_dump</span></code></a>(*[, mode, include, exclude, ...])</p></td>
|
||
<td><p>Usage docs: <a class="reference external" href="https://docs.pydantic.dev/2.10/concepts/serialization/#modelmodel_dump">https://docs.pydantic.dev/2.10/concepts/serialization/#modelmodel_dump</a></p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p><a class="reference internal" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.model_dump_json" title="kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.model_dump_json"><code class="xref py py-obj docutils literal notranslate"><span class="pre">model_dump_json</span></code></a>(*[, indent, include, ...])</p></td>
|
||
<td><p>Usage docs: <a class="reference external" href="https://docs.pydantic.dev/2.10/concepts/serialization/#modelmodel_dump_json">https://docs.pydantic.dev/2.10/concepts/serialization/#modelmodel_dump_json</a></p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p><a class="reference internal" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.model_json_schema" title="kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.model_json_schema"><code class="xref py py-obj docutils literal notranslate"><span class="pre">model_json_schema</span></code></a>([by_alias, ref_template, ...])</p></td>
|
||
<td><p>Generates a JSON schema for a model class.</p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p><a class="reference internal" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.model_parametrized_name" title="kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.model_parametrized_name"><code class="xref py py-obj docutils literal notranslate"><span class="pre">model_parametrized_name</span></code></a>(params)</p></td>
|
||
<td><p>Compute the class name for parametrizations of generic classes.</p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p><a class="reference internal" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.model_post_init" title="kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.model_post_init"><code class="xref py py-obj docutils literal notranslate"><span class="pre">model_post_init</span></code></a>(_BaseModel__context)</p></td>
|
||
<td><p>Override this method to perform additional initialization after <a class="reference internal" href="#id0" title="kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.__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.kcl_code_completion_params.KclCodeCompletionParams.model_construct" title="kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.model_construct"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">model_construct</span></code></a>.</p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p><a class="reference internal" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.model_rebuild" title="kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.model_rebuild"><code class="xref py py-obj docutils literal notranslate"><span class="pre">model_rebuild</span></code></a>(*[, force, raise_errors, ...])</p></td>
|
||
<td><p>Try to rebuild the pydantic-core schema for the model.</p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p><a class="reference internal" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.model_validate" title="kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.model_validate"><code class="xref py py-obj docutils literal notranslate"><span class="pre">model_validate</span></code></a>(obj, *[, strict, ...])</p></td>
|
||
<td><p>Validate a pydantic model instance.</p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p><a class="reference internal" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.model_validate_json" title="kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.model_validate_json"><code class="xref py py-obj docutils literal notranslate"><span class="pre">model_validate_json</span></code></a>(json_data, *[, strict, ...])</p></td>
|
||
<td><p>Usage docs: <a class="reference external" href="https://docs.pydantic.dev/2.10/concepts/json/#json-parsing">https://docs.pydantic.dev/2.10/concepts/json/#json-parsing</a></p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p><a class="reference internal" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.model_validate_strings" title="kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.model_validate_strings"><code class="xref py py-obj docutils literal notranslate"><span class="pre">model_validate_strings</span></code></a>(obj, *[, strict, context])</p></td>
|
||
<td><p>Validate the given object with string data against the Pydantic model.</p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p><a class="reference internal" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.parse_file" title="kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.parse_file"><code class="xref py py-obj docutils literal notranslate"><span class="pre">parse_file</span></code></a>(path, *[, content_type, ...])</p></td>
|
||
<td><p></p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p><a class="reference internal" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.parse_obj" title="kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.parse_obj"><code class="xref py py-obj docutils literal notranslate"><span class="pre">parse_obj</span></code></a>(obj)</p></td>
|
||
<td><p></p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p><a class="reference internal" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.parse_raw" title="kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.parse_raw"><code class="xref py py-obj docutils literal notranslate"><span class="pre">parse_raw</span></code></a>(b, *[, content_type, encoding, ...])</p></td>
|
||
<td><p></p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p><a class="reference internal" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.schema" title="kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.schema"><code class="xref py py-obj docutils literal notranslate"><span class="pre">schema</span></code></a>([by_alias, ref_template])</p></td>
|
||
<td><p></p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p><a class="reference internal" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.schema_json" title="kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.schema_json"><code class="xref py py-obj docutils literal notranslate"><span class="pre">schema_json</span></code></a>(*[, by_alias, ref_template])</p></td>
|
||
<td><p></p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p><a class="reference internal" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.update_forward_refs" title="kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.update_forward_refs"><code class="xref py py-obj docutils literal notranslate"><span class="pre">update_forward_refs</span></code></a>(**localns)</p></td>
|
||
<td><p></p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p><a class="reference internal" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.validate" title="kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.validate"><code class="xref py py-obj docutils literal notranslate"><span class="pre">validate</span></code></a>(value)</p></td>
|
||
<td><p></p></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<p class="rubric">Attributes</p>
|
||
<table class="autosummary longtable docutils align-default">
|
||
<tbody>
|
||
<tr class="row-odd"><td><p><a class="reference internal" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.model_computed_fields" title="kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.model_computed_fields"><code class="xref py py-obj docutils literal notranslate"><span class="pre">model_computed_fields</span></code></a></p></td>
|
||
<td><p></p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p><a class="reference internal" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.model_config" title="kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.model_config"><code class="xref py py-obj docutils literal notranslate"><span class="pre">model_config</span></code></a></p></td>
|
||
<td><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></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p><a class="reference internal" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.model_extra" title="kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.model_extra"><code class="xref py py-obj docutils literal notranslate"><span class="pre">model_extra</span></code></a></p></td>
|
||
<td><p>Get extra fields set during validation.</p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p><a class="reference internal" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.model_fields" title="kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.model_fields"><code class="xref py py-obj docutils literal notranslate"><span class="pre">model_fields</span></code></a></p></td>
|
||
<td><p></p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p><a class="reference internal" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.model_fields_set" title="kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.model_fields_set"><code class="xref py py-obj docutils literal notranslate"><span class="pre">model_fields_set</span></code></a></p></td>
|
||
<td><p>Returns the set of fields that have been explicitly set on this model instance.</p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p><a class="reference internal" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.language" title="kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.language"><code class="xref py py-obj docutils literal notranslate"><span class="pre">language</span></code></a></p></td>
|
||
<td><p></p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p><a class="reference internal" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.next_indent" title="kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.next_indent"><code class="xref py py-obj docutils literal notranslate"><span class="pre">next_indent</span></code></a></p></td>
|
||
<td><p></p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p><a class="reference internal" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.prompt_tokens" title="kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.prompt_tokens"><code class="xref py py-obj docutils literal notranslate"><span class="pre">prompt_tokens</span></code></a></p></td>
|
||
<td><p></p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p><a class="reference internal" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.suffix_tokens" title="kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.suffix_tokens"><code class="xref py py-obj docutils literal notranslate"><span class="pre">suffix_tokens</span></code></a></p></td>
|
||
<td><p></p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p><a class="reference internal" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.trim_by_indentation" title="kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.trim_by_indentation"><code class="xref py py-obj docutils literal notranslate"><span class="pre">trim_by_indentation</span></code></a></p></td>
|
||
<td><p></p></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.__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/kcl_code_completion_params.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.__abstractmethods__" title="Link to this definition"></a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.__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_computed_fields__':</span> <span class="pre">'ClassVar[Dict[str,</span> <span class="pre">ComputedFieldInfo]]',</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__':</span> <span class="pre">'ClassVar[Dict[str,</span> <span class="pre">FieldInfo]]',</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">'language':</span> <span class="pre"><class</span> <span class="pre">'str'>,</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">'next_indent':</span> <span class="pre">typing.Optional[int],</span> <span class="pre">'prompt_tokens':</span> <span class="pre">typing.Optional[int],</span> <span class="pre">'suffix_tokens':</span> <span class="pre">typing.Optional[int],</span> <span class="pre">'trim_by_indentation':</span> <span class="pre"><class</span> <span class="pre">'bool'>}</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/kcl_code_completion_params.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.__annotations__" title="Link to this definition"></a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.__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/kcl_code_completion_params.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.__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 external" href="https://docs.python.org/3/library/functions.html#type" title="(in Python v3.13)"><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.kcl_code_completion_params.KclCodeCompletionParams.__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/kcl_code_completion_params.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.__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.kcl_code_completion_params.KclCodeCompletionParams.__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/kcl_code_completion_params.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.__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.kcl_code_completion_params.KclCodeCompletionParams.__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/kcl_code_completion_params.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.__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.kcl_code_completion_params.KclCodeCompletionParams.__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/kcl_code_completion_params.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.__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.13)"><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.kcl_code_completion_params.KclCodeCompletionParams.__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/kcl_code_completion_params.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.__dict__" title="Link to this definition"></a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.__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/kcl_code_completion_params.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.__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.13)"><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.kcl_code_completion_params.KclCodeCompletionParams.__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.13)"><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.13)"><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/kcl_code_completion_params.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.__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.kcl_code_completion_params.KclCodeCompletionParams.__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/kcl_code_completion_params.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.__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 external" href="https://docs.python.org/3/library/functions.html#type" title="(in Python v3.13)"><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.13)"><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">InvalidSchema</span></code>, <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.kcl_code_completion_params.KclCodeCompletionParams.__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/kcl_code_completion_params.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.__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.13)"><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">InvalidSchema</span></code>, <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.13)"><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.13)"><code class="xref py py-class 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.13)"><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.kcl_code_completion_params.KclCodeCompletionParams.__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/kcl_code_completion_params.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.__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.13)"><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.kcl_code_completion_params.KclCodeCompletionParams.__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/kcl_code_completion_params.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.__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.kcl_code_completion_params.KclCodeCompletionParams.dict" title="kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.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.13)"><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.13)"><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.kcl_code_completion_params.KclCodeCompletionParams.__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/kcl_code_completion_params.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.__hash__" title="Link to this definition"></a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="id0">
|
||
<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/kcl_code_completion_params.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#id0" 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.kcl_code_completion_params.KclCodeCompletionParams.__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/kcl_code_completion_params.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.__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.13)"><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.13)"><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.13)"><code class="xref py py-class 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.13)"><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.13)"><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.13)"><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.kcl_code_completion_params.KclCodeCompletionParams.__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.kcl_code_completion_params'</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/kcl_code_completion_params.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.__module__" title="Link to this definition"></a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.__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/kcl_code_completion_params.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.__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.13)"><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.13)"><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.13)"><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.13)"><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.kcl_code_completion_params.KclCodeCompletionParams.__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/kcl_code_completion_params.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.__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.kcl_code_completion_params.KclCodeCompletionParams.__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/kcl_code_completion_params.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.__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.kcl_code_completion_params.KclCodeCompletionParams.__pydantic_computed_fields__">
|
||
<span class="sig-name descname"><span class="pre">__pydantic_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/kcl_code_completion_params.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.__pydantic_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>][pydantic.fields.ComputedFieldInfo] objects.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.__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.kcl_code_completion_params.KclCodeCompletionParams'>,</span> <span class="pre">'config':</span> <span class="pre">{'title':</span> <span class="pre">'KclCodeCompletionParams'},</span> <span class="pre">'custom_init':</span> <span class="pre">False,</span> <span class="pre">'metadata':</span> <span class="pre">{'pydantic_js_functions':</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.kcl_code_completion_params.KclCodeCompletionParams'>>]},</span> <span class="pre">'ref':</span> <span class="pre">'kittycad.models.kcl_code_completion_params.KclCodeCompletionParams:94376056100656',</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">{'language':</span> <span class="pre">{'metadata':</span> <span class="pre">{},</span> <span class="pre">'schema':</span> <span class="pre">{'default':</span> <span class="pre">'',</span> <span class="pre">'schema':</span> <span class="pre">{'type':</span> <span class="pre">'str'},</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">'next_indent':</span> <span class="pre">{'metadata':</span> <span class="pre">{},</span> <span class="pre">'schema':</span> <span class="pre">{'default':</span> <span class="pre">None,</span> <span class="pre">'schema':</span> <span class="pre">{'schema':</span> <span class="pre">{'type':</span> <span class="pre">'int'},</span> <span class="pre">'type':</span> <span class="pre">'nullable'},</span> <span class="pre">'type':</span> <span class="pre">'default'},</span> <span class="pre">'type':</span> <span class="pre">'model-field'},</span> <span class="pre">'prompt_tokens':</span> <span class="pre">{'metadata':</span> <span class="pre">{},</span> <span class="pre">'schema':</span> <span class="pre">{'default':</span> <span class="pre">None,</span> <span class="pre">'schema':</span> <span class="pre">{'schema':</span> <span class="pre">{'type':</span> <span class="pre">'int'},</span> <span class="pre">'type':</span> <span class="pre">'nullable'},</span> <span class="pre">'type':</span> <span class="pre">'default'},</span> <span class="pre">'type':</span> <span class="pre">'model-field'},</span> <span class="pre">'suffix_tokens':</span> <span class="pre">{'metadata':</span> <span class="pre">{},</span> <span class="pre">'schema':</span> <span class="pre">{'default':</span> <span class="pre">None,</span> <span class="pre">'schema':</span> <span class="pre">{'schema':</span> <span class="pre">{'type':</span> <span class="pre">'int'},</span> <span class="pre">'type':</span> <span class="pre">'nullable'},</span> <span class="pre">'type':</span> <span class="pre">'default'},</span> <span class="pre">'type':</span> <span class="pre">'model-field'},</span> <span class="pre">'trim_by_indentation':</span> <span class="pre">{'metadata':</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">'model_name':</span> <span class="pre">'KclCodeCompletionParams',</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/kcl_code_completion_params.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.__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.kcl_code_completion_params.KclCodeCompletionParams.__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/kcl_code_completion_params.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.__pydantic_custom_init__" title="Link to this definition"></a></dt>
|
||
<dd><p>Whether the model has a custom <a class="reference internal" href="#id0" title="kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.__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.kcl_code_completion_params.KclCodeCompletionParams.__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/kcl_code_completion_params.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.__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.kcl_code_completion_params.KclCodeCompletionParams.__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/kcl_code_completion_params.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.__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.kcl_code_completion_params.KclCodeCompletionParams.__pydantic_fields__">
|
||
<span class="sig-name descname"><span class="pre">__pydantic_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">{'language':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=False,</span> <span class="pre">default=''),</span> <span class="pre">'next_indent':</span> <span class="pre">FieldInfo(annotation=Union[int,</span> <span class="pre">NoneType],</span> <span class="pre">required=False,</span> <span class="pre">default=None),</span> <span class="pre">'prompt_tokens':</span> <span class="pre">FieldInfo(annotation=Union[int,</span> <span class="pre">NoneType],</span> <span class="pre">required=False,</span> <span class="pre">default=None),</span> <span class="pre">'suffix_tokens':</span> <span class="pre">FieldInfo(annotation=Union[int,</span> <span class="pre">NoneType],</span> <span class="pre">required=False,</span> <span class="pre">default=None),</span> <span class="pre">'trim_by_indentation':</span> <span class="pre">FieldInfo(annotation=bool,</span> <span class="pre">required=False,</span> <span class="pre">default=False)}</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/kcl_code_completion_params.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.__pydantic_fields__" title="Link to this definition"></a></dt>
|
||
<dd><p>A dictionary of field names and their corresponding [<code class="xref any docutils literal notranslate"><span class="pre">FieldInfo</span></code>][pydantic.fields.FieldInfo] objects.
|
||
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 attribute">
|
||
<dt class="sig sig-object py" id="kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.__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/kcl_code_completion_params.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.__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.kcl_code_completion_params.KclCodeCompletionParams.__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/kcl_code_completion_params.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.__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.kcl_code_completion_params.KclCodeCompletionParams.__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/kcl_code_completion_params.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.__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.kcl_code_completion_params.KclCodeCompletionParams.model_fields" title="kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.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.13)"><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.13)"><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.kcl_code_completion_params.KclCodeCompletionParams.__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/kcl_code_completion_params.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.__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.kcl_code_completion_params.KclCodeCompletionParams.__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/kcl_code_completion_params.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.__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.kcl_code_completion_params.KclCodeCompletionParams.__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/kcl_code_completion_params.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.__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.kcl_code_completion_params.KclCodeCompletionParams.__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/kcl_code_completion_params.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.__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.kcl_code_completion_params.KclCodeCompletionParams.__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">0x000055d5a34c9730,</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">"language":</span> <span class="pre">SerField</span> <span class="pre">{</span>                         <span class="pre">key_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007fb4671eb1b0,</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">0x00007fb467c19e30,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                     <span class="pre">serializer:</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">required:</span> <span class="pre">true,</span>                     <span class="pre">},</span>                     <span class="pre">"trim_by_indentation":</span> <span class="pre">SerField</span> <span class="pre">{</span>                         <span class="pre">key_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007fb46313a1f0,</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">0x00007fb467b16d20,</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">"next_indent":</span> <span class="pre">SerField</span> <span class="pre">{</span>                         <span class="pre">key_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007fb465c851b0,</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">0x00007fb467b2d100,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                     <span class="pre">serializer:</span> <span class="pre">Nullable(</span>                                         <span class="pre">NullableSerializer</span> <span class="pre">{</span>                                             <span class="pre">serializer:</span> <span class="pre">Int(</span>                                                 <span class="pre">IntSerializer,</span>                                             <span class="pre">),</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">"prompt_tokens":</span> <span class="pre">SerField</span> <span class="pre">{</span>                         <span class="pre">key_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007fb46313a0f0,</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">0x00007fb467b2d100,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                     <span class="pre">serializer:</span> <span class="pre">Nullable(</span>                                         <span class="pre">NullableSerializer</span> <span class="pre">{</span>                                             <span class="pre">serializer:</span> <span class="pre">Int(</span>                                                 <span class="pre">IntSerializer,</span>                                             <span class="pre">),</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">"suffix_tokens":</span> <span class="pre">SerField</span> <span class="pre">{</span>                         <span class="pre">key_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007fb46313a130,</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">0x00007fb467b2d100,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                     <span class="pre">serializer:</span> <span class="pre">Nullable(</span>                                         <span class="pre">NullableSerializer</span> <span class="pre">{</span>                                             <span class="pre">serializer:</span> <span class="pre">Int(</span>                                                 <span class="pre">IntSerializer,</span>                                             <span class="pre">),</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">5,</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">"KclCodeCompletionParams",</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/kcl_code_completion_params.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.__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.kcl_code_completion_params.KclCodeCompletionParams.__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="KclCodeCompletionParams",</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">"language",</span>                         <span class="pre">lookup_key:</span> <span class="pre">Simple</span> <span class="pre">{</span>                             <span class="pre">key:</span> <span class="pre">"language",</span>                             <span class="pre">py_key:</span> <span class="pre">Py(</span>                                 <span class="pre">0x00007fb46313a7f0,</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">"language",</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007fb46313a830,</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">0x00007fb4671eb1b0,</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">0x00007fb467c19e30,</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">Str(</span>                                     <span class="pre">StrValidator</span> <span class="pre">{</span>                                         <span class="pre">strict:</span> <span class="pre">false,</span>                                         <span class="pre">coerce_numbers_to_str:</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[str]",</span>                                 <span class="pre">undefined:</span> <span class="pre">Py(</span>                                     <span class="pre">0x00007fb465c3e3d0,</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">"next_indent",</span>                         <span class="pre">lookup_key:</span> <span class="pre">Simple</span> <span class="pre">{</span>                             <span class="pre">key:</span> <span class="pre">"next_indent",</span>                             <span class="pre">py_key:</span> <span class="pre">Py(</span>                                 <span class="pre">0x00007fb46313a770,</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">"next_indent",</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007fb46313a7b0,</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">0x00007fb465c851b0,</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">0x00007fb467b2d100,</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">Nullable(</span>                                     <span class="pre">NullableValidator</span> <span class="pre">{</span>                                         <span class="pre">validator:</span> <span class="pre">Int(</span>                                             <span class="pre">IntValidator</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">name:</span> <span class="pre">"nullable[int]",</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[nullable[int]]",</span>                                 <span class="pre">undefined:</span> <span class="pre">Py(</span>                                     <span class="pre">0x00007fb465c3e3d0,</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">"prompt_tokens",</span>                         <span class="pre">lookup_key:</span> <span class="pre">Simple</span> <span class="pre">{</span>                             <span class="pre">key:</span> <span class="pre">"prompt_tokens",</span>                             <span class="pre">py_key:</span> <span class="pre">Py(</span>                                 <span class="pre">0x00007fb46313a730,</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">"prompt_tokens",</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007fb46313a6f0,</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">0x00007fb46313a0f0,</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">0x00007fb467b2d100,</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">Nullable(</span>                                     <span class="pre">NullableValidator</span> <span class="pre">{</span>                                         <span class="pre">validator:</span> <span class="pre">Int(</span>                                             <span class="pre">IntValidator</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">name:</span> <span class="pre">"nullable[int]",</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[nullable[int]]",</span>                                 <span class="pre">undefined:</span> <span class="pre">Py(</span>                                     <span class="pre">0x00007fb465c3e3d0,</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">"suffix_tokens",</span>                         <span class="pre">lookup_key:</span> <span class="pre">Simple</span> <span class="pre">{</span>                             <span class="pre">key:</span> <span class="pre">"suffix_tokens",</span>                             <span class="pre">py_key:</span> <span class="pre">Py(</span>                                 <span class="pre">0x00007fb46313a6b0,</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">"suffix_tokens",</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007fb46313a670,</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">0x00007fb46313a130,</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">0x00007fb467b2d100,</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">Nullable(</span>                                     <span class="pre">NullableValidator</span> <span class="pre">{</span>                                         <span class="pre">validator:</span> <span class="pre">Int(</span>                                             <span class="pre">IntValidator</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">name:</span> <span class="pre">"nullable[int]",</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[nullable[int]]",</span>                                 <span class="pre">undefined:</span> <span class="pre">Py(</span>                                     <span class="pre">0x00007fb465c3e3d0,</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">"trim_by_indentation",</span>                         <span class="pre">lookup_key:</span> <span class="pre">Simple</span> <span class="pre">{</span>                             <span class="pre">key:</span> <span class="pre">"trim_by_indentation",</span>                             <span class="pre">py_key:</span> <span class="pre">Py(</span>                                 <span class="pre">0x00007fb46313a630,</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">"trim_by_indentation",</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007fb46313a5f0,</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">0x00007fb46313a1f0,</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">0x00007fb467b16d20,</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">0x00007fb465c3e3d0,</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">"KclCodeCompletionParams",</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">0x000055d5a34c9730,</span>         <span class="pre">),</span>         <span class="pre">generic_origin:</span> <span class="pre">None,</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">0x00007fb465c3e3d0,</span>         <span class="pre">),</span>         <span class="pre">name:</span> <span class="pre">"KclCodeCompletionParams",</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/kcl_code_completion_params.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.__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.kcl_code_completion_params.KclCodeCompletionParams.__replace__">
|
||
<span class="sig-name descname"><span class="pre">__replace__</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">changes</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/kcl_code_completion_params.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.__replace__" 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.kcl_code_completion_params.KclCodeCompletionParams.__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/kcl_code_completion_params.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.__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.13)"><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.kcl_code_completion_params.KclCodeCompletionParams.__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/kcl_code_completion_params.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.__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.13)"><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.13)"><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.13)"><code class="xref 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.13)"><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.13)"><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.kcl_code_completion_params.KclCodeCompletionParams.__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/kcl_code_completion_params.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.__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.13)"><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.kcl_code_completion_params.KclCodeCompletionParams.__repr_recursion__">
|
||
<span class="sig-name descname"><span class="pre">__repr_recursion__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">object</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/kcl_code_completion_params.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.__repr_recursion__" title="Link to this definition"></a></dt>
|
||
<dd><p>Returns the string representation of a recursive object.</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.13)"><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.kcl_code_completion_params.KclCodeCompletionParams.__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/kcl_code_completion_params.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.__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.13)"><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.kcl_code_completion_params.KclCodeCompletionParams.__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/kcl_code_completion_params.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.__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.13)"><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.13)"><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.13)"><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.13)"><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.13)"><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.13)"><code class="xref py py-class 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.13)"><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.13)"><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.13)"><code class="xref py py-class 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.13)"><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.13)"><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.kcl_code_completion_params.KclCodeCompletionParams.__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/kcl_code_completion_params.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.__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.13)"><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.kcl_code_completion_params.KclCodeCompletionParams.__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/kcl_code_completion_params.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.__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.13)"><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.kcl_code_completion_params.KclCodeCompletionParams.__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">language:</span> <span class="pre">str</span> <span class="pre">=</span> <span class="pre">'',</span> <span class="pre">next_indent:</span> <span class="pre">Optional[int]</span> <span class="pre">=</span> <span class="pre">None,</span> <span class="pre">prompt_tokens:</span> <span class="pre">Optional[int]</span> <span class="pre">=</span> <span class="pre">None,</span> <span class="pre">suffix_tokens:</span> <span class="pre">Optional[int]</span> <span class="pre">=</span> <span class="pre">None,</span> <span class="pre">trim_by_indentation:</span> <span class="pre">bool</span> <span class="pre">=</span> <span class="pre">False)</span> <span class="pre">-></span> <span class="pre">None></span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/kcl_code_completion_params.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.__signature__" title="Link to this definition"></a></dt>
|
||
<dd><p>The synthesized <a class="reference internal" href="#id0" title="kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.__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.kcl_code_completion_params.KclCodeCompletionParams.__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/kcl_code_completion_params.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.__slots__" title="Link to this definition"></a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.__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/kcl_code_completion_params.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.__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.13)"><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.kcl_code_completion_params.KclCodeCompletionParams._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/kcl_code_completion_params.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams._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.kcl_code_completion_params.KclCodeCompletionParams._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/kcl_code_completion_params.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams._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.13)"><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.kcl_code_completion_params.KclCodeCompletionParams._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/kcl_code_completion_params.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams._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.13)"><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.kcl_code_completion_params.KclCodeCompletionParams._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/kcl_code_completion_params.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams._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.13)"><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.kcl_code_completion_params.KclCodeCompletionParams._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/kcl_code_completion_params.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams._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.13)"><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.kcl_code_completion_params.KclCodeCompletionParams._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/kcl_code_completion_params.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams._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.13)"><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.kcl_code_completion_params.KclCodeCompletionParams.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/kcl_code_completion_params.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.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.kcl_code_completion_params.KclCodeCompletionParams.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/kcl_code_completion_params.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.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.kcl_code_completion_params.KclCodeCompletionParams.model_copy" title="kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.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">`python</span> <span class="pre">{test="skip"</span> <span class="pre">lint="skip"}</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.kcl_code_completion_params.KclCodeCompletionParams.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/kcl_code_completion_params.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.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.13)"><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.13)"><code class="xref py py-class 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.13)"><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.kcl_code_completion_params.KclCodeCompletionParams.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/kcl_code_completion_params.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.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.kcl_code_completion_params.KclCodeCompletionParams.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/kcl_code_completion_params.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.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.13)"><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.kcl_code_completion_params.KclCodeCompletionParams.language">
|
||
<span class="sig-name descname"><span class="pre">language</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#str" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/kcl_code_completion_params.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.language" title="Link to this definition"></a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.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/kcl_code_completion_params.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.model_computed_fields" title="Link to this definition"></a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.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/kcl_code_completion_params.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.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.kcl_code_completion_params.KclCodeCompletionParams.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/kcl_code_completion_params.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.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.kcl_code_completion_params.KclCodeCompletionParams.__dict__" title="kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.__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.kcl_code_completion_params.KclCodeCompletionParams.__pydantic_fields_set__" title="kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.__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.kcl_code_completion_params.KclCodeCompletionParams.model_construct" title="kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.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.kcl_code_completion_params.KclCodeCompletionParams.__dict__" title="kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.__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.kcl_code_completion_params.KclCodeCompletionParams.__pydantic_extra__" title="kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.__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.kcl_code_completion_params.KclCodeCompletionParams.model_construct" title="kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.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.13)"><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.13)"><code class="xref 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.13)"><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.kcl_code_completion_params.KclCodeCompletionParams.model_fields_set" title="kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.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.13)"><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.kcl_code_completion_params.KclCodeCompletionParams.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/kcl_code_completion_params.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.model_copy" title="Link to this definition"></a></dt>
|
||
<dd><p>Usage docs: <a class="reference external" href="https://docs.pydantic.dev/2.10/concepts/serialization/#model_copy">https://docs.pydantic.dev/2.10/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 external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.13)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Mapping" title="(in Python v3.13)"><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.13)"><code class="xref py py-class 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.13)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Any</span></code></a>]]</span>) – Values to change/add in the new model. Note: the data is not validated
|
||
before creating the new model. You should trust this data.</p></li>
|
||
<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.13)"><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.13)"><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.kcl_code_completion_params.KclCodeCompletionParams.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/kcl_code_completion_params.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.model_dump" title="Link to this definition"></a></dt>
|
||
<dd><p>Usage docs: <a class="reference external" href="https://docs.pydantic.dev/2.10/concepts/serialization/#modelmodel_dump">https://docs.pydantic.dev/2.10/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.13)"><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.13)"><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.13)"><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.13)"><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.13)"><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.13)"><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.13)"><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.13)"><code class="xref py py-class 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.13)"><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.13)"><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.13)"><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.13)"><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.13)"><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.13)"><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.13)"><code class="xref py py-class 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.13)"><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.13)"><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.13)"><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/functions.html#bool" title="(in Python v3.13)"><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.Mapping" title="(in Python v3.13)"><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.13)"><code class="xref py py-class 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.13)"><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/functions.html#bool" title="(in Python v3.13)"><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/functions.html#bool" title="(in Python v3.13)"><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.Mapping" title="(in Python v3.13)"><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.13)"><code class="xref py py-class 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.13)"><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.13)"><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.13)"><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.13)"><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.13)"><code class="xref py py-class 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.13)"><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.13)"><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.13)"><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/functions.html#bool" title="(in Python v3.13)"><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.Mapping" title="(in Python v3.13)"><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.13)"><code class="xref py py-class 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.13)"><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/functions.html#bool" title="(in Python v3.13)"><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/functions.html#bool" title="(in Python v3.13)"><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.13)"><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.13)"><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.13)"><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.13)"><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.13)"><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.13)"><code class="xref py py-class 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.13)"><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.13)"><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.13)"><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.13)"><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.13)"><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.13)"><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.13)"><code class="xref py py-class 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.13)"><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.13)"><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.13)"><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/functions.html#bool" title="(in Python v3.13)"><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.Mapping" title="(in Python v3.13)"><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.13)"><code class="xref py py-class 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.13)"><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/functions.html#bool" title="(in Python v3.13)"><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/functions.html#bool" title="(in Python v3.13)"><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.Mapping" title="(in Python v3.13)"><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.13)"><code class="xref py py-class 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.13)"><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.13)"><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.13)"><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.13)"><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.13)"><code class="xref py py-class 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.13)"><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.13)"><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.13)"><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/functions.html#bool" title="(in Python v3.13)"><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.Mapping" title="(in Python v3.13)"><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.13)"><code class="xref py py-class 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.13)"><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/functions.html#bool" title="(in Python v3.13)"><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/functions.html#bool" title="(in Python v3.13)"><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.13)"><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.13)"><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.13)"><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.13)"><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.13)"><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.13)"><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.13)"><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.13)"><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.13)"><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.13)"><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.13)"><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.13)"><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.13)"><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.kcl_code_completion_params.KclCodeCompletionParams.dict" title="kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.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.13)"><code class="xref py py-class 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.13)"><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.kcl_code_completion_params.KclCodeCompletionParams.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/kcl_code_completion_params.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.model_dump_json" title="Link to this definition"></a></dt>
|
||
<dd><p>Usage docs: <a class="reference external" href="https://docs.pydantic.dev/2.10/concepts/serialization/#modelmodel_dump_json">https://docs.pydantic.dev/2.10/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.13)"><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.13)"><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.13)"><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.13)"><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.13)"><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.13)"><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.13)"><code class="xref py py-class 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.13)"><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.13)"><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.13)"><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.13)"><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.13)"><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.13)"><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.13)"><code class="xref py py-class 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.13)"><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.13)"><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.13)"><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/functions.html#bool" title="(in Python v3.13)"><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.Mapping" title="(in Python v3.13)"><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.13)"><code class="xref py py-class 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.13)"><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/functions.html#bool" title="(in Python v3.13)"><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/functions.html#bool" title="(in Python v3.13)"><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.Mapping" title="(in Python v3.13)"><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.13)"><code class="xref py py-class 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.13)"><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.13)"><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.13)"><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.13)"><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.13)"><code class="xref py py-class 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.13)"><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.13)"><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.13)"><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/functions.html#bool" title="(in Python v3.13)"><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.Mapping" title="(in Python v3.13)"><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.13)"><code class="xref py py-class 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.13)"><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/functions.html#bool" title="(in Python v3.13)"><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/functions.html#bool" title="(in Python v3.13)"><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.13)"><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.13)"><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.13)"><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.13)"><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.13)"><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.13)"><code class="xref py py-class 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.13)"><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.13)"><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.13)"><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.13)"><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.13)"><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.13)"><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.13)"><code class="xref py py-class 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.13)"><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.13)"><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.13)"><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/functions.html#bool" title="(in Python v3.13)"><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.Mapping" title="(in Python v3.13)"><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.13)"><code class="xref py py-class 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.13)"><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/functions.html#bool" title="(in Python v3.13)"><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/functions.html#bool" title="(in Python v3.13)"><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.Mapping" title="(in Python v3.13)"><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.13)"><code class="xref py py-class 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.13)"><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.13)"><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.13)"><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.13)"><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.13)"><code class="xref py py-class 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.13)"><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.13)"><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.13)"><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/functions.html#bool" title="(in Python v3.13)"><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.Mapping" title="(in Python v3.13)"><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.13)"><code class="xref py py-class 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.13)"><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/functions.html#bool" title="(in Python v3.13)"><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/functions.html#bool" title="(in Python v3.13)"><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.13)"><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.13)"><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.13)"><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.13)"><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.13)"><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.13)"><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.13)"><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.13)"><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.13)"><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.13)"><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.13)"><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.13)"><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.13)"><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.13)"><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.kcl_code_completion_params.KclCodeCompletionParams.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.13)"><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.13)"><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.13)"><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.13)"><span class="pre">None</span></a></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/kcl_code_completion_params.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.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.13)"><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.kcl_code_completion_params.KclCodeCompletionParams.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">{'language':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=False,</span> <span class="pre">default=''),</span> <span class="pre">'next_indent':</span> <span class="pre">FieldInfo(annotation=Union[int,</span> <span class="pre">NoneType],</span> <span class="pre">required=False,</span> <span class="pre">default=None),</span> <span class="pre">'prompt_tokens':</span> <span class="pre">FieldInfo(annotation=Union[int,</span> <span class="pre">NoneType],</span> <span class="pre">required=False,</span> <span class="pre">default=None),</span> <span class="pre">'suffix_tokens':</span> <span class="pre">FieldInfo(annotation=Union[int,</span> <span class="pre">NoneType],</span> <span class="pre">required=False,</span> <span class="pre">default=None),</span> <span class="pre">'trim_by_indentation':</span> <span class="pre">FieldInfo(annotation=bool,</span> <span class="pre">required=False,</span> <span class="pre">default=False)}</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/kcl_code_completion_params.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.model_fields" title="Link to this definition"></a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.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.13)"><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.13)"><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/kcl_code_completion_params.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.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.kcl_code_completion_params.KclCodeCompletionParams.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/kcl_code_completion_params.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.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.13)"><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.13)"><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 external" href="https://docs.python.org/3/library/functions.html#type" title="(in Python v3.13)"><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.13)"><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.kcl_code_completion_params.KclCodeCompletionParams.dict" title="kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.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.13)"><code class="xref py py-class 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.13)"><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.kcl_code_completion_params.KclCodeCompletionParams.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/kcl_code_completion_params.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.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.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">tuple</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/functions.html#type" title="(in Python v3.13)"><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.13)"><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.13)"><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.13)"><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.13)"><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.kcl_code_completion_params.KclCodeCompletionParams.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/kcl_code_completion_params.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.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="#id0" title="kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.__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.kcl_code_completion_params.KclCodeCompletionParams.model_construct" title="kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.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.13)"><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.kcl_code_completion_params.KclCodeCompletionParams.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/kcl_code_completion_params.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.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.13)"><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.13)"><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.13)"><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.13)"><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.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></a></span>) – The depth level of the parent namespace, defaults to 2.</p></li>
|
||
<li><p><strong>_types_namespace</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.13)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Mapping" title="(in Python v3.13)"><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.13)"><code class="xref py py-class 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.13)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Any</span></code></a>]]</span>) – The types namespace, defaults to <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><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.13)"><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.13)"><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.13)"><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.13)"><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.13)"><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.kcl_code_completion_params.KclCodeCompletionParams.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/kcl_code_completion_params.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.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.13)"><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.13)"><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.13)"><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.13)"><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.13)"><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.13)"><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.13)"><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.kcl_code_completion_params.KclCodeCompletionParams.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/kcl_code_completion_params.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.model_validate_json" title="Link to this definition"></a></dt>
|
||
<dd><p>Usage docs: <a class="reference external" href="https://docs.pydantic.dev/2.10/concepts/json/#json-parsing">https://docs.pydantic.dev/2.10/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.13)"><code class="xref 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.13)"><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.13)"><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.13)"><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.13)"><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.13)"><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.13)"><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.kcl_code_completion_params.KclCodeCompletionParams.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/kcl_code_completion_params.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.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.13)"><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.13)"><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.13)"><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.13)"><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.13)"><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 attribute">
|
||
<dt class="sig sig-object py" id="kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.next_indent">
|
||
<span class="sig-name descname"><span class="pre">next_indent</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.13)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code></a><span class="pre">[</span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></a><span class="pre">]</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/kcl_code_completion_params.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.next_indent" title="Link to this definition"></a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.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/kcl_code_completion_params.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.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.kcl_code_completion_params.KclCodeCompletionParams.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/kcl_code_completion_params.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.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.kcl_code_completion_params.KclCodeCompletionParams.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/kcl_code_completion_params.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.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 attribute">
|
||
<dt class="sig sig-object py" id="kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.prompt_tokens">
|
||
<span class="sig-name descname"><span class="pre">prompt_tokens</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.13)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code></a><span class="pre">[</span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></a><span class="pre">]</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/kcl_code_completion_params.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.prompt_tokens" title="Link to this definition"></a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.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/kcl_code_completion_params.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.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.13)"><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.13)"><code class="xref py py-class 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.13)"><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.kcl_code_completion_params.KclCodeCompletionParams.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/kcl_code_completion_params.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.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.13)"><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.kcl_code_completion_params.KclCodeCompletionParams.suffix_tokens">
|
||
<span class="sig-name descname"><span class="pre">suffix_tokens</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.13)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code></a><span class="pre">[</span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></a><span class="pre">]</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/kcl_code_completion_params.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.suffix_tokens" title="Link to this definition"></a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.trim_by_indentation">
|
||
<span class="sig-name descname"><span class="pre">trim_by_indentation</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.13)"><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/kcl_code_completion_params.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.trim_by_indentation" title="Link to this definition"></a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.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/kcl_code_completion_params.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.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.13)"><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.kcl_code_completion_params.KclCodeCompletionParams.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/kcl_code_completion_params.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.kcl_code_completion_params.KclCodeCompletionParams.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.kcl_code_completion_params.html" class="btn btn-neutral float-left" title="kittycad.models.kcl_code_completion_params" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||
<a href="kittycad.models.kcl_code_completion_request.html" class="btn btn-neutral float-right" title="kittycad.models.kcl_code_completion_request" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||
</div>
|
||
|
||
<hr/>
|
||
|
||
<div role="contentinfo">
|
||
<p>© Copyright 2025, 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> |