kittycad.models.ok_modeling_cmd_response

Returns:

A JSON schema, as a Python object.

__getattr__(item)[source]

Return type:: Any

__getstate__()[source]

Helper for pickle.

Return type:: dict[Any, Any]

__hash__ = None[source]

__init__(**data)[source]

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__iter__()[source]

So dict(model) works.

Return type:: Generator[Tuple[str, Any], None, None]

__module__ = 'kittycad.models.ok_modeling_cmd_response'[source]

__pretty__(fmt, **kwargs)[source]

Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.

Return type:: Generator[Any, None, None]

__private_attributes__: ClassVar[Dict[str, ModelPrivateAttr]] = {}[source]: Metadata about the private attributes of the model.

__pydantic_complete__: ClassVar[bool] = True[source]: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__: ClassVar[CoreSchema] = {'definitions': [{'cls': <class 'kittycad.models.point3d.Point3d'>, 'config': {'title': 'Point3d'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.point3d.Point3d'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.point3d.Point3d'>>]}, 'ref': 'kittycad.models.point3d.Point3d:94667194426368', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'x': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'type': 'float'}, 'type': 'model-field'}, 'y': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'type': 'float'}, 'type': 'model-field'}, 'z': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'type': 'float'}, 'type': 'model-field'}}, 'model_name': 'Point3d', 'type': 'model-fields'}, 'type': 'model'}], 'schema': {'cls': <class 'kittycad.models.ok_modeling_cmd_response.OptionCameraDragEnd'>, 'config': {'title': 'OptionCameraDragEnd'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.ok_modeling_cmd_response.OptionCameraDragEnd'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.ok_modeling_cmd_response.OptionCameraDragEnd'>>]}, 'ref': 'kittycad.models.ok_modeling_cmd_response.OptionCameraDragEnd:94667213341952', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'data': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.camera_drag_end.CameraDragEnd'>, 'config': {'title': 'CameraDragEnd'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.camera_drag_end.CameraDragEnd'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.camera_drag_end.CameraDragEnd'>>]}, 'ref': 'kittycad.models.camera_drag_end.CameraDragEnd:94667204665072', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'settings': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.camera_settings.CameraSettings'>, 'config': {'title': 'CameraSettings'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.camera_settings.CameraSettings'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.camera_settings.CameraSettings'>>]}, 'ref': 'kittycad.models.camera_settings.CameraSettings:94667204631840', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'center': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'schema_ref': 'kittycad.models.point3d.Point3d:94667194426368', 'type': 'definition-ref'}, 'type': 'model-field'}, 'fov_y': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': None, 'schema': {'schema': {'type': 'float'}, 'type': 'nullable'}, 'type': 'default'}, 'type': 'model-field'}, 'orientation': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.point4d.Point4d'>, 'config': {'title': 'Point4d'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.point4d.Point4d'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.point4d.Point4d'>>]}, 'ref': 'kittycad.models.point4d.Point4d:94667204627760', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'w': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'type': 'float'}, 'type': 'model-field'}, 'x': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'type': 'float'}, 'type': 'model-field'}, 'y': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'type': 'float'}, 'type': 'model-field'}, 'z': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'type': 'float'}, 'type': 'model-field'}}, 'model_name': 'Point4d', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}, 'ortho': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'type': 'bool'}, 'type': 'model-field'}, 'ortho_scale': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': None, 'schema': {'schema': {'type': 'float'}, 'type': 'nullable'}, 'type': 'default'}, 'type': 'model-field'}, 'pos': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'schema_ref': 'kittycad.models.point3d.Point3d:94667194426368', 'type': 'definition-ref'}, 'type': 'model-field'}, 'up': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'schema_ref': 'kittycad.models.point3d.Point3d:94667194426368', 'type': 'definition-ref'}, 'type': 'model-field'}}, 'model_name': 'CameraSettings', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}}, 'model_name': 'CameraDragEnd', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}, 'type': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': 'camera_drag_end', 'schema': {'expected': ['camera_drag_end'], 'type': 'literal'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'OptionCameraDragEnd', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'definitions'}[source]: The core schema of the model.

__pydantic_custom_init__: ClassVar[bool] = False[source]: Whether the model has a custom __init__ method.

__pydantic_decorators__: ClassVar[_decorators.DecoratorInfos] = DecoratorInfos(validators={}, field_validators={}, root_validators={}, field_serializers={}, model_serializers={}, model_validators={}, computed_fields={})[source]: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_extra__: dict[str, Any] | None[source]: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to 'allow'.

__pydantic_fields_set__: set[str][source]: The names of fields explicitly set during instantiation.

__pydantic_generic_metadata__: ClassVar[_generics.PydanticGenericMetadata] = {'args': (), 'origin': None, 'parameters': ()}[source]: 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.

classmethod __pydantic_init_subclass__(**kwargs)[source]

This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.

This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.

This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.

Parameters:: **kwargs (Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.
Return type:: None

__pydantic_parent_namespace__: ClassVar[Dict[str, Any] | None] = None[source]: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__: ClassVar[None | Literal['model_post_init']] = None[source]: The name of the post-init method for the model, if defined.

__pydantic_private__: dict[str, Any] | None[source]: Values of private attributes set on the model instance.

__pydantic_root_model__: ClassVar[bool] = False[source]: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__: ClassVar[SchemaSerializer] = SchemaSerializer(serializer=Model( ModelSerializer { class: Py( 0x000056196d9f8500, ), serializer: Fields( GeneralFieldsSerializer { fields: { "type": SerField { key_py: Py( 0x00007f903823d958, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f9034732fb0, ), ), serializer: Literal( LiteralSerializer { expected_int: {}, expected_str: { "camera_drag_end", }, expected_py: None, name: "literal['camera_drag_end']", }, ), }, ), ), required: true, }, "data": SerField { key_py: Py( 0x00007f9038238fa0, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196d1b1ef0, ), serializer: Fields( GeneralFieldsSerializer { fields: { "settings": SerField { key_py: Py( 0x00007f903711fa30, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196d1a9d20, ), serializer: Fields( GeneralFieldsSerializer { fields: { "orientation": SerField { key_py: Py( 0x00007f9033c27ef0, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196d1a8d30, ), serializer: Fields( GeneralFieldsSerializer { fields: { "w": SerField { key_py: Py( 0x00007f903823f4f8, ), alias: None, alias_py: None, serializer: Some( Float( FloatSerializer { inf_nan_mode: Null, }, ), ), required: true, }, "y": SerField { key_py: Py( 0x00007f903823f558, ), alias: None, alias_py: None, serializer: Some( Float( FloatSerializer { inf_nan_mode: Null, }, ), ), required: true, }, "x": SerField { key_py: Py( 0x00007f903823de18, ), alias: None, alias_py: None, serializer: Some( Float( FloatSerializer { inf_nan_mode: Null, }, ), ), required: true, }, "z": SerField { key_py: Py( 0x00007f903823f588, ), alias: None, alias_py: None, serializer: Some( Float( FloatSerializer { inf_nan_mode: Null, }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 4, }, ), has_extra: false, root_model: false, name: "Point4d", }, ), ), required: true, }, "pos": SerField { key_py: Py( 0x00007f903823c150, ), alias: None, alias_py: None, serializer: Some( Recursive( DefinitionRefSerializer { definition: "...", retry_with_lax_check: true, }, ), ), required: true, }, "ortho": SerField { key_py: Py( 0x00007f9033e16550, ), alias: None, alias_py: None, serializer: Some( Bool( BoolSerializer, ), ), required: true, }, "up": SerField { key_py: Py( 0x00007f9036ff7720, ), alias: None, alias_py: None, serializer: Some( Recursive( DefinitionRefSerializer { definition: "...", retry_with_lax_check: true, }, ), ), required: true, }, "fov_y": SerField { key_py: Py( 0x00007f9033e16400, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f9038148100, ), ), serializer: Nullable( NullableSerializer { serializer: Float( FloatSerializer { inf_nan_mode: Null, }, ), }, ), }, ), ), required: true, }, "center": SerField { key_py: Py( 0x00007f9037b08150, ), alias: None, alias_py: None, serializer: Some( Recursive( DefinitionRefSerializer { definition: "...", retry_with_lax_check: true, }, ), ), required: true, }, "ortho_scale": SerField { key_py: Py( 0x00007f9033c27eb0, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f9038148100, ), ), serializer: Nullable( NullableSerializer { serializer: Float( FloatSerializer { inf_nan_mode: Null, }, ), }, ), }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 7, }, ), has_extra: false, root_model: false, name: "CameraSettings", }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 1, }, ), has_extra: false, root_model: false, name: "CameraDragEnd", }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "OptionCameraDragEnd", }, ), definitions=[Model(ModelSerializer { class: Py(0x56196c7ee400), serializer: Fields(GeneralFieldsSerializer { fields: {"x": SerField { key_py: Py(0x7f903823de18), alias: None, alias_py: None, serializer: Some(Float(FloatSerializer { inf_nan_mode: Null })), required: true }, "z": SerField { key_py: Py(0x7f903823f588), alias: None, alias_py: None, serializer: Some(Float(FloatSerializer { inf_nan_mode: Null })), required: true }, "y": SerField { key_py: Py(0x7f903823f558), alias: None, alias_py: None, serializer: Some(Float(FloatSerializer { inf_nan_mode: Null })), required: true }}, computed_fields: Some(ComputedFields([])), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None }, required_fields: 3 }), has_extra: false, root_model: false, name: "Point3d" })])[source]: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__: ClassVar[SchemaValidator | PluggableSchemaValidator] = SchemaValidator(title="OptionCameraDragEnd", validator=Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "data", lookup_key: Simple { key: "data", py_key: Py( 0x00007f90335237e0, ), path: LookupPath( [ S( "data", Py( 0x00007f90335237b0, ), ), ], ), }, name_py: Py( 0x00007f9038238fa0, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "settings", lookup_key: Simple { key: "settings", py_key: Py( 0x00007f903335c370, ), path: LookupPath( [ S( "settings", Py( 0x00007f903335c0f0, ), ), ], ), }, name_py: Py( 0x00007f903711fa30, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "center", lookup_key: Simple { key: "center", py_key: Py( 0x00007f9033523a50, ), path: LookupPath( [ S( "center", Py( 0x00007f9033523900, ), ), ], ), }, name_py: Py( 0x00007f9037b08150, ), validator: DefinitionRef( DefinitionRefValidator { definition: "...", }, ), frozen: false, }, Field { name: "fov_y", lookup_key: Simple { key: "fov_y", py_key: Py( 0x00007f9033523930, ), path: LookupPath( [ S( "fov_y", Py( 0x00007f90335238a0, ), ), ], ), }, name_py: Py( 0x00007f9033e16400, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f9038148100, ), ), on_error: Raise, validator: Nullable( NullableValidator { validator: Float( FloatValidator { strict: false, allow_inf_nan: true, }, ), name: "nullable[float]", }, ), validate_default: false, copy_default: false, name: "default[nullable[float]]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, Field { name: "orientation", lookup_key: Simple { key: "orientation", py_key: Py( 0x00007f903335d630, ), path: LookupPath( [ S( "orientation", Py( 0x00007f903335e230, ), ), ], ), }, name_py: Py( 0x00007f9033c27ef0, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "w", lookup_key: Simple { key: "w", py_key: Py( 0x00007f903823f4f8, ), path: LookupPath( [ S( "w", Py( 0x00007f903823f4f8, ), ), ], ), }, name_py: Py( 0x00007f903823f4f8, ), validator: Float( FloatValidator { strict: false, allow_inf_nan: true, }, ), frozen: false, }, Field { name: "x", lookup_key: Simple { key: "x", py_key: Py( 0x00007f903823f528, ), path: LookupPath( [ S( "x", Py( 0x00007f903823f528, ), ), ], ), }, name_py: Py( 0x00007f903823de18, ), validator: Float( FloatValidator { strict: false, allow_inf_nan: true, }, ), frozen: false, }, Field { name: "y", lookup_key: Simple { key: "y", py_key: Py( 0x00007f903823f558, ), path: LookupPath( [ S( "y", Py( 0x00007f903823f558, ), ), ], ), }, name_py: Py( 0x00007f903823f558, ), validator: Float( FloatValidator { strict: false, allow_inf_nan: true, }, ), frozen: false, }, Field { name: "z", lookup_key: Simple { key: "z", py_key: Py( 0x00007f903823f588, ), path: LookupPath( [ S( "z", Py( 0x00007f903823f588, ), ), ], ), }, name_py: Py( 0x00007f903823f588, ), validator: Float( FloatValidator { strict: false, allow_inf_nan: true, }, ), frozen: false, }, ], model_name: "Point4d", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d1a8d30, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "Point4d", }, ), frozen: false, }, Field { name: "ortho", lookup_key: Simple { key: "ortho", py_key: Py( 0x00007f9033523a80, ), path: LookupPath( [ S( "ortho", Py( 0x00007f90335236f0, ), ), ], ), }, name_py: Py( 0x00007f9033e16550, ), validator: Bool( BoolValidator { strict: false, }, ), frozen: false, }, Field { name: "ortho_scale", lookup_key: Simple { key: "ortho_scale", py_key: Py( 0x00007f903335e2f0, ), path: LookupPath( [ S( "ortho_scale", Py( 0x00007f903335d530, ), ), ], ), }, name_py: Py( 0x00007f9033c27eb0, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f9038148100, ), ), on_error: Raise, validator: Nullable( NullableValidator { validator: Float( FloatValidator { strict: false, allow_inf_nan: true, }, ), name: "nullable[float]", }, ), validate_default: false, copy_default: false, name: "default[nullable[float]]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, Field { name: "pos", lookup_key: Simple { key: "pos", py_key: Py( 0x00007f9033523750, ), path: LookupPath( [ S( "pos", Py( 0x00007f9033523720, ), ), ], ), }, name_py: Py( 0x00007f903823c150, ), validator: DefinitionRef( DefinitionRefValidator { definition: "...", }, ), frozen: false, }, Field { name: "up", lookup_key: Simple { key: "up", py_key: Py( 0x00007f9033523870, ), path: LookupPath( [ S( "up", Py( 0x00007f9033523840, ), ), ], ), }, name_py: Py( 0x00007f9036ff7720, ), validator: DefinitionRef( DefinitionRefValidator { definition: "...", }, ), frozen: false, }, ], model_name: "CameraSettings", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d1a9d20, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "CameraSettings", }, ), frozen: false, }, ], model_name: "CameraDragEnd", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d1b1ef0, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "CameraDragEnd", }, ), frozen: false, }, Field { name: "type", lookup_key: Simple { key: "type", py_key: Py( 0x00007f9033523810, ), path: LookupPath( [ S( "type", Py( 0x00007f9033523480, ), ), ], ), }, name_py: Py( 0x00007f903823d958, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f9034732fb0, ), ), on_error: Raise, validator: Literal( LiteralValidator { lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "camera_drag_end": 0, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f9034732fb0, ), ], }, expected_repr: "'camera_drag_end'", name: "literal['camera_drag_end']", }, ), validate_default: false, copy_default: false, name: "default[literal['camera_drag_end']]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "OptionCameraDragEnd", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d9f8500, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "OptionCameraDragEnd", }, ), definitions=[Model(ModelValidator { revalidate: Never, validator: ModelFields(ModelFieldsValidator { fields: [Field { name: "x", lookup_key: Simple { key: "x", py_key: Py(0x7f903823f528), path: LookupPath([S("x", Py(0x7f903823f528))]) }, name_py: Py(0x7f903823de18), validator: Float(FloatValidator { strict: false, allow_inf_nan: true }), frozen: false }, Field { name: "y", lookup_key: Simple { key: "y", py_key: Py(0x7f903823f558), path: LookupPath([S("y", Py(0x7f903823f558))]) }, name_py: Py(0x7f903823f558), validator: Float(FloatValidator { strict: false, allow_inf_nan: true }), frozen: false }, Field { name: "z", lookup_key: Simple { key: "z", py_key: Py(0x7f903823f588), path: LookupPath([S("z", Py(0x7f903823f588))]) }, name_py: Py(0x7f903823f588), validator: Float(FloatValidator { strict: false, allow_inf_nan: true }), frozen: false }], model_name: "Point3d", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true }), class: Py(0x56196c7ee400), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py(0x7f903629a320), name: "Point3d" })], cache_strings=True)[source]: The pydantic-core SchemaValidator used to validate instances of the model.

__repr__()[source]

Return repr(self).

Return type:: str

__repr_args__()[source]

Return type:: Iterable[tuple[str | None, Any]]

__repr_name__()[source]

Name of the instance’s class, used in __repr__.

Return type:: str

__repr_str__(join_str)[source]

Return type:: str

__rich_repr__()[source]

Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.

Return type:: Iterable[Any | tuple[Any] | tuple[str, Any] | tuple[str, Any, Any]]

__setattr__(name, value)[source]

Implement setattr(self, name, value).

Return type:: None

__setstate__(state)[source]

Return type:: None

__signature__: ClassVar[Signature] = <Signature (*, data: kittycad.models.camera_drag_end.CameraDragEnd, type: Literal['camera_drag_end'] = 'camera_drag_end') -> None>[source]: The synthesized __init__ [Signature][inspect.Signature] of the model.

__slots__ = ('__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__')[source]

__str__()[source]

Return str(self).

Return type:: str

_abc_impl = <_abc._abc_data object>[source]

_calculate_keys(*args, **kwargs)[source]

Return type:: Any

_check_frozen(name, value)[source]

Return type:: None

_copy_and_set_values(*args, **kwargs)[source]

Return type:: Any

classmethod _get_value(*args, **kwargs)[source]

Return type:: Any

_iter(*args, **kwargs)[source]

Return type:: Any

classmethod construct(_fields_set=None, **values)[source]

Return type:: Self

copy(*, include=None, exclude=None, update=None, deep=False)[source]

Returns a copy of the model.

!!! warning “Deprecated”: This method is now deprecated; use model_copy instead.

If you need include or exclude, use:

`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `

Parameters:

include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.

Returns:

A copy of the model with included, excluded and updated fields as specified.

data: CameraDragEnd[source]

dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)[source]

Return type:: Dict[str, Any]

classmethod from_orm(obj)[source]

Return type:: Self

json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)[source]

Return type:: str

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}[source]: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'protected_namespaces': ()}[source]: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod model_construct(_fields_set=None, **values)[source]

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note: model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == 'allow', then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == 'ignore' (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == 'forbid' does not result in an error if extra values are passed, but they will be ignored.

Parameters:

_fields_set (set[str] | None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.
values (Any) – Trusted or pre-validated data dictionary.

Return type:

Self

Returns:

A new instance of the Model class with validated data.

model_copy(*, update=None, deep=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy

Returns a copy of the model.

Parameters:

update (dict[str, Any] | None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.
deep (bool) – Set to True to make a deep copy of the model.

Return type:

Self

Returns:

New model instance.

model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters:

mode (Union[Literal['json', 'python'], str]) – The mode in which to_python 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.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to include in the output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to exclude from the output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to use the field’s alias in the dictionary key if defined.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A dictionary representation of the model.

model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

Generates a JSON representation of the model using Pydantic’s to_json method.

Parameters:

indent (int | None) – Indentation to use in the JSON output. If None is passed, the output will be compact.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to include in the JSON output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to exclude from the JSON output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to serialize using field aliases.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A JSON string representation of the model.

property model_extra: dict[str, Any] | None[source]

Get extra fields set during validation.

Returns:: A dictionary of extra fields, or None if config.extra is not set to "allow".

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=CameraDragEnd, required=True), 'type': FieldInfo(annotation=Literal['camera_drag_end'], required=False, default='camera_drag_end')}[source]

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

property model_fields_set: set[str][source]

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,: i.e. that were not filled from defaults.

classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')[source]

Generates a JSON schema for a model class.

Parameters:

by_alias (bool) – Whether to use attribute aliases or not.
ref_template (str) – The reference template.
schema_generator (type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modifications
mode (Literal['validation', 'serialization']) – The mode in which to generate the schema.

Return type:

Returns:

The JSON schema for the given model class.

classmethod model_parametrized_name(params)[source]

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

Parameters:: params (tuple[type[Any], ...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.
Return type:: str
Returns:: String representing the new class where params are passed to cls as type variables.
Raises:: TypeError – Raised when trying to generate concrete names for non-generic models.

model_post_init(_BaseModel__context)[source]

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

Return type:: None

classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)[source]

Try to rebuild the pydantic-core schema for the model.

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.

Parameters:

force (bool) – Whether to force the rebuilding of the model schema, defaults to False.
raise_errors (bool) – Whether to raise errors, defaults to True.
_parent_namespace_depth (int) – The depth level of the parent namespace, defaults to 2.
_types_namespace (dict[str, Any] | None) – The types namespace, defaults to None.

Return type:

Returns:

Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.

classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)[source]

Validate a pydantic model instance.

Parameters:

obj (Any) – The object to validate.
strict (bool | None) – Whether to enforce types strictly.
from_attributes (bool | None) – Whether to extract data from object attributes.
context (Any | None) – Additional context to pass to the validator.

Raises:

ValidationError – If the object could not be validated.

Return type:

Self

Returns:

The validated model instance.

classmethod model_validate_json(json_data, *, strict=None, context=None)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing

Validate the given JSON data against the Pydantic model.

Parameters:

json_data (str | bytes | bytearray) – The JSON data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

Raises:

ValidationError – If json_data is not a JSON string or the object could not be validated.

classmethod model_validate_strings(obj, *, strict=None, context=None)[source]

Validate the given object with string data against the Pydantic model.

Parameters:

obj (Any) – The object containing string data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod parse_obj(obj)[source]

Return type:: Self

classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod schema(by_alias=True, ref_template='#/$defs/{model}')[source]

Return type:: Dict[str, Any]

classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)[source]

Return type:: str

type: Literal['camera_drag_end'][source]

classmethod update_forward_refs(**localns)[source]

Return type:: None

classmethod validate(value)[source]

Return type:: Self

class kittycad.models.ok_modeling_cmd_response.OptionCameraDragMove(**data)[source][source]

The response to the ‘CameraDragMove’ endpoint

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__abstractmethods__ = frozenset({})[source]

__annotations__ = {'__class_vars__': 'ClassVar[set[str]]', '__private_attributes__': 'ClassVar[Dict[str, ModelPrivateAttr]]', '__pydantic_complete__': 'ClassVar[bool]', '__pydantic_core_schema__': 'ClassVar[CoreSchema]', '__pydantic_custom_init__': 'ClassVar[bool]', '__pydantic_decorators__': 'ClassVar[_decorators.DecoratorInfos]', '__pydantic_extra__': 'dict[str, Any] | None', '__pydantic_fields_set__': 'set[str]', '__pydantic_generic_metadata__': 'ClassVar[_generics.PydanticGenericMetadata]', '__pydantic_parent_namespace__': 'ClassVar[Dict[str, Any] | None]', '__pydantic_post_init__': "ClassVar[None | Literal['model_post_init']]", '__pydantic_private__': 'dict[str, Any] | None', '__pydantic_root_model__': 'ClassVar[bool]', '__pydantic_serializer__': 'ClassVar[SchemaSerializer]', '__pydantic_validator__': 'ClassVar[SchemaValidator | PluggableSchemaValidator]', '__signature__': 'ClassVar[Signature]', 'data': <class 'kittycad.models.camera_drag_move.CameraDragMove'>, 'model_computed_fields': 'ClassVar[Dict[str, ComputedFieldInfo]]', 'model_config': 'ClassVar[ConfigDict]', 'model_fields': 'ClassVar[Dict[str, FieldInfo]]', 'type': typing.Literal['camera_drag_move']}[source]

classmethod __class_getitem__(typevar_values)[source]

Return type:: type[BaseModel] | PydanticRecursiveRef

__class_vars__: ClassVar[set[str]] = {}[source]: The names of the class variables defined on the model.

__copy__()[source]

Returns a shallow copy of the model.

Return type:: Self

__deepcopy__(memo=None)[source]

Returns a deep copy of the model.

Return type:: Self

__delattr__(item)[source]

Implement delattr(self, name).

Return type:: Any

__dict__[source]

__eq__(other)[source]

Return self==value.

Return type:: bool

property __fields_set__: set[str][source]

classmethod __get_pydantic_core_schema__(source, handler, /)[source]

Hook into generating the model’s CoreSchema.

Parameters:

source (type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.
handler (GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.

Return type:

Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]

Returns:

A pydantic-core CoreSchema.

classmethod __get_pydantic_json_schema__(core_schema, handler, /)[source]

Hook into generating the model’s JSON schema.

Parameters:

core_schema (Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({'type': 'nullable', 'schema': current_schema}), or just call the handler with the original schema.
handler (GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.

Return type:

Returns:

A JSON schema, as a Python object.

__getattr__(item)[source]

Return type:: Any

__getstate__()[source]

Helper for pickle.

Return type:: dict[Any, Any]

__hash__ = None[source]

__init__(**data)[source]

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__iter__()[source]

So dict(model) works.

Return type:: Generator[Tuple[str, Any], None, None]

__module__ = 'kittycad.models.ok_modeling_cmd_response'[source]

__pretty__(fmt, **kwargs)[source]

Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.

Return type:: Generator[Any, None, None]

__private_attributes__: ClassVar[Dict[str, ModelPrivateAttr]] = {}[source]: Metadata about the private attributes of the model.

__pydantic_complete__: ClassVar[bool] = True[source]: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__: ClassVar[CoreSchema] = {'definitions': [{'cls': <class 'kittycad.models.point3d.Point3d'>, 'config': {'title': 'Point3d'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.point3d.Point3d'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.point3d.Point3d'>>]}, 'ref': 'kittycad.models.point3d.Point3d:94667194426368', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'x': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'type': 'float'}, 'type': 'model-field'}, 'y': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'type': 'float'}, 'type': 'model-field'}, 'z': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'type': 'float'}, 'type': 'model-field'}}, 'model_name': 'Point3d', 'type': 'model-fields'}, 'type': 'model'}], 'schema': {'cls': <class 'kittycad.models.ok_modeling_cmd_response.OptionCameraDragMove'>, 'config': {'title': 'OptionCameraDragMove'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.ok_modeling_cmd_response.OptionCameraDragMove'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.ok_modeling_cmd_response.OptionCameraDragMove'>>]}, 'ref': 'kittycad.models.ok_modeling_cmd_response.OptionCameraDragMove:94667213330592', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'data': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.camera_drag_move.CameraDragMove'>, 'config': {'title': 'CameraDragMove'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.camera_drag_move.CameraDragMove'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.camera_drag_move.CameraDragMove'>>]}, 'ref': 'kittycad.models.camera_drag_move.CameraDragMove:94667204697184', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'settings': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.camera_settings.CameraSettings'>, 'config': {'title': 'CameraSettings'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.camera_settings.CameraSettings'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.camera_settings.CameraSettings'>>]}, 'ref': 'kittycad.models.camera_settings.CameraSettings:94667204631840', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'center': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'schema_ref': 'kittycad.models.point3d.Point3d:94667194426368', 'type': 'definition-ref'}, 'type': 'model-field'}, 'fov_y': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': None, 'schema': {'schema': {'type': 'float'}, 'type': 'nullable'}, 'type': 'default'}, 'type': 'model-field'}, 'orientation': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.point4d.Point4d'>, 'config': {'title': 'Point4d'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.point4d.Point4d'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.point4d.Point4d'>>]}, 'ref': 'kittycad.models.point4d.Point4d:94667204627760', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'w': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'type': 'float'}, 'type': 'model-field'}, 'x': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'type': 'float'}, 'type': 'model-field'}, 'y': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'type': 'float'}, 'type': 'model-field'}, 'z': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'type': 'float'}, 'type': 'model-field'}}, 'model_name': 'Point4d', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}, 'ortho': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'type': 'bool'}, 'type': 'model-field'}, 'ortho_scale': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': None, 'schema': {'schema': {'type': 'float'}, 'type': 'nullable'}, 'type': 'default'}, 'type': 'model-field'}, 'pos': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'schema_ref': 'kittycad.models.point3d.Point3d:94667194426368', 'type': 'definition-ref'}, 'type': 'model-field'}, 'up': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'schema_ref': 'kittycad.models.point3d.Point3d:94667194426368', 'type': 'definition-ref'}, 'type': 'model-field'}}, 'model_name': 'CameraSettings', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}}, 'model_name': 'CameraDragMove', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}, 'type': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': 'camera_drag_move', 'schema': {'expected': ['camera_drag_move'], 'type': 'literal'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'OptionCameraDragMove', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'definitions'}[source]: The core schema of the model.

__pydantic_custom_init__: ClassVar[bool] = False[source]: Whether the model has a custom __init__ method.

__pydantic_decorators__: ClassVar[_decorators.DecoratorInfos] = DecoratorInfos(validators={}, field_validators={}, root_validators={}, field_serializers={}, model_serializers={}, model_validators={}, computed_fields={})[source]: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_extra__: dict[str, Any] | None[source]: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to 'allow'.

__pydantic_fields_set__: set[str][source]: The names of fields explicitly set during instantiation.

__pydantic_generic_metadata__: ClassVar[_generics.PydanticGenericMetadata] = {'args': (), 'origin': None, 'parameters': ()}[source]: 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.

classmethod __pydantic_init_subclass__(**kwargs)[source]

This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.

This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.

This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.

Parameters:: **kwargs (Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.
Return type:: None

__pydantic_parent_namespace__: ClassVar[Dict[str, Any] | None] = None[source]: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__: ClassVar[None | Literal['model_post_init']] = None[source]: The name of the post-init method for the model, if defined.

__pydantic_private__: dict[str, Any] | None[source]: Values of private attributes set on the model instance.

__pydantic_root_model__: ClassVar[bool] = False[source]: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__: ClassVar[SchemaSerializer] = SchemaSerializer(serializer=Model( ModelSerializer { class: Py( 0x000056196d9f58a0, ), serializer: Fields( GeneralFieldsSerializer { fields: { "type": SerField { key_py: Py( 0x00007f903823d958, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f90347332f0, ), ), serializer: Literal( LiteralSerializer { expected_int: {}, expected_str: { "camera_drag_move", }, expected_py: None, name: "literal['camera_drag_move']", }, ), }, ), ), required: true, }, "data": SerField { key_py: Py( 0x00007f9038238fa0, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196d1b9c60, ), serializer: Fields( GeneralFieldsSerializer { fields: { "settings": SerField { key_py: Py( 0x00007f903711fa30, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196d1a9d20, ), serializer: Fields( GeneralFieldsSerializer { fields: { "fov_y": SerField { key_py: Py( 0x00007f9033e16400, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f9038148100, ), ), serializer: Nullable( NullableSerializer { serializer: Float( FloatSerializer { inf_nan_mode: Null, }, ), }, ), }, ), ), required: true, }, "orientation": SerField { key_py: Py( 0x00007f9033c27ef0, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196d1a8d30, ), serializer: Fields( GeneralFieldsSerializer { fields: { "w": SerField { key_py: Py( 0x00007f903823f4f8, ), alias: None, alias_py: None, serializer: Some( Float( FloatSerializer { inf_nan_mode: Null, }, ), ), required: true, }, "y": SerField { key_py: Py( 0x00007f903823f558, ), alias: None, alias_py: None, serializer: Some( Float( FloatSerializer { inf_nan_mode: Null, }, ), ), required: true, }, "x": SerField { key_py: Py( 0x00007f903823de18, ), alias: None, alias_py: None, serializer: Some( Float( FloatSerializer { inf_nan_mode: Null, }, ), ), required: true, }, "z": SerField { key_py: Py( 0x00007f903823f588, ), alias: None, alias_py: None, serializer: Some( Float( FloatSerializer { inf_nan_mode: Null, }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 4, }, ), has_extra: false, root_model: false, name: "Point4d", }, ), ), required: true, }, "center": SerField { key_py: Py( 0x00007f9037b08150, ), alias: None, alias_py: None, serializer: Some( Recursive( DefinitionRefSerializer { definition: "...", retry_with_lax_check: true, }, ), ), required: true, }, "ortho_scale": SerField { key_py: Py( 0x00007f9033c27eb0, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f9038148100, ), ), serializer: Nullable( NullableSerializer { serializer: Float( FloatSerializer { inf_nan_mode: Null, }, ), }, ), }, ), ), required: true, }, "ortho": SerField { key_py: Py( 0x00007f9033e16550, ), alias: None, alias_py: None, serializer: Some( Bool( BoolSerializer, ), ), required: true, }, "pos": SerField { key_py: Py( 0x00007f903823c150, ), alias: None, alias_py: None, serializer: Some( Recursive( DefinitionRefSerializer { definition: "...", retry_with_lax_check: true, }, ), ), required: true, }, "up": SerField { key_py: Py( 0x00007f9036ff7720, ), alias: None, alias_py: None, serializer: Some( Recursive( DefinitionRefSerializer { definition: "...", retry_with_lax_check: true, }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 7, }, ), has_extra: false, root_model: false, name: "CameraSettings", }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 1, }, ), has_extra: false, root_model: false, name: "CameraDragMove", }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "OptionCameraDragMove", }, ), definitions=[Model(ModelSerializer { class: Py(0x56196c7ee400), serializer: Fields(GeneralFieldsSerializer { fields: {"y": SerField { key_py: Py(0x7f903823f558), alias: None, alias_py: None, serializer: Some(Float(FloatSerializer { inf_nan_mode: Null })), required: true }, "z": SerField { key_py: Py(0x7f903823f588), alias: None, alias_py: None, serializer: Some(Float(FloatSerializer { inf_nan_mode: Null })), required: true }, "x": SerField { key_py: Py(0x7f903823de18), alias: None, alias_py: None, serializer: Some(Float(FloatSerializer { inf_nan_mode: Null })), required: true }}, computed_fields: Some(ComputedFields([])), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None }, required_fields: 3 }), has_extra: false, root_model: false, name: "Point3d" })])[source]: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__: ClassVar[SchemaValidator | PluggableSchemaValidator] = SchemaValidator(title="OptionCameraDragMove", validator=Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "data", lookup_key: Simple { key: "data", py_key: Py( 0x00007f9033523cc0, ), path: LookupPath( [ S( "data", Py( 0x00007f9033523cf0, ), ), ], ), }, name_py: Py( 0x00007f9038238fa0, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "settings", lookup_key: Simple { key: "settings", py_key: Py( 0x00007f90333682b0, ), path: LookupPath( [ S( "settings", Py( 0x00007f90333682f0, ), ), ], ), }, name_py: Py( 0x00007f903711fa30, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "center", lookup_key: Simple { key: "center", py_key: Py( 0x00007f9033523ae0, ), path: LookupPath( [ S( "center", Py( 0x00007f9033523b10, ), ), ], ), }, name_py: Py( 0x00007f9037b08150, ), validator: DefinitionRef( DefinitionRefValidator { definition: "...", }, ), frozen: false, }, Field { name: "fov_y", lookup_key: Simple { key: "fov_y", py_key: Py( 0x00007f9033523b40, ), path: LookupPath( [ S( "fov_y", Py( 0x00007f9033523b70, ), ), ], ), }, name_py: Py( 0x00007f9033e16400, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f9038148100, ), ), on_error: Raise, validator: Nullable( NullableValidator { validator: Float( FloatValidator { strict: false, allow_inf_nan: true, }, ), name: "nullable[float]", }, ), validate_default: false, copy_default: false, name: "default[nullable[float]]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, Field { name: "orientation", lookup_key: Simple { key: "orientation", py_key: Py( 0x00007f90333681f0, ), path: LookupPath( [ S( "orientation", Py( 0x00007f90333681b0, ), ), ], ), }, name_py: Py( 0x00007f9033c27ef0, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "w", lookup_key: Simple { key: "w", py_key: Py( 0x00007f903823f4f8, ), path: LookupPath( [ S( "w", Py( 0x00007f903823f4f8, ), ), ], ), }, name_py: Py( 0x00007f903823f4f8, ), validator: Float( FloatValidator { strict: false, allow_inf_nan: true, }, ), frozen: false, }, Field { name: "x", lookup_key: Simple { key: "x", py_key: Py( 0x00007f903823f528, ), path: LookupPath( [ S( "x", Py( 0x00007f903823f528, ), ), ], ), }, name_py: Py( 0x00007f903823de18, ), validator: Float( FloatValidator { strict: false, allow_inf_nan: true, }, ), frozen: false, }, Field { name: "y", lookup_key: Simple { key: "y", py_key: Py( 0x00007f903823f558, ), path: LookupPath( [ S( "y", Py( 0x00007f903823f558, ), ), ], ), }, name_py: Py( 0x00007f903823f558, ), validator: Float( FloatValidator { strict: false, allow_inf_nan: true, }, ), frozen: false, }, Field { name: "z", lookup_key: Simple { key: "z", py_key: Py( 0x00007f903823f588, ), path: LookupPath( [ S( "z", Py( 0x00007f903823f588, ), ), ], ), }, name_py: Py( 0x00007f903823f588, ), validator: Float( FloatValidator { strict: false, allow_inf_nan: true, }, ), frozen: false, }, ], model_name: "Point4d", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d1a8d30, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "Point4d", }, ), frozen: false, }, Field { name: "ortho", lookup_key: Simple { key: "ortho", py_key: Py( 0x00007f9033523ba0, ), path: LookupPath( [ S( "ortho", Py( 0x00007f9033523bd0, ), ), ], ), }, name_py: Py( 0x00007f9033e16550, ), validator: Bool( BoolValidator { strict: false, }, ), frozen: false, }, Field { name: "ortho_scale", lookup_key: Simple { key: "ortho_scale", py_key: Py( 0x00007f9033368270, ), path: LookupPath( [ S( "ortho_scale", Py( 0x00007f9033368230, ), ), ], ), }, name_py: Py( 0x00007f9033c27eb0, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f9038148100, ), ), on_error: Raise, validator: Nullable( NullableValidator { validator: Float( FloatValidator { strict: false, allow_inf_nan: true, }, ), name: "nullable[float]", }, ), validate_default: false, copy_default: false, name: "default[nullable[float]]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, Field { name: "pos", lookup_key: Simple { key: "pos", py_key: Py( 0x00007f9033523c00, ), path: LookupPath( [ S( "pos", Py( 0x00007f9033523c30, ), ), ], ), }, name_py: Py( 0x00007f903823c150, ), validator: DefinitionRef( DefinitionRefValidator { definition: "...", }, ), frozen: false, }, Field { name: "up", lookup_key: Simple { key: "up", py_key: Py( 0x00007f9033523c60, ), path: LookupPath( [ S( "up", Py( 0x00007f9033523c90, ), ), ], ), }, name_py: Py( 0x00007f9036ff7720, ), validator: DefinitionRef( DefinitionRefValidator { definition: "...", }, ), frozen: false, }, ], model_name: "CameraSettings", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d1a9d20, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "CameraSettings", }, ), frozen: false, }, ], model_name: "CameraDragMove", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d1b9c60, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "CameraDragMove", }, ), frozen: false, }, Field { name: "type", lookup_key: Simple { key: "type", py_key: Py( 0x00007f9033523d20, ), path: LookupPath( [ S( "type", Py( 0x00007f9033523d50, ), ), ], ), }, name_py: Py( 0x00007f903823d958, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f90347332f0, ), ), on_error: Raise, validator: Literal( LiteralValidator { lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "camera_drag_move": 0, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f90347332f0, ), ], }, expected_repr: "'camera_drag_move'", name: "literal['camera_drag_move']", }, ), validate_default: false, copy_default: false, name: "default[literal['camera_drag_move']]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "OptionCameraDragMove", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d9f58a0, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "OptionCameraDragMove", }, ), definitions=[Model(ModelValidator { revalidate: Never, validator: ModelFields(ModelFieldsValidator { fields: [Field { name: "x", lookup_key: Simple { key: "x", py_key: Py(0x7f903823f528), path: LookupPath([S("x", Py(0x7f903823f528))]) }, name_py: Py(0x7f903823de18), validator: Float(FloatValidator { strict: false, allow_inf_nan: true }), frozen: false }, Field { name: "y", lookup_key: Simple { key: "y", py_key: Py(0x7f903823f558), path: LookupPath([S("y", Py(0x7f903823f558))]) }, name_py: Py(0x7f903823f558), validator: Float(FloatValidator { strict: false, allow_inf_nan: true }), frozen: false }, Field { name: "z", lookup_key: Simple { key: "z", py_key: Py(0x7f903823f588), path: LookupPath([S("z", Py(0x7f903823f588))]) }, name_py: Py(0x7f903823f588), validator: Float(FloatValidator { strict: false, allow_inf_nan: true }), frozen: false }], model_name: "Point3d", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true }), class: Py(0x56196c7ee400), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py(0x7f903629a320), name: "Point3d" })], cache_strings=True)[source]: The pydantic-core SchemaValidator used to validate instances of the model.

__repr__()[source]

Return repr(self).

Return type:: str

__repr_args__()[source]

Return type:: Iterable[tuple[str | None, Any]]

__repr_name__()[source]

Name of the instance’s class, used in __repr__.

Return type:: str

__repr_str__(join_str)[source]

Return type:: str

__rich_repr__()[source]

Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.

Return type:: Iterable[Any | tuple[Any] | tuple[str, Any] | tuple[str, Any, Any]]

__setattr__(name, value)[source]

Implement setattr(self, name, value).

Return type:: None

__setstate__(state)[source]

Return type:: None

__signature__: ClassVar[Signature] = <Signature (*, data: kittycad.models.camera_drag_move.CameraDragMove, type: Literal['camera_drag_move'] = 'camera_drag_move') -> None>[source]: The synthesized __init__ [Signature][inspect.Signature] of the model.

__slots__ = ('__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__')[source]

__str__()[source]

Return str(self).

Return type:: str

_abc_impl = <_abc._abc_data object>[source]

_calculate_keys(*args, **kwargs)[source]

Return type:: Any

_check_frozen(name, value)[source]

Return type:: None

_copy_and_set_values(*args, **kwargs)[source]

Return type:: Any

classmethod _get_value(*args, **kwargs)[source]

Return type:: Any

_iter(*args, **kwargs)[source]

Return type:: Any

classmethod construct(_fields_set=None, **values)[source]

Return type:: Self

copy(*, include=None, exclude=None, update=None, deep=False)[source]

Returns a copy of the model.

!!! warning “Deprecated”: This method is now deprecated; use model_copy instead.

If you need include or exclude, use:

`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `

Parameters:

include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.

Returns:

A copy of the model with included, excluded and updated fields as specified.

data: CameraDragMove[source]

dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)[source]

Return type:: Dict[str, Any]

classmethod from_orm(obj)[source]

Return type:: Self

json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)[source]

Return type:: str

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}[source]: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'protected_namespaces': ()}[source]: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod model_construct(_fields_set=None, **values)[source]

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note: model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == 'allow', then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == 'ignore' (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == 'forbid' does not result in an error if extra values are passed, but they will be ignored.

Parameters:

_fields_set (set[str] | None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.
values (Any) – Trusted or pre-validated data dictionary.

Return type:

Self

Returns:

A new instance of the Model class with validated data.

model_copy(*, update=None, deep=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy

Returns a copy of the model.

Parameters:

update (dict[str, Any] | None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.
deep (bool) – Set to True to make a deep copy of the model.

Return type:

Self

Returns:

New model instance.

model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters:

mode (Union[Literal['json', 'python'], str]) – The mode in which to_python 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.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to include in the output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to exclude from the output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to use the field’s alias in the dictionary key if defined.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A dictionary representation of the model.

model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

Generates a JSON representation of the model using Pydantic’s to_json method.

Parameters:

indent (int | None) – Indentation to use in the JSON output. If None is passed, the output will be compact.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to include in the JSON output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to exclude from the JSON output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to serialize using field aliases.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A JSON string representation of the model.

property model_extra: dict[str, Any] | None[source]

Get extra fields set during validation.

Returns:: A dictionary of extra fields, or None if config.extra is not set to "allow".

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=CameraDragMove, required=True), 'type': FieldInfo(annotation=Literal['camera_drag_move'], required=False, default='camera_drag_move')}[source]

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

property model_fields_set: set[str][source]

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,: i.e. that were not filled from defaults.

classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')[source]

Generates a JSON schema for a model class.

Parameters:

by_alias (bool) – Whether to use attribute aliases or not.
ref_template (str) – The reference template.
schema_generator (type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modifications
mode (Literal['validation', 'serialization']) – The mode in which to generate the schema.

Return type:

Returns:

The JSON schema for the given model class.

classmethod model_parametrized_name(params)[source]

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

Parameters:: params (tuple[type[Any], ...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.
Return type:: str
Returns:: String representing the new class where params are passed to cls as type variables.
Raises:: TypeError – Raised when trying to generate concrete names for non-generic models.

model_post_init(_BaseModel__context)[source]

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

Return type:: None

classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)[source]

Try to rebuild the pydantic-core schema for the model.

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.

Parameters:

force (bool) – Whether to force the rebuilding of the model schema, defaults to False.
raise_errors (bool) – Whether to raise errors, defaults to True.
_parent_namespace_depth (int) – The depth level of the parent namespace, defaults to 2.
_types_namespace (dict[str, Any] | None) – The types namespace, defaults to None.

Return type:

Returns:

Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.

classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)[source]

Validate a pydantic model instance.

Parameters:

obj (Any) – The object to validate.
strict (bool | None) – Whether to enforce types strictly.
from_attributes (bool | None) – Whether to extract data from object attributes.
context (Any | None) – Additional context to pass to the validator.

Raises:

ValidationError – If the object could not be validated.

Return type:

Self

Returns:

The validated model instance.

classmethod model_validate_json(json_data, *, strict=None, context=None)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing

Validate the given JSON data against the Pydantic model.

Parameters:

json_data (str | bytes | bytearray) – The JSON data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

Raises:

ValidationError – If json_data is not a JSON string or the object could not be validated.

classmethod model_validate_strings(obj, *, strict=None, context=None)[source]

Validate the given object with string data against the Pydantic model.

Parameters:

obj (Any) – The object containing string data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod parse_obj(obj)[source]

Return type:: Self

classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod schema(by_alias=True, ref_template='#/$defs/{model}')[source]

Return type:: Dict[str, Any]

classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)[source]

Return type:: str

type: Literal['camera_drag_move'][source]

classmethod update_forward_refs(**localns)[source]

Return type:: None

classmethod validate(value)[source]

Return type:: Self

class kittycad.models.ok_modeling_cmd_response.OptionCameraDragStart(**data)[source][source]

The response to the ‘CameraDragStart’ endpoint

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__abstractmethods__ = frozenset({})[source]

__annotations__ = {'__class_vars__': 'ClassVar[set[str]]', '__private_attributes__': 'ClassVar[Dict[str, ModelPrivateAttr]]', '__pydantic_complete__': 'ClassVar[bool]', '__pydantic_core_schema__': 'ClassVar[CoreSchema]', '__pydantic_custom_init__': 'ClassVar[bool]', '__pydantic_decorators__': 'ClassVar[_decorators.DecoratorInfos]', '__pydantic_extra__': 'dict[str, Any] | None', '__pydantic_fields_set__': 'set[str]', '__pydantic_generic_metadata__': 'ClassVar[_generics.PydanticGenericMetadata]', '__pydantic_parent_namespace__': 'ClassVar[Dict[str, Any] | None]', '__pydantic_post_init__': "ClassVar[None | Literal['model_post_init']]", '__pydantic_private__': 'dict[str, Any] | None', '__pydantic_root_model__': 'ClassVar[bool]', '__pydantic_serializer__': 'ClassVar[SchemaSerializer]', '__pydantic_validator__': 'ClassVar[SchemaValidator | PluggableSchemaValidator]', '__signature__': 'ClassVar[Signature]', 'data': <class 'kittycad.models.camera_drag_start.CameraDragStart'>, 'model_computed_fields': 'ClassVar[Dict[str, ComputedFieldInfo]]', 'model_config': 'ClassVar[ConfigDict]', 'model_fields': 'ClassVar[Dict[str, FieldInfo]]', 'type': typing.Literal['camera_drag_start']}[source]

classmethod __class_getitem__(typevar_values)[source]

Return type:: type[BaseModel] | PydanticRecursiveRef

__class_vars__: ClassVar[set[str]] = {}[source]: The names of the class variables defined on the model.

__copy__()[source]

Returns a shallow copy of the model.

Return type:: Self

__deepcopy__(memo=None)[source]

Returns a deep copy of the model.

Return type:: Self

__delattr__(item)[source]

Implement delattr(self, name).

Return type:: Any

__dict__[source]

__eq__(other)[source]

Return self==value.

Return type:: bool

property __fields_set__: set[str][source]

classmethod __get_pydantic_core_schema__(source, handler, /)[source]

Hook into generating the model’s CoreSchema.

Parameters:

source (type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.
handler (GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.

Return type:

Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]

Returns:

A pydantic-core CoreSchema.

classmethod __get_pydantic_json_schema__(core_schema, handler, /)[source]

Hook into generating the model’s JSON schema.

Parameters:

core_schema (Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({'type': 'nullable', 'schema': current_schema}), or just call the handler with the original schema.
handler (GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.

Return type:

Returns:

A JSON schema, as a Python object.

__getattr__(item)[source]

Return type:: Any

__getstate__()[source]

Helper for pickle.

Return type:: dict[Any, Any]

__hash__ = None[source]

__init__(**data)[source]

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__iter__()[source]

So dict(model) works.

Return type:: Generator[Tuple[str, Any], None, None]

__module__ = 'kittycad.models.ok_modeling_cmd_response'[source]

__pretty__(fmt, **kwargs)[source]

Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.

Return type:: Generator[Any, None, None]

__private_attributes__: ClassVar[Dict[str, ModelPrivateAttr]] = {}[source]: Metadata about the private attributes of the model.

__pydantic_complete__: ClassVar[bool] = True[source]: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__: ClassVar[CoreSchema] = {'cls': <class 'kittycad.models.ok_modeling_cmd_response.OptionCameraDragStart'>, 'config': {'title': 'OptionCameraDragStart'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.ok_modeling_cmd_response.OptionCameraDragStart'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.ok_modeling_cmd_response.OptionCameraDragStart'>>]}, 'ref': 'kittycad.models.ok_modeling_cmd_response.OptionCameraDragStart:94667212766064', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'data': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.camera_drag_start.CameraDragStart'>, 'config': {'title': 'CameraDragStart'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.camera_drag_start.CameraDragStart'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.camera_drag_start.CameraDragStart'>>]}, 'ref': 'kittycad.models.camera_drag_start.CameraDragStart:94667191628768', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {}, 'model_name': 'CameraDragStart', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}, 'type': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': 'camera_drag_start', 'schema': {'expected': ['camera_drag_start'], 'type': 'literal'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'OptionCameraDragStart', 'type': 'model-fields'}, 'type': 'model'}[source]: The core schema of the model.

__pydantic_custom_init__: ClassVar[bool] = False[source]: Whether the model has a custom __init__ method.

__pydantic_decorators__: ClassVar[_decorators.DecoratorInfos] = DecoratorInfos(validators={}, field_validators={}, root_validators={}, field_serializers={}, model_serializers={}, model_validators={}, computed_fields={})[source]: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_extra__: dict[str, Any] | None[source]: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to 'allow'.

__pydantic_fields_set__: set[str][source]: The names of fields explicitly set during instantiation.

__pydantic_generic_metadata__: ClassVar[_generics.PydanticGenericMetadata] = {'args': (), 'origin': None, 'parameters': ()}[source]: 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.

classmethod __pydantic_init_subclass__(**kwargs)[source]

This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.

This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.

This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.

Parameters:: **kwargs (Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.
Return type:: None

__pydantic_parent_namespace__: ClassVar[Dict[str, Any] | None] = None[source]: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__: ClassVar[None | Literal['model_post_init']] = None[source]: The name of the post-init method for the model, if defined.

__pydantic_private__: dict[str, Any] | None[source]: Values of private attributes set on the model instance.

__pydantic_root_model__: ClassVar[bool] = False[source]: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__: ClassVar[SchemaSerializer] = SchemaSerializer(serializer=Model( ModelSerializer { class: Py( 0x000056196d96bb70, ), serializer: Fields( GeneralFieldsSerializer { fields: { "type": SerField { key_py: Py( 0x00007f903823d958, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f9034733270, ), ), serializer: Literal( LiteralSerializer { expected_int: {}, expected_str: { "camera_drag_start", }, expected_py: None, name: "literal['camera_drag_start']", }, ), }, ), ), required: true, }, "data": SerField { key_py: Py( 0x00007f9038238fa0, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196c5433e0, ), serializer: Fields( GeneralFieldsSerializer { fields: {}, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 0, }, ), has_extra: false, root_model: false, name: "CameraDragStart", }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "OptionCameraDragStart", }, ), definitions=[])[source]: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__: ClassVar[SchemaValidator | PluggableSchemaValidator] = SchemaValidator(title="OptionCameraDragStart", validator=Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "data", lookup_key: Simple { key: "data", py_key: Py( 0x00007f90336072a0, ), path: LookupPath( [ S( "data", Py( 0x00007f90336072d0, ), ), ], ), }, name_py: Py( 0x00007f9038238fa0, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [], model_name: "CameraDragStart", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196c5433e0, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "CameraDragStart", }, ), frozen: false, }, Field { name: "type", lookup_key: Simple { key: "type", py_key: Py( 0x00007f9033607300, ), path: LookupPath( [ S( "type", Py( 0x00007f9033607330, ), ), ], ), }, name_py: Py( 0x00007f903823d958, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f9034733270, ), ), on_error: Raise, validator: Literal( LiteralValidator { lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "camera_drag_start": 0, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f9034733270, ), ], }, expected_repr: "'camera_drag_start'", name: "literal['camera_drag_start']", }, ), validate_default: false, copy_default: false, name: "default[literal['camera_drag_start']]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "OptionCameraDragStart", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d96bb70, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "OptionCameraDragStart", }, ), definitions=[], cache_strings=True)[source]: The pydantic-core SchemaValidator used to validate instances of the model.

__repr__()[source]

Return repr(self).

Return type:: str

__repr_args__()[source]

Return type:: Iterable[tuple[str | None, Any]]

__repr_name__()[source]

Name of the instance’s class, used in __repr__.

Return type:: str

__repr_str__(join_str)[source]

Return type:: str

__rich_repr__()[source]

Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.

Return type:: Iterable[Any | tuple[Any] | tuple[str, Any] | tuple[str, Any, Any]]

__setattr__(name, value)[source]

Implement setattr(self, name, value).

Return type:: None

__setstate__(state)[source]

Return type:: None

__signature__: ClassVar[Signature] = <Signature (*, data: kittycad.models.camera_drag_start.CameraDragStart, type: Literal['camera_drag_start'] = 'camera_drag_start') -> None>[source]: The synthesized __init__ [Signature][inspect.Signature] of the model.

__slots__ = ('__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__')[source]

__str__()[source]

Return str(self).

Return type:: str

_abc_impl = <_abc._abc_data object>[source]

_calculate_keys(*args, **kwargs)[source]

Return type:: Any

_check_frozen(name, value)[source]

Return type:: None

_copy_and_set_values(*args, **kwargs)[source]

Return type:: Any

classmethod _get_value(*args, **kwargs)[source]

Return type:: Any

_iter(*args, **kwargs)[source]

Return type:: Any

classmethod construct(_fields_set=None, **values)[source]

Return type:: Self

copy(*, include=None, exclude=None, update=None, deep=False)[source]

Returns a copy of the model.

!!! warning “Deprecated”: This method is now deprecated; use model_copy instead.

If you need include or exclude, use:

`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `

Parameters:

include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.

Returns:

A copy of the model with included, excluded and updated fields as specified.

data: CameraDragStart[source]

dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)[source]

Return type:: Dict[str, Any]

classmethod from_orm(obj)[source]

Return type:: Self

json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)[source]

Return type:: str

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}[source]: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'protected_namespaces': ()}[source]: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod model_construct(_fields_set=None, **values)[source]

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note: model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == 'allow', then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == 'ignore' (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == 'forbid' does not result in an error if extra values are passed, but they will be ignored.

Parameters:

_fields_set (set[str] | None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.
values (Any) – Trusted or pre-validated data dictionary.

Return type:

Self

Returns:

A new instance of the Model class with validated data.

model_copy(*, update=None, deep=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy

Returns a copy of the model.

Parameters:

update (dict[str, Any] | None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.
deep (bool) – Set to True to make a deep copy of the model.

Return type:

Self

Returns:

New model instance.

model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters:

mode (Union[Literal['json', 'python'], str]) – The mode in which to_python 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.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to include in the output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to exclude from the output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to use the field’s alias in the dictionary key if defined.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A dictionary representation of the model.

model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

Generates a JSON representation of the model using Pydantic’s to_json method.

Parameters:

indent (int | None) – Indentation to use in the JSON output. If None is passed, the output will be compact.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to include in the JSON output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to exclude from the JSON output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to serialize using field aliases.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A JSON string representation of the model.

property model_extra: dict[str, Any] | None[source]

Get extra fields set during validation.

Returns:: A dictionary of extra fields, or None if config.extra is not set to "allow".

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=CameraDragStart, required=True), 'type': FieldInfo(annotation=Literal['camera_drag_start'], required=False, default='camera_drag_start')}[source]

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

property model_fields_set: set[str][source]

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,: i.e. that were not filled from defaults.

classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')[source]

Generates a JSON schema for a model class.

Parameters:

by_alias (bool) – Whether to use attribute aliases or not.
ref_template (str) – The reference template.
schema_generator (type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modifications
mode (Literal['validation', 'serialization']) – The mode in which to generate the schema.

Return type:

Returns:

The JSON schema for the given model class.

classmethod model_parametrized_name(params)[source]

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

Parameters:: params (tuple[type[Any], ...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.
Return type:: str
Returns:: String representing the new class where params are passed to cls as type variables.
Raises:: TypeError – Raised when trying to generate concrete names for non-generic models.

model_post_init(_BaseModel__context)[source]

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

Return type:: None

classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)[source]

Try to rebuild the pydantic-core schema for the model.

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.

Parameters:

force (bool) – Whether to force the rebuilding of the model schema, defaults to False.
raise_errors (bool) – Whether to raise errors, defaults to True.
_parent_namespace_depth (int) – The depth level of the parent namespace, defaults to 2.
_types_namespace (dict[str, Any] | None) – The types namespace, defaults to None.

Return type:

Returns:

Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.

classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)[source]

Validate a pydantic model instance.

Parameters:

obj (Any) – The object to validate.
strict (bool | None) – Whether to enforce types strictly.
from_attributes (bool | None) – Whether to extract data from object attributes.
context (Any | None) – Additional context to pass to the validator.

Raises:

ValidationError – If the object could not be validated.

Return type:

Self

Returns:

The validated model instance.

classmethod model_validate_json(json_data, *, strict=None, context=None)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing

Validate the given JSON data against the Pydantic model.

Parameters:

json_data (str | bytes | bytearray) – The JSON data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

Raises:

ValidationError – If json_data is not a JSON string or the object could not be validated.

classmethod model_validate_strings(obj, *, strict=None, context=None)[source]

Validate the given object with string data against the Pydantic model.

Parameters:

obj (Any) – The object containing string data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod parse_obj(obj)[source]

Return type:: Self

classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod schema(by_alias=True, ref_template='#/$defs/{model}')[source]

Return type:: Dict[str, Any]

classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)[source]

Return type:: str

type: Literal['camera_drag_start'][source]

classmethod update_forward_refs(**localns)[source]

Return type:: None

classmethod validate(value)[source]

Return type:: Self

class kittycad.models.ok_modeling_cmd_response.OptionCenterOfMass(**data)[source][source]

The response to the ‘CenterOfMass’ endpoint

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__abstractmethods__ = frozenset({})[source]

__annotations__ = {'__class_vars__': 'ClassVar[set[str]]', '__private_attributes__': 'ClassVar[Dict[str, ModelPrivateAttr]]', '__pydantic_complete__': 'ClassVar[bool]', '__pydantic_core_schema__': 'ClassVar[CoreSchema]', '__pydantic_custom_init__': 'ClassVar[bool]', '__pydantic_decorators__': 'ClassVar[_decorators.DecoratorInfos]', '__pydantic_extra__': 'dict[str, Any] | None', '__pydantic_fields_set__': 'set[str]', '__pydantic_generic_metadata__': 'ClassVar[_generics.PydanticGenericMetadata]', '__pydantic_parent_namespace__': 'ClassVar[Dict[str, Any] | None]', '__pydantic_post_init__': "ClassVar[None | Literal['model_post_init']]", '__pydantic_private__': 'dict[str, Any] | None', '__pydantic_root_model__': 'ClassVar[bool]', '__pydantic_serializer__': 'ClassVar[SchemaSerializer]', '__pydantic_validator__': 'ClassVar[SchemaValidator | PluggableSchemaValidator]', '__signature__': 'ClassVar[Signature]', 'data': <class 'kittycad.models.center_of_mass.CenterOfMass'>, 'model_computed_fields': 'ClassVar[Dict[str, ComputedFieldInfo]]', 'model_config': 'ClassVar[ConfigDict]', 'model_fields': 'ClassVar[Dict[str, FieldInfo]]', 'type': typing.Literal['center_of_mass']}[source]

classmethod __class_getitem__(typevar_values)[source]

Return type:: type[BaseModel] | PydanticRecursiveRef

__class_vars__: ClassVar[set[str]] = {}[source]: The names of the class variables defined on the model.

__copy__()[source]

Returns a shallow copy of the model.

Return type:: Self

__deepcopy__(memo=None)[source]

Returns a deep copy of the model.

Return type:: Self

__delattr__(item)[source]

Implement delattr(self, name).

Return type:: Any

__dict__[source]

__eq__(other)[source]

Return self==value.

Return type:: bool

property __fields_set__: set[str][source]

classmethod __get_pydantic_core_schema__(source, handler, /)[source]

Hook into generating the model’s CoreSchema.

Parameters:

source (type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.
handler (GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.

Return type:

Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]

Returns:

A pydantic-core CoreSchema.

classmethod __get_pydantic_json_schema__(core_schema, handler, /)[source]

Hook into generating the model’s JSON schema.

Parameters:

core_schema (Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({'type': 'nullable', 'schema': current_schema}), or just call the handler with the original schema.
handler (GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.

Return type:

Returns:

A JSON schema, as a Python object.

__getattr__(item)[source]

Return type:: Any

__getstate__()[source]

Helper for pickle.

Return type:: dict[Any, Any]

__hash__ = None[source]

__init__(**data)[source]

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__iter__()[source]

So dict(model) works.

Return type:: Generator[Tuple[str, Any], None, None]

__module__ = 'kittycad.models.ok_modeling_cmd_response'[source]

__pretty__(fmt, **kwargs)[source]

Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.

Return type:: Generator[Any, None, None]

__private_attributes__: ClassVar[Dict[str, ModelPrivateAttr]] = {}[source]: Metadata about the private attributes of the model.

__pydantic_complete__: ClassVar[bool] = True[source]: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__: ClassVar[CoreSchema] = {'cls': <class 'kittycad.models.ok_modeling_cmd_response.OptionCenterOfMass'>, 'config': {'title': 'OptionCenterOfMass'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.ok_modeling_cmd_response.OptionCenterOfMass'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.ok_modeling_cmd_response.OptionCenterOfMass'>>]}, 'ref': 'kittycad.models.ok_modeling_cmd_response.OptionCenterOfMass:94667213998032', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'data': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.center_of_mass.CenterOfMass'>, 'config': {'title': 'CenterOfMass'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.center_of_mass.CenterOfMass'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.center_of_mass.CenterOfMass'>>]}, 'ref': 'kittycad.models.center_of_mass.CenterOfMass:94667191683472', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'center_of_mass': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.point3d.Point3d'>, 'config': {'title': 'Point3d'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.point3d.Point3d'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.point3d.Point3d'>>]}, 'ref': 'kittycad.models.point3d.Point3d:94667194426368', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'x': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'type': 'float'}, 'type': 'model-field'}, 'y': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'type': 'float'}, 'type': 'model-field'}, 'z': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'type': 'float'}, 'type': 'model-field'}}, 'model_name': 'Point3d', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}, 'output_unit': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <enum 'UnitLength'>, 'members': [UnitLength.CM, UnitLength.FT, UnitLength.IN, UnitLength.M, UnitLength.MM, UnitLength.YD], 'metadata': {'pydantic_js_functions': [<function GenerateSchema._enum_schema.<locals>.get_json_schema>]}, 'ref': 'kittycad.models.unit_length.UnitLength:94667205163264', 'sub_type': 'str', 'type': 'enum'}, 'type': 'model-field'}}, 'model_name': 'CenterOfMass', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}, 'type': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': 'center_of_mass', 'schema': {'expected': ['center_of_mass'], 'type': 'literal'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'OptionCenterOfMass', 'type': 'model-fields'}, 'type': 'model'}[source]: The core schema of the model.

__pydantic_custom_init__: ClassVar[bool] = False[source]: Whether the model has a custom __init__ method.

__pydantic_decorators__: ClassVar[_decorators.DecoratorInfos] = DecoratorInfos(validators={}, field_validators={}, root_validators={}, field_serializers={}, model_serializers={}, model_validators={}, computed_fields={})[source]: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_extra__: dict[str, Any] | None[source]: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to 'allow'.

__pydantic_fields_set__: set[str][source]: The names of fields explicitly set during instantiation.

__pydantic_generic_metadata__: ClassVar[_generics.PydanticGenericMetadata] = {'args': (), 'origin': None, 'parameters': ()}[source]: 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.

classmethod __pydantic_init_subclass__(**kwargs)[source]

This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.

This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.

This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.

Parameters:: **kwargs (Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.
Return type:: None

__pydantic_parent_namespace__: ClassVar[Dict[str, Any] | None] = None[source]: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__: ClassVar[None | Literal['model_post_init']] = None[source]: The name of the post-init method for the model, if defined.

__pydantic_private__: dict[str, Any] | None[source]: Values of private attributes set on the model instance.

__pydantic_root_model__: ClassVar[bool] = False[source]: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__: ClassVar[SchemaSerializer] = SchemaSerializer(serializer=Model( ModelSerializer { class: Py( 0x000056196da987d0, ), serializer: Fields( GeneralFieldsSerializer { fields: { "type": SerField { key_py: Py( 0x00007f903823d958, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f9034730030, ), ), serializer: Literal( LiteralSerializer { expected_int: {}, expected_str: { "center_of_mass", }, expected_py: None, name: "literal['center_of_mass']", }, ), }, ), ), required: true, }, "data": SerField { key_py: Py( 0x00007f9038238fa0, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196c550990, ), serializer: Fields( GeneralFieldsSerializer { fields: { "output_unit": SerField { key_py: Py( 0x00007f903459f8b0, ), alias: None, alias_py: None, serializer: Some( Enum( EnumSerializer { class: Py( 0x000056196d22b900, ), serializer: Some( Str( StrSerializer, ), ), }, ), ), required: true, }, "center_of_mass": SerField { key_py: Py( 0x00007f9034730030, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196c7ee400, ), serializer: Fields( GeneralFieldsSerializer { fields: { "z": SerField { key_py: Py( 0x00007f903823f588, ), alias: None, alias_py: None, serializer: Some( Float( FloatSerializer { inf_nan_mode: Null, }, ), ), required: true, }, "y": SerField { key_py: Py( 0x00007f903823f558, ), alias: None, alias_py: None, serializer: Some( Float( FloatSerializer { inf_nan_mode: Null, }, ), ), required: true, }, "x": SerField { key_py: Py( 0x00007f903823de18, ), alias: None, alias_py: None, serializer: Some( Float( FloatSerializer { inf_nan_mode: Null, }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 3, }, ), has_extra: false, root_model: false, name: "Point3d", }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "CenterOfMass", }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "OptionCenterOfMass", }, ), definitions=[])[source]: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__: ClassVar[SchemaValidator | PluggableSchemaValidator] = SchemaValidator(title="OptionCenterOfMass", validator=Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "data", lookup_key: Simple { key: "data", py_key: Py( 0x00007f9033523e70, ), path: LookupPath( [ S( "data", Py( 0x00007f9033523e10, ), ), ], ), }, name_py: Py( 0x00007f9038238fa0, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "center_of_mass", lookup_key: Simple { key: "center_of_mass", py_key: Py( 0x00007f903335e070, ), path: LookupPath( [ S( "center_of_mass", Py( 0x00007f90334b3070, ), ), ], ), }, name_py: Py( 0x00007f9034730030, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "x", lookup_key: Simple { key: "x", py_key: Py( 0x00007f903823f528, ), path: LookupPath( [ S( "x", Py( 0x00007f903823f528, ), ), ], ), }, name_py: Py( 0x00007f903823de18, ), validator: Float( FloatValidator { strict: false, allow_inf_nan: true, }, ), frozen: false, }, Field { name: "y", lookup_key: Simple { key: "y", py_key: Py( 0x00007f903823f558, ), path: LookupPath( [ S( "y", Py( 0x00007f903823f558, ), ), ], ), }, name_py: Py( 0x00007f903823f558, ), validator: Float( FloatValidator { strict: false, allow_inf_nan: true, }, ), frozen: false, }, Field { name: "z", lookup_key: Simple { key: "z", py_key: Py( 0x00007f903823f588, ), path: LookupPath( [ S( "z", Py( 0x00007f903823f588, ), ), ], ), }, name_py: Py( 0x00007f903823f588, ), validator: Float( FloatValidator { strict: false, allow_inf_nan: true, }, ), frozen: false, }, ], model_name: "Point3d", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196c7ee400, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "Point3d", }, ), frozen: false, }, Field { name: "output_unit", lookup_key: Simple { key: "output_unit", py_key: Py( 0x00007f90333af0b0, ), path: LookupPath( [ S( "output_unit", Py( 0x00007f90333b4ef0, ), ), ], ), }, name_py: Py( 0x00007f903459f8b0, ), validator: StrEnum( EnumValidator { phantom: PhantomData<_pydantic_core::validators::enum_::StrEnumValidator>, class: Py( 0x000056196d22b900, ), lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "yd": 5, "m": 3, "in": 2, "ft": 1, "mm": 4, "cm": 0, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f9033ca8890, ), Py( 0x00007f9033ca8e30, ), Py( 0x00007f9033ca8ef0, ), Py( 0x00007f9033ca8f50, ), Py( 0x00007f9033ca8fb0, ), Py( 0x00007f9033ca9010, ), ], }, missing: None, expected_repr: "'cm', 'ft', 'in', 'm', 'mm' or 'yd'", strict: false, class_repr: "UnitLength", name: "str-enum[UnitLength]", }, ), frozen: false, }, ], model_name: "CenterOfMass", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196c550990, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "CenterOfMass", }, ), frozen: false, }, Field { name: "type", lookup_key: Simple { key: "type", py_key: Py( 0x00007f9033523f30, ), path: LookupPath( [ S( "type", Py( 0x00007f9033523ed0, ), ), ], ), }, name_py: Py( 0x00007f903823d958, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f9034730030, ), ), on_error: Raise, validator: Literal( LiteralValidator { lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "center_of_mass": 0, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f9034730030, ), ], }, expected_repr: "'center_of_mass'", name: "literal['center_of_mass']", }, ), validate_default: false, copy_default: false, name: "default[literal['center_of_mass']]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "OptionCenterOfMass", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196da987d0, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "OptionCenterOfMass", }, ), definitions=[], cache_strings=True)[source]: The pydantic-core SchemaValidator used to validate instances of the model.

__repr__()[source]

Return repr(self).

Return type:: str

__repr_args__()[source]

Return type:: Iterable[tuple[str | None, Any]]

__repr_name__()[source]

Name of the instance’s class, used in __repr__.

Return type:: str

__repr_str__(join_str)[source]

Return type:: str

__rich_repr__()[source]

Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.

Return type:: Iterable[Any | tuple[Any] | tuple[str, Any] | tuple[str, Any, Any]]

__setattr__(name, value)[source]

Implement setattr(self, name, value).

Return type:: None

__setstate__(state)[source]

Return type:: None

__signature__: ClassVar[Signature] = <Signature (*, data: kittycad.models.center_of_mass.CenterOfMass, type: Literal['center_of_mass'] = 'center_of_mass') -> None>[source]: The synthesized __init__ [Signature][inspect.Signature] of the model.

__slots__ = ('__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__')[source]

__str__()[source]

Return str(self).

Return type:: str

_abc_impl = <_abc._abc_data object>[source]

_calculate_keys(*args, **kwargs)[source]

Return type:: Any

_check_frozen(name, value)[source]

Return type:: None

_copy_and_set_values(*args, **kwargs)[source]

Return type:: Any

classmethod _get_value(*args, **kwargs)[source]

Return type:: Any

_iter(*args, **kwargs)[source]

Return type:: Any

classmethod construct(_fields_set=None, **values)[source]

Return type:: Self

copy(*, include=None, exclude=None, update=None, deep=False)[source]

Returns a copy of the model.

!!! warning “Deprecated”: This method is now deprecated; use model_copy instead.

If you need include or exclude, use:

`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `

Parameters:

include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.

Returns:

A copy of the model with included, excluded and updated fields as specified.

data: CenterOfMass[source]

dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)[source]

Return type:: Dict[str, Any]

classmethod from_orm(obj)[source]

Return type:: Self

json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)[source]

Return type:: str

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}[source]: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'protected_namespaces': ()}[source]: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod model_construct(_fields_set=None, **values)[source]

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note: model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == 'allow', then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == 'ignore' (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == 'forbid' does not result in an error if extra values are passed, but they will be ignored.

Parameters:

_fields_set (set[str] | None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.
values (Any) – Trusted or pre-validated data dictionary.

Return type:

Self

Returns:

A new instance of the Model class with validated data.

model_copy(*, update=None, deep=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy

Returns a copy of the model.

Parameters:

update (dict[str, Any] | None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.
deep (bool) – Set to True to make a deep copy of the model.

Return type:

Self

Returns:

New model instance.

model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters:

mode (Union[Literal['json', 'python'], str]) – The mode in which to_python 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.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to include in the output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to exclude from the output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to use the field’s alias in the dictionary key if defined.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A dictionary representation of the model.

model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

Generates a JSON representation of the model using Pydantic’s to_json method.

Parameters:

indent (int | None) – Indentation to use in the JSON output. If None is passed, the output will be compact.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to include in the JSON output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to exclude from the JSON output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to serialize using field aliases.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A JSON string representation of the model.

property model_extra: dict[str, Any] | None[source]

Get extra fields set during validation.

Returns:: A dictionary of extra fields, or None if config.extra is not set to "allow".

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=CenterOfMass, required=True), 'type': FieldInfo(annotation=Literal['center_of_mass'], required=False, default='center_of_mass')}[source]

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

property model_fields_set: set[str][source]

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,: i.e. that were not filled from defaults.

classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')[source]

Generates a JSON schema for a model class.

Parameters:

by_alias (bool) – Whether to use attribute aliases or not.
ref_template (str) – The reference template.
schema_generator (type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modifications
mode (Literal['validation', 'serialization']) – The mode in which to generate the schema.

Return type:

Returns:

The JSON schema for the given model class.

classmethod model_parametrized_name(params)[source]

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

Parameters:: params (tuple[type[Any], ...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.
Return type:: str
Returns:: String representing the new class where params are passed to cls as type variables.
Raises:: TypeError – Raised when trying to generate concrete names for non-generic models.

model_post_init(_BaseModel__context)[source]

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

Return type:: None

classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)[source]

Try to rebuild the pydantic-core schema for the model.

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.

Parameters:

force (bool) – Whether to force the rebuilding of the model schema, defaults to False.
raise_errors (bool) – Whether to raise errors, defaults to True.
_parent_namespace_depth (int) – The depth level of the parent namespace, defaults to 2.
_types_namespace (dict[str, Any] | None) – The types namespace, defaults to None.

Return type:

Returns:

Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.

classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)[source]

Validate a pydantic model instance.

Parameters:

obj (Any) – The object to validate.
strict (bool | None) – Whether to enforce types strictly.
from_attributes (bool | None) – Whether to extract data from object attributes.
context (Any | None) – Additional context to pass to the validator.

Raises:

ValidationError – If the object could not be validated.

Return type:

Self

Returns:

The validated model instance.

classmethod model_validate_json(json_data, *, strict=None, context=None)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing

Validate the given JSON data against the Pydantic model.

Parameters:

json_data (str | bytes | bytearray) – The JSON data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

Raises:

ValidationError – If json_data is not a JSON string or the object could not be validated.

classmethod model_validate_strings(obj, *, strict=None, context=None)[source]

Validate the given object with string data against the Pydantic model.

Parameters:

obj (Any) – The object containing string data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod parse_obj(obj)[source]

Return type:: Self

classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod schema(by_alias=True, ref_template='#/$defs/{model}')[source]

Return type:: Dict[str, Any]

classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)[source]

Return type:: str

type: Literal['center_of_mass'][source]

classmethod update_forward_refs(**localns)[source]

Return type:: None

classmethod validate(value)[source]

Return type:: Self

class kittycad.models.ok_modeling_cmd_response.OptionClosePath(**data)[source][source]

The response to the ‘ClosePath’ endpoint

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__abstractmethods__ = frozenset({})[source]

__annotations__ = {'__class_vars__': 'ClassVar[set[str]]', '__private_attributes__': 'ClassVar[Dict[str, ModelPrivateAttr]]', '__pydantic_complete__': 'ClassVar[bool]', '__pydantic_core_schema__': 'ClassVar[CoreSchema]', '__pydantic_custom_init__': 'ClassVar[bool]', '__pydantic_decorators__': 'ClassVar[_decorators.DecoratorInfos]', '__pydantic_extra__': 'dict[str, Any] | None', '__pydantic_fields_set__': 'set[str]', '__pydantic_generic_metadata__': 'ClassVar[_generics.PydanticGenericMetadata]', '__pydantic_parent_namespace__': 'ClassVar[Dict[str, Any] | None]', '__pydantic_post_init__': "ClassVar[None | Literal['model_post_init']]", '__pydantic_private__': 'dict[str, Any] | None', '__pydantic_root_model__': 'ClassVar[bool]', '__pydantic_serializer__': 'ClassVar[SchemaSerializer]', '__pydantic_validator__': 'ClassVar[SchemaValidator | PluggableSchemaValidator]', '__signature__': 'ClassVar[Signature]', 'data': <class 'kittycad.models.close_path.ClosePath'>, 'model_computed_fields': 'ClassVar[Dict[str, ComputedFieldInfo]]', 'model_config': 'ClassVar[ConfigDict]', 'model_fields': 'ClassVar[Dict[str, FieldInfo]]', 'type': typing.Literal['close_path']}[source]

classmethod __class_getitem__(typevar_values)[source]

Return type:: type[BaseModel] | PydanticRecursiveRef

__class_vars__: ClassVar[set[str]] = {}[source]: The names of the class variables defined on the model.

__copy__()[source]

Returns a shallow copy of the model.

Return type:: Self

__deepcopy__(memo=None)[source]

Returns a deep copy of the model.

Return type:: Self

__delattr__(item)[source]

Implement delattr(self, name).

Return type:: Any

__dict__[source]

__eq__(other)[source]

Return self==value.

Return type:: bool

property __fields_set__: set[str][source]

classmethod __get_pydantic_core_schema__(source, handler, /)[source]

Hook into generating the model’s CoreSchema.

Parameters:

source (type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.
handler (GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.

Return type:

Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]

Returns:

A pydantic-core CoreSchema.

classmethod __get_pydantic_json_schema__(core_schema, handler, /)[source]

Hook into generating the model’s JSON schema.

Parameters:

core_schema (Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({'type': 'nullable', 'schema': current_schema}), or just call the handler with the original schema.
handler (GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.

Return type:

Returns:

A JSON schema, as a Python object.

__getattr__(item)[source]

Return type:: Any

__getstate__()[source]

Helper for pickle.

Return type:: dict[Any, Any]

__hash__ = None[source]

__init__(**data)[source]

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__iter__()[source]

So dict(model) works.

Return type:: Generator[Tuple[str, Any], None, None]

__module__ = 'kittycad.models.ok_modeling_cmd_response'[source]

__pretty__(fmt, **kwargs)[source]

Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.

Return type:: Generator[Any, None, None]

__private_attributes__: ClassVar[Dict[str, ModelPrivateAttr]] = {}[source]: Metadata about the private attributes of the model.

__pydantic_complete__: ClassVar[bool] = True[source]: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__: ClassVar[CoreSchema] = {'cls': <class 'kittycad.models.ok_modeling_cmd_response.OptionClosePath'>, 'config': {'title': 'OptionClosePath'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.ok_modeling_cmd_response.OptionClosePath'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.ok_modeling_cmd_response.OptionClosePath'>>]}, 'ref': 'kittycad.models.ok_modeling_cmd_response.OptionClosePath:94667213319024', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'data': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.close_path.ClosePath'>, 'config': {'title': 'ClosePath'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.close_path.ClosePath'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.close_path.ClosePath'>>]}, 'ref': 'kittycad.models.close_path.ClosePath:94667191699264', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'face_id': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'type': 'str'}, 'type': 'model-field'}}, 'model_name': 'ClosePath', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}, 'type': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': 'close_path', 'schema': {'expected': ['close_path'], 'type': 'literal'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'OptionClosePath', 'type': 'model-fields'}, 'type': 'model'}[source]: The core schema of the model.

__pydantic_custom_init__: ClassVar[bool] = False[source]: Whether the model has a custom __init__ method.

__pydantic_decorators__: ClassVar[_decorators.DecoratorInfos] = DecoratorInfos(validators={}, field_validators={}, root_validators={}, field_serializers={}, model_serializers={}, model_validators={}, computed_fields={})[source]: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_extra__: dict[str, Any] | None[source]: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to 'allow'.

__pydantic_fields_set__: set[str][source]: The names of fields explicitly set during instantiation.

__pydantic_generic_metadata__: ClassVar[_generics.PydanticGenericMetadata] = {'args': (), 'origin': None, 'parameters': ()}[source]: 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.

classmethod __pydantic_init_subclass__(**kwargs)[source]

This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.

This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.

This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.

Parameters:: **kwargs (Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.
Return type:: None

__pydantic_parent_namespace__: ClassVar[Dict[str, Any] | None] = None[source]: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__: ClassVar[None | Literal['model_post_init']] = None[source]: The name of the post-init method for the model, if defined.

__pydantic_private__: dict[str, Any] | None[source]: Values of private attributes set on the model instance.

__pydantic_root_model__: ClassVar[bool] = False[source]: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__: ClassVar[SchemaSerializer] = SchemaSerializer(serializer=Model( ModelSerializer { class: Py( 0x000056196d9f2b70, ), serializer: Fields( GeneralFieldsSerializer { fields: { "type": SerField { key_py: Py( 0x00007f903823d958, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f9034733fb0, ), ), serializer: Literal( LiteralSerializer { expected_int: {}, expected_str: { "close_path", }, expected_py: None, name: "literal['close_path']", }, ), }, ), ), required: true, }, "data": SerField { key_py: Py( 0x00007f9038238fa0, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196c554740, ), serializer: Fields( GeneralFieldsSerializer { fields: { "face_id": SerField { key_py: Py( 0x00007f9033e20420, ), alias: None, alias_py: None, serializer: Some( Str( StrSerializer, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 1, }, ), has_extra: false, root_model: false, name: "ClosePath", }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "OptionClosePath", }, ), definitions=[])[source]: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__: ClassVar[SchemaValidator | PluggableSchemaValidator] = SchemaValidator(title="OptionClosePath", validator=Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "data", lookup_key: Simple { key: "data", py_key: Py( 0x00007f90335235d0, ), path: LookupPath( [ S( "data", Py( 0x00007f9033523600, ), ), ], ), }, name_py: Py( 0x00007f9038238fa0, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "face_id", lookup_key: Simple { key: "face_id", py_key: Py( 0x00007f90335234e0, ), path: LookupPath( [ S( "face_id", Py( 0x00007f90335235a0, ), ), ], ), }, name_py: Py( 0x00007f9033e20420, ), validator: Str( StrValidator { strict: false, coerce_numbers_to_str: false, }, ), frozen: false, }, ], model_name: "ClosePath", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196c554740, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "ClosePath", }, ), frozen: false, }, Field { name: "type", lookup_key: Simple { key: "type", py_key: Py( 0x00007f9033523630, ), path: LookupPath( [ S( "type", Py( 0x00007f9033523660, ), ), ], ), }, name_py: Py( 0x00007f903823d958, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f9034733fb0, ), ), on_error: Raise, validator: Literal( LiteralValidator { lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "close_path": 0, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f9034733fb0, ), ], }, expected_repr: "'close_path'", name: "literal['close_path']", }, ), validate_default: false, copy_default: false, name: "default[literal['close_path']]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "OptionClosePath", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d9f2b70, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "OptionClosePath", }, ), definitions=[], cache_strings=True)[source]: The pydantic-core SchemaValidator used to validate instances of the model.

__repr__()[source]

Return repr(self).

Return type:: str

__repr_args__()[source]

Return type:: Iterable[tuple[str | None, Any]]

__repr_name__()[source]

Name of the instance’s class, used in __repr__.

Return type:: str

__repr_str__(join_str)[source]

Return type:: str

__rich_repr__()[source]

Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.

Return type:: Iterable[Any | tuple[Any] | tuple[str, Any] | tuple[str, Any, Any]]

__setattr__(name, value)[source]

Implement setattr(self, name, value).

Return type:: None

__setstate__(state)[source]

Return type:: None

__signature__: ClassVar[Signature] = <Signature (*, data: kittycad.models.close_path.ClosePath, type: Literal['close_path'] = 'close_path') -> None>[source]: The synthesized __init__ [Signature][inspect.Signature] of the model.

__slots__ = ('__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__')[source]

__str__()[source]

Return str(self).

Return type:: str

_abc_impl = <_abc._abc_data object>[source]

_calculate_keys(*args, **kwargs)[source]

Return type:: Any

_check_frozen(name, value)[source]

Return type:: None

_copy_and_set_values(*args, **kwargs)[source]

Return type:: Any

classmethod _get_value(*args, **kwargs)[source]

Return type:: Any

_iter(*args, **kwargs)[source]

Return type:: Any

classmethod construct(_fields_set=None, **values)[source]

Return type:: Self

copy(*, include=None, exclude=None, update=None, deep=False)[source]

Returns a copy of the model.

!!! warning “Deprecated”: This method is now deprecated; use model_copy instead.

If you need include or exclude, use:

`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `

Parameters:

include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.

Returns:

A copy of the model with included, excluded and updated fields as specified.

data: ClosePath[source]

dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)[source]

Return type:: Dict[str, Any]

classmethod from_orm(obj)[source]

Return type:: Self

json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)[source]

Return type:: str

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}[source]: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'protected_namespaces': ()}[source]: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod model_construct(_fields_set=None, **values)[source]

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note: model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == 'allow', then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == 'ignore' (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == 'forbid' does not result in an error if extra values are passed, but they will be ignored.

Parameters:

_fields_set (set[str] | None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.
values (Any) – Trusted or pre-validated data dictionary.

Return type:

Self

Returns:

A new instance of the Model class with validated data.

model_copy(*, update=None, deep=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy

Returns a copy of the model.

Parameters:

update (dict[str, Any] | None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.
deep (bool) – Set to True to make a deep copy of the model.

Return type:

Self

Returns:

New model instance.

model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters:

mode (Union[Literal['json', 'python'], str]) – The mode in which to_python 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.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to include in the output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to exclude from the output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to use the field’s alias in the dictionary key if defined.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A dictionary representation of the model.

model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

Generates a JSON representation of the model using Pydantic’s to_json method.

Parameters:

indent (int | None) – Indentation to use in the JSON output. If None is passed, the output will be compact.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to include in the JSON output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to exclude from the JSON output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to serialize using field aliases.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A JSON string representation of the model.

property model_extra: dict[str, Any] | None[source]

Get extra fields set during validation.

Returns:: A dictionary of extra fields, or None if config.extra is not set to "allow".

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=ClosePath, required=True), 'type': FieldInfo(annotation=Literal['close_path'], required=False, default='close_path')}[source]

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

property model_fields_set: set[str][source]

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,: i.e. that were not filled from defaults.

classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')[source]

Generates a JSON schema for a model class.

Parameters:

by_alias (bool) – Whether to use attribute aliases or not.
ref_template (str) – The reference template.
schema_generator (type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modifications
mode (Literal['validation', 'serialization']) – The mode in which to generate the schema.

Return type:

Returns:

The JSON schema for the given model class.

classmethod model_parametrized_name(params)[source]

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

Parameters:: params (tuple[type[Any], ...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.
Return type:: str
Returns:: String representing the new class where params are passed to cls as type variables.
Raises:: TypeError – Raised when trying to generate concrete names for non-generic models.

model_post_init(_BaseModel__context)[source]

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

Return type:: None

classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)[source]

Try to rebuild the pydantic-core schema for the model.

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.

Parameters:

force (bool) – Whether to force the rebuilding of the model schema, defaults to False.
raise_errors (bool) – Whether to raise errors, defaults to True.
_parent_namespace_depth (int) – The depth level of the parent namespace, defaults to 2.
_types_namespace (dict[str, Any] | None) – The types namespace, defaults to None.

Return type:

Returns:

Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.

classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)[source]

Validate a pydantic model instance.

Parameters:

obj (Any) – The object to validate.
strict (bool | None) – Whether to enforce types strictly.
from_attributes (bool | None) – Whether to extract data from object attributes.
context (Any | None) – Additional context to pass to the validator.

Raises:

ValidationError – If the object could not be validated.

Return type:

Self

Returns:

The validated model instance.

classmethod model_validate_json(json_data, *, strict=None, context=None)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing

Validate the given JSON data against the Pydantic model.

Parameters:

json_data (str | bytes | bytearray) – The JSON data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

Raises:

ValidationError – If json_data is not a JSON string or the object could not be validated.

classmethod model_validate_strings(obj, *, strict=None, context=None)[source]

Validate the given object with string data against the Pydantic model.

Parameters:

obj (Any) – The object containing string data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod parse_obj(obj)[source]

Return type:: Self

classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod schema(by_alias=True, ref_template='#/$defs/{model}')[source]

Return type:: Dict[str, Any]

classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)[source]

Return type:: str

type: Literal['close_path'][source]

classmethod update_forward_refs(**localns)[source]

Return type:: None

classmethod validate(value)[source]

Return type:: Self

class kittycad.models.ok_modeling_cmd_response.OptionCurveGetControlPoints(**data)[source][source]

The response to the ‘CurveGetControlPoints’ endpoint

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__abstractmethods__ = frozenset({})[source]

__annotations__ = {'__class_vars__': 'ClassVar[set[str]]', '__private_attributes__': 'ClassVar[Dict[str, ModelPrivateAttr]]', '__pydantic_complete__': 'ClassVar[bool]', '__pydantic_core_schema__': 'ClassVar[CoreSchema]', '__pydantic_custom_init__': 'ClassVar[bool]', '__pydantic_decorators__': 'ClassVar[_decorators.DecoratorInfos]', '__pydantic_extra__': 'dict[str, Any] | None', '__pydantic_fields_set__': 'set[str]', '__pydantic_generic_metadata__': 'ClassVar[_generics.PydanticGenericMetadata]', '__pydantic_parent_namespace__': 'ClassVar[Dict[str, Any] | None]', '__pydantic_post_init__': "ClassVar[None | Literal['model_post_init']]", '__pydantic_private__': 'dict[str, Any] | None', '__pydantic_root_model__': 'ClassVar[bool]', '__pydantic_serializer__': 'ClassVar[SchemaSerializer]', '__pydantic_validator__': 'ClassVar[SchemaValidator | PluggableSchemaValidator]', '__signature__': 'ClassVar[Signature]', 'data': <class 'kittycad.models.curve_get_control_points.CurveGetControlPoints'>, 'model_computed_fields': 'ClassVar[Dict[str, ComputedFieldInfo]]', 'model_config': 'ClassVar[ConfigDict]', 'model_fields': 'ClassVar[Dict[str, FieldInfo]]', 'type': typing.Literal['curve_get_control_points']}[source]

classmethod __class_getitem__(typevar_values)[source]

Return type:: type[BaseModel] | PydanticRecursiveRef

__class_vars__: ClassVar[set[str]] = {}[source]: The names of the class variables defined on the model.

__copy__()[source]

Returns a shallow copy of the model.

Return type:: Self

__deepcopy__(memo=None)[source]

Returns a deep copy of the model.

Return type:: Self

__delattr__(item)[source]

Implement delattr(self, name).

Return type:: Any

__dict__[source]

__eq__(other)[source]

Return self==value.

Return type:: bool

property __fields_set__: set[str][source]

classmethod __get_pydantic_core_schema__(source, handler, /)[source]

Hook into generating the model’s CoreSchema.

Parameters:

source (type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.
handler (GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.

Return type:

Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]

Returns:

A pydantic-core CoreSchema.

classmethod __get_pydantic_json_schema__(core_schema, handler, /)[source]

Hook into generating the model’s JSON schema.

Parameters:

core_schema (Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({'type': 'nullable', 'schema': current_schema}), or just call the handler with the original schema.
handler (GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.

Return type:

Returns:

A JSON schema, as a Python object.

__getattr__(item)[source]

Return type:: Any

__getstate__()[source]

Helper for pickle.

Return type:: dict[Any, Any]

__hash__ = None[source]

__init__(**data)[source]

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__iter__()[source]

So dict(model) works.

Return type:: Generator[Tuple[str, Any], None, None]

__module__ = 'kittycad.models.ok_modeling_cmd_response'[source]

__pretty__(fmt, **kwargs)[source]

Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.

Return type:: Generator[Any, None, None]

__private_attributes__: ClassVar[Dict[str, ModelPrivateAttr]] = {}[source]: Metadata about the private attributes of the model.

__pydantic_complete__: ClassVar[bool] = True[source]: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__: ClassVar[CoreSchema] = {'cls': <class 'kittycad.models.ok_modeling_cmd_response.OptionCurveGetControlPoints'>, 'config': {'title': 'OptionCurveGetControlPoints'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.ok_modeling_cmd_response.OptionCurveGetControlPoints'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.ok_modeling_cmd_response.OptionCurveGetControlPoints'>>]}, 'ref': 'kittycad.models.ok_modeling_cmd_response.OptionCurveGetControlPoints:94667213663120', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'data': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.curve_get_control_points.CurveGetControlPoints'>, 'config': {'title': 'CurveGetControlPoints'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.curve_get_control_points.CurveGetControlPoints'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.curve_get_control_points.CurveGetControlPoints'>>]}, 'ref': 'kittycad.models.curve_get_control_points.CurveGetControlPoints:94667192135680', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'control_points': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'items_schema': {'cls': <class 'kittycad.models.point3d.Point3d'>, 'config': {'title': 'Point3d'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.point3d.Point3d'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.point3d.Point3d'>>]}, 'ref': 'kittycad.models.point3d.Point3d:94667194426368', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'x': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'type': 'float'}, 'type': 'model-field'}, 'y': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'type': 'float'}, 'type': 'model-field'}, 'z': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'type': 'float'}, 'type': 'model-field'}}, 'model_name': 'Point3d', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'list'}, 'type': 'model-field'}}, 'model_name': 'CurveGetControlPoints', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}, 'type': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': 'curve_get_control_points', 'schema': {'expected': ['curve_get_control_points'], 'type': 'literal'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'OptionCurveGetControlPoints', 'type': 'model-fields'}, 'type': 'model'}[source]: The core schema of the model.

__pydantic_custom_init__: ClassVar[bool] = False[source]: Whether the model has a custom __init__ method.

__pydantic_decorators__: ClassVar[_decorators.DecoratorInfos] = DecoratorInfos(validators={}, field_validators={}, root_validators={}, field_serializers={}, model_serializers={}, model_validators={}, computed_fields={})[source]: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_extra__: dict[str, Any] | None[source]: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to 'allow'.

__pydantic_fields_set__: set[str][source]: The names of fields explicitly set during instantiation.

__pydantic_generic_metadata__: ClassVar[_generics.PydanticGenericMetadata] = {'args': (), 'origin': None, 'parameters': ()}[source]: 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.

classmethod __pydantic_init_subclass__(**kwargs)[source]

This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.

This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.

This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.

Parameters:: **kwargs (Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.
Return type:: None

__pydantic_parent_namespace__: ClassVar[Dict[str, Any] | None] = None[source]: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__: ClassVar[None | Literal['model_post_init']] = None[source]: The name of the post-init method for the model, if defined.

__pydantic_private__: dict[str, Any] | None[source]: Values of private attributes set on the model instance.

__pydantic_root_model__: ClassVar[bool] = False[source]: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__: ClassVar[SchemaSerializer] = SchemaSerializer(serializer=Model( ModelSerializer { class: Py( 0x000056196da46b90, ), serializer: Fields( GeneralFieldsSerializer { fields: { "type": SerField { key_py: Py( 0x00007f903823d958, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f90346962e0, ), ), serializer: Literal( LiteralSerializer { expected_int: {}, expected_str: { "curve_get_control_points", }, expected_py: None, name: "literal['curve_get_control_points']", }, ), }, ), ), required: true, }, "data": SerField { key_py: Py( 0x00007f9038238fa0, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196c5bf000, ), serializer: Fields( GeneralFieldsSerializer { fields: { "control_points": SerField { key_py: Py( 0x00007f9033aa8f30, ), alias: None, alias_py: None, serializer: Some( List( ListSerializer { item_serializer: Model( ModelSerializer { class: Py( 0x000056196c7ee400, ), serializer: Fields( GeneralFieldsSerializer { fields: { "z": SerField { key_py: Py( 0x00007f903823f588, ), alias: None, alias_py: None, serializer: Some( Float( FloatSerializer { inf_nan_mode: Null, }, ), ), required: true, }, "x": SerField { key_py: Py( 0x00007f903823de18, ), alias: None, alias_py: None, serializer: Some( Float( FloatSerializer { inf_nan_mode: Null, }, ), ), required: true, }, "y": SerField { key_py: Py( 0x00007f903823f558, ), alias: None, alias_py: None, serializer: Some( Float( FloatSerializer { inf_nan_mode: Null, }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 3, }, ), has_extra: false, root_model: false, name: "Point3d", }, ), filter: SchemaFilter { include: None, exclude: None, }, name: "list[Point3d]", }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 1, }, ), has_extra: false, root_model: false, name: "CurveGetControlPoints", }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "OptionCurveGetControlPoints", }, ), definitions=[])[source]: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__: ClassVar[SchemaValidator | PluggableSchemaValidator] = SchemaValidator(title="OptionCurveGetControlPoints", validator=Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "data", lookup_key: Simple { key: "data", py_key: Py( 0x00007f903336f330, ), path: LookupPath( [ S( "data", Py( 0x00007f903336f360, ), ), ], ), }, name_py: Py( 0x00007f9038238fa0, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "control_points", lookup_key: Simple { key: "control_points", py_key: Py( 0x00007f90333925f0, ), path: LookupPath( [ S( "control_points", Py( 0x00007f90333925b0, ), ), ], ), }, name_py: Py( 0x00007f9033aa8f30, ), validator: List( ListValidator { strict: false, item_validator: Some( Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "x", lookup_key: Simple { key: "x", py_key: Py( 0x00007f903823f528, ), path: LookupPath( [ S( "x", Py( 0x00007f903823f528, ), ), ], ), }, name_py: Py( 0x00007f903823de18, ), validator: Float( FloatValidator { strict: false, allow_inf_nan: true, }, ), frozen: false, }, Field { name: "y", lookup_key: Simple { key: "y", py_key: Py( 0x00007f903823f558, ), path: LookupPath( [ S( "y", Py( 0x00007f903823f558, ), ), ], ), }, name_py: Py( 0x00007f903823f558, ), validator: Float( FloatValidator { strict: false, allow_inf_nan: true, }, ), frozen: false, }, Field { name: "z", lookup_key: Simple { key: "z", py_key: Py( 0x00007f903823f588, ), path: LookupPath( [ S( "z", Py( 0x00007f903823f588, ), ), ], ), }, name_py: Py( 0x00007f903823f588, ), validator: Float( FloatValidator { strict: false, allow_inf_nan: true, }, ), frozen: false, }, ], model_name: "Point3d", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196c7ee400, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "Point3d", }, ), ), min_length: None, max_length: None, name: OnceLock( <uninit>, ), fail_fast: false, }, ), frozen: false, }, ], model_name: "CurveGetControlPoints", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196c5bf000, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "CurveGetControlPoints", }, ), frozen: false, }, Field { name: "type", lookup_key: Simple { key: "type", py_key: Py( 0x00007f903336f390, ), path: LookupPath( [ S( "type", Py( 0x00007f903336f3c0, ), ), ], ), }, name_py: Py( 0x00007f903823d958, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f90346962e0, ), ), on_error: Raise, validator: Literal( LiteralValidator { lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "curve_get_control_points": 0, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f90346962e0, ), ], }, expected_repr: "'curve_get_control_points'", name: "literal['curve_get_control_points']", }, ), validate_default: false, copy_default: false, name: "default[literal['curve_get_control_points']]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "OptionCurveGetControlPoints", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196da46b90, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "OptionCurveGetControlPoints", }, ), definitions=[], cache_strings=True)[source]: The pydantic-core SchemaValidator used to validate instances of the model.

__repr__()[source]

Return repr(self).

Return type:: str

__repr_args__()[source]

Return type:: Iterable[tuple[str | None, Any]]

__repr_name__()[source]

Name of the instance’s class, used in __repr__.

Return type:: str

__repr_str__(join_str)[source]

Return type:: str

__rich_repr__()[source]

Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.

Return type:: Iterable[Any | tuple[Any] | tuple[str, Any] | tuple[str, Any, Any]]

__setattr__(name, value)[source]

Implement setattr(self, name, value).

Return type:: None

__setstate__(state)[source]

Return type:: None

__signature__: ClassVar[Signature] = <Signature (*, data: kittycad.models.curve_get_control_points.CurveGetControlPoints, type: Literal['curve_get_control_points'] = 'curve_get_control_points') -> None>[source]: The synthesized __init__ [Signature][inspect.Signature] of the model.

__slots__ = ('__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__')[source]

__str__()[source]

Return str(self).

Return type:: str

_abc_impl = <_abc._abc_data object>[source]

_calculate_keys(*args, **kwargs)[source]

Return type:: Any

_check_frozen(name, value)[source]

Return type:: None

_copy_and_set_values(*args, **kwargs)[source]

Return type:: Any

classmethod _get_value(*args, **kwargs)[source]

Return type:: Any

_iter(*args, **kwargs)[source]

Return type:: Any

classmethod construct(_fields_set=None, **values)[source]

Return type:: Self

copy(*, include=None, exclude=None, update=None, deep=False)[source]

Returns a copy of the model.

!!! warning “Deprecated”: This method is now deprecated; use model_copy instead.

If you need include or exclude, use:

`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `

Parameters:

include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.

Returns:

A copy of the model with included, excluded and updated fields as specified.

data: CurveGetControlPoints[source]

dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)[source]

Return type:: Dict[str, Any]

classmethod from_orm(obj)[source]

Return type:: Self

json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)[source]

Return type:: str

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}[source]: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'protected_namespaces': ()}[source]: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod model_construct(_fields_set=None, **values)[source]

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note: model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == 'allow', then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == 'ignore' (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == 'forbid' does not result in an error if extra values are passed, but they will be ignored.

Parameters:

_fields_set (set[str] | None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.
values (Any) – Trusted or pre-validated data dictionary.

Return type:

Self

Returns:

A new instance of the Model class with validated data.

model_copy(*, update=None, deep=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy

Returns a copy of the model.

Parameters:

update (dict[str, Any] | None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.
deep (bool) – Set to True to make a deep copy of the model.

Return type:

Self

Returns:

New model instance.

model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters:

mode (Union[Literal['json', 'python'], str]) – The mode in which to_python 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.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to include in the output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to exclude from the output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to use the field’s alias in the dictionary key if defined.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A dictionary representation of the model.

model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

Generates a JSON representation of the model using Pydantic’s to_json method.

Parameters:

indent (int | None) – Indentation to use in the JSON output. If None is passed, the output will be compact.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to include in the JSON output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to exclude from the JSON output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to serialize using field aliases.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A JSON string representation of the model.

property model_extra: dict[str, Any] | None[source]

Get extra fields set during validation.

Returns:: A dictionary of extra fields, or None if config.extra is not set to "allow".

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=CurveGetControlPoints, required=True), 'type': FieldInfo(annotation=Literal['curve_get_control_points'], required=False, default='curve_get_control_points')}[source]

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

property model_fields_set: set[str][source]

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,: i.e. that were not filled from defaults.

classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')[source]

Generates a JSON schema for a model class.

Parameters:

by_alias (bool) – Whether to use attribute aliases or not.
ref_template (str) – The reference template.
schema_generator (type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modifications
mode (Literal['validation', 'serialization']) – The mode in which to generate the schema.

Return type:

Returns:

The JSON schema for the given model class.

classmethod model_parametrized_name(params)[source]

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

Parameters:: params (tuple[type[Any], ...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.
Return type:: str
Returns:: String representing the new class where params are passed to cls as type variables.
Raises:: TypeError – Raised when trying to generate concrete names for non-generic models.

model_post_init(_BaseModel__context)[source]

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

Return type:: None

classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)[source]

Try to rebuild the pydantic-core schema for the model.

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.

Parameters:

force (bool) – Whether to force the rebuilding of the model schema, defaults to False.
raise_errors (bool) – Whether to raise errors, defaults to True.
_parent_namespace_depth (int) – The depth level of the parent namespace, defaults to 2.
_types_namespace (dict[str, Any] | None) – The types namespace, defaults to None.

Return type:

Returns:

Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.

classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)[source]

Validate a pydantic model instance.

Parameters:

obj (Any) – The object to validate.
strict (bool | None) – Whether to enforce types strictly.
from_attributes (bool | None) – Whether to extract data from object attributes.
context (Any | None) – Additional context to pass to the validator.

Raises:

ValidationError – If the object could not be validated.

Return type:

Self

Returns:

The validated model instance.

classmethod model_validate_json(json_data, *, strict=None, context=None)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing

Validate the given JSON data against the Pydantic model.

Parameters:

json_data (str | bytes | bytearray) – The JSON data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

Raises:

ValidationError – If json_data is not a JSON string or the object could not be validated.

classmethod model_validate_strings(obj, *, strict=None, context=None)[source]

Validate the given object with string data against the Pydantic model.

Parameters:

obj (Any) – The object containing string data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod parse_obj(obj)[source]

Return type:: Self

classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod schema(by_alias=True, ref_template='#/$defs/{model}')[source]

Return type:: Dict[str, Any]

classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)[source]

Return type:: str

type: Literal['curve_get_control_points'][source]

classmethod update_forward_refs(**localns)[source]

Return type:: None

classmethod validate(value)[source]

Return type:: Self

class kittycad.models.ok_modeling_cmd_response.OptionCurveGetEndPoints(**data)[source][source]

The response to the ‘CurveGetEndPoints’ endpoint

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__abstractmethods__ = frozenset({})[source]

__annotations__ = {'__class_vars__': 'ClassVar[set[str]]', '__private_attributes__': 'ClassVar[Dict[str, ModelPrivateAttr]]', '__pydantic_complete__': 'ClassVar[bool]', '__pydantic_core_schema__': 'ClassVar[CoreSchema]', '__pydantic_custom_init__': 'ClassVar[bool]', '__pydantic_decorators__': 'ClassVar[_decorators.DecoratorInfos]', '__pydantic_extra__': 'dict[str, Any] | None', '__pydantic_fields_set__': 'set[str]', '__pydantic_generic_metadata__': 'ClassVar[_generics.PydanticGenericMetadata]', '__pydantic_parent_namespace__': 'ClassVar[Dict[str, Any] | None]', '__pydantic_post_init__': "ClassVar[None | Literal['model_post_init']]", '__pydantic_private__': 'dict[str, Any] | None', '__pydantic_root_model__': 'ClassVar[bool]', '__pydantic_serializer__': 'ClassVar[SchemaSerializer]', '__pydantic_validator__': 'ClassVar[SchemaValidator | PluggableSchemaValidator]', '__signature__': 'ClassVar[Signature]', 'data': <class 'kittycad.models.curve_get_end_points.CurveGetEndPoints'>, 'model_computed_fields': 'ClassVar[Dict[str, ComputedFieldInfo]]', 'model_config': 'ClassVar[ConfigDict]', 'model_fields': 'ClassVar[Dict[str, FieldInfo]]', 'type': typing.Literal['curve_get_end_points']}[source]

classmethod __class_getitem__(typevar_values)[source]

Return type:: type[BaseModel] | PydanticRecursiveRef

__class_vars__: ClassVar[set[str]] = {}[source]: The names of the class variables defined on the model.

__copy__()[source]

Returns a shallow copy of the model.

Return type:: Self

__deepcopy__(memo=None)[source]

Returns a deep copy of the model.

Return type:: Self

__delattr__(item)[source]

Implement delattr(self, name).

Return type:: Any

__dict__[source]

__eq__(other)[source]

Return self==value.

Return type:: bool

property __fields_set__: set[str][source]

classmethod __get_pydantic_core_schema__(source, handler, /)[source]

Hook into generating the model’s CoreSchema.

Parameters:

source (type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.
handler (GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.

Return type:

Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]

Returns:

A pydantic-core CoreSchema.

classmethod __get_pydantic_json_schema__(core_schema, handler, /)[source]

Hook into generating the model’s JSON schema.

Parameters:

core_schema (Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({'type': 'nullable', 'schema': current_schema}), or just call the handler with the original schema.
handler (GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.

Return type:

Returns:

A JSON schema, as a Python object.

__getattr__(item)[source]

Return type:: Any

__getstate__()[source]

Helper for pickle.

Return type:: dict[Any, Any]

__hash__ = None[source]

__init__(**data)[source]

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__iter__()[source]

So dict(model) works.

Return type:: Generator[Tuple[str, Any], None, None]

__module__ = 'kittycad.models.ok_modeling_cmd_response'[source]

__pretty__(fmt, **kwargs)[source]

Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.

Return type:: Generator[Any, None, None]

__private_attributes__: ClassVar[Dict[str, ModelPrivateAttr]] = {}[source]: Metadata about the private attributes of the model.

__pydantic_complete__: ClassVar[bool] = True[source]: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__: ClassVar[CoreSchema] = {'definitions': [{'cls': <class 'kittycad.models.point3d.Point3d'>, 'config': {'title': 'Point3d'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.point3d.Point3d'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.point3d.Point3d'>>]}, 'ref': 'kittycad.models.point3d.Point3d:94667194426368', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'x': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'type': 'float'}, 'type': 'model-field'}, 'y': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'type': 'float'}, 'type': 'model-field'}, 'z': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'type': 'float'}, 'type': 'model-field'}}, 'model_name': 'Point3d', 'type': 'model-fields'}, 'type': 'model'}], 'schema': {'cls': <class 'kittycad.models.ok_modeling_cmd_response.OptionCurveGetEndPoints'>, 'config': {'title': 'OptionCurveGetEndPoints'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.ok_modeling_cmd_response.OptionCurveGetEndPoints'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.ok_modeling_cmd_response.OptionCurveGetEndPoints'>>]}, 'ref': 'kittycad.models.ok_modeling_cmd_response.OptionCurveGetEndPoints:94667213806384', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'data': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.curve_get_end_points.CurveGetEndPoints'>, 'config': {'title': 'CurveGetEndPoints'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.curve_get_end_points.CurveGetEndPoints'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.curve_get_end_points.CurveGetEndPoints'>>]}, 'ref': 'kittycad.models.curve_get_end_points.CurveGetEndPoints:94667192143408', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'end': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'schema_ref': 'kittycad.models.point3d.Point3d:94667194426368', 'type': 'definition-ref'}, 'type': 'model-field'}, 'start': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'schema_ref': 'kittycad.models.point3d.Point3d:94667194426368', 'type': 'definition-ref'}, 'type': 'model-field'}}, 'model_name': 'CurveGetEndPoints', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}, 'type': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': 'curve_get_end_points', 'schema': {'expected': ['curve_get_end_points'], 'type': 'literal'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'OptionCurveGetEndPoints', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'definitions'}[source]: The core schema of the model.

__pydantic_custom_init__: ClassVar[bool] = False[source]: Whether the model has a custom __init__ method.

__pydantic_decorators__: ClassVar[_decorators.DecoratorInfos] = DecoratorInfos(validators={}, field_validators={}, root_validators={}, field_serializers={}, model_serializers={}, model_validators={}, computed_fields={})[source]: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_extra__: dict[str, Any] | None[source]: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to 'allow'.

__pydantic_fields_set__: set[str][source]: The names of fields explicitly set during instantiation.

__pydantic_generic_metadata__: ClassVar[_generics.PydanticGenericMetadata] = {'args': (), 'origin': None, 'parameters': ()}[source]: 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.

classmethod __pydantic_init_subclass__(**kwargs)[source]

This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.

This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.

This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.

Parameters:: **kwargs (Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.
Return type:: None

__pydantic_parent_namespace__: ClassVar[Dict[str, Any] | None] = None[source]: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__: ClassVar[None | Literal['model_post_init']] = None[source]: The name of the post-init method for the model, if defined.

__pydantic_private__: dict[str, Any] | None[source]: Values of private attributes set on the model instance.

__pydantic_root_model__: ClassVar[bool] = False[source]: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__: ClassVar[SchemaSerializer] = SchemaSerializer(serializer=Model( ModelSerializer { class: Py( 0x000056196da69b30, ), serializer: Fields( GeneralFieldsSerializer { fields: { "data": SerField { key_py: Py( 0x00007f9038238fa0, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196c5c0e30, ), serializer: Fields( GeneralFieldsSerializer { fields: { "end": SerField { key_py: Py( 0x00007f9038239660, ), alias: None, alias_py: None, serializer: Some( Recursive( DefinitionRefSerializer { definition: "...", retry_with_lax_check: true, }, ), ), required: true, }, "start": SerField { key_py: Py( 0x00007f903823d0a0, ), alias: None, alias_py: None, serializer: Some( Recursive( DefinitionRefSerializer { definition: "...", retry_with_lax_check: true, }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "CurveGetEndPoints", }, ), ), required: true, }, "type": SerField { key_py: Py( 0x00007f903823d958, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f90346d5230, ), ), serializer: Literal( LiteralSerializer { expected_int: {}, expected_str: { "curve_get_end_points", }, expected_py: None, name: "literal['curve_get_end_points']", }, ), }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "OptionCurveGetEndPoints", }, ), definitions=[Model(ModelSerializer { class: Py(0x56196c7ee400), serializer: Fields(GeneralFieldsSerializer { fields: {"y": SerField { key_py: Py(0x7f903823f558), alias: None, alias_py: None, serializer: Some(Float(FloatSerializer { inf_nan_mode: Null })), required: true }, "x": SerField { key_py: Py(0x7f903823de18), alias: None, alias_py: None, serializer: Some(Float(FloatSerializer { inf_nan_mode: Null })), required: true }, "z": SerField { key_py: Py(0x7f903823f588), alias: None, alias_py: None, serializer: Some(Float(FloatSerializer { inf_nan_mode: Null })), required: true }}, computed_fields: Some(ComputedFields([])), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None }, required_fields: 3 }), has_extra: false, root_model: false, name: "Point3d" })])[source]: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__: ClassVar[SchemaValidator | PluggableSchemaValidator] = SchemaValidator(title="OptionCurveGetEndPoints", validator=Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "data", lookup_key: Simple { key: "data", py_key: Py( 0x00007f90333a8cc0, ), path: LookupPath( [ S( "data", Py( 0x00007f90333a8cf0, ), ), ], ), }, name_py: Py( 0x00007f9038238fa0, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "end", lookup_key: Simple { key: "end", py_key: Py( 0x00007f90333a8c00, ), path: LookupPath( [ S( "end", Py( 0x00007f90333a8c30, ), ), ], ), }, name_py: Py( 0x00007f9038239660, ), validator: DefinitionRef( DefinitionRefValidator { definition: "...", }, ), frozen: false, }, Field { name: "start", lookup_key: Simple { key: "start", py_key: Py( 0x00007f90333a8c60, ), path: LookupPath( [ S( "start", Py( 0x00007f90333a8c90, ), ), ], ), }, name_py: Py( 0x00007f903823d0a0, ), validator: DefinitionRef( DefinitionRefValidator { definition: "...", }, ), frozen: false, }, ], model_name: "CurveGetEndPoints", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196c5c0e30, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "CurveGetEndPoints", }, ), frozen: false, }, Field { name: "type", lookup_key: Simple { key: "type", py_key: Py( 0x00007f90333a8d20, ), path: LookupPath( [ S( "type", Py( 0x00007f90333a8d50, ), ), ], ), }, name_py: Py( 0x00007f903823d958, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f90346d5230, ), ), on_error: Raise, validator: Literal( LiteralValidator { lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "curve_get_end_points": 0, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f90346d5230, ), ], }, expected_repr: "'curve_get_end_points'", name: "literal['curve_get_end_points']", }, ), validate_default: false, copy_default: false, name: "default[literal['curve_get_end_points']]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "OptionCurveGetEndPoints", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196da69b30, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "OptionCurveGetEndPoints", }, ), definitions=[Model(ModelValidator { revalidate: Never, validator: ModelFields(ModelFieldsValidator { fields: [Field { name: "x", lookup_key: Simple { key: "x", py_key: Py(0x7f903823f528), path: LookupPath([S("x", Py(0x7f903823f528))]) }, name_py: Py(0x7f903823de18), validator: Float(FloatValidator { strict: false, allow_inf_nan: true }), frozen: false }, Field { name: "y", lookup_key: Simple { key: "y", py_key: Py(0x7f903823f558), path: LookupPath([S("y", Py(0x7f903823f558))]) }, name_py: Py(0x7f903823f558), validator: Float(FloatValidator { strict: false, allow_inf_nan: true }), frozen: false }, Field { name: "z", lookup_key: Simple { key: "z", py_key: Py(0x7f903823f588), path: LookupPath([S("z", Py(0x7f903823f588))]) }, name_py: Py(0x7f903823f588), validator: Float(FloatValidator { strict: false, allow_inf_nan: true }), frozen: false }], model_name: "Point3d", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true }), class: Py(0x56196c7ee400), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py(0x7f903629a320), name: "Point3d" })], cache_strings=True)[source]: The pydantic-core SchemaValidator used to validate instances of the model.

__repr__()[source]

Return repr(self).

Return type:: str

__repr_args__()[source]

Return type:: Iterable[tuple[str | None, Any]]

__repr_name__()[source]

Name of the instance’s class, used in __repr__.

Return type:: str

__repr_str__(join_str)[source]

Return type:: str

__rich_repr__()[source]

Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.

Return type:: Iterable[Any | tuple[Any] | tuple[str, Any] | tuple[str, Any, Any]]

__setattr__(name, value)[source]

Implement setattr(self, name, value).

Return type:: None

__setstate__(state)[source]

Return type:: None

__signature__: ClassVar[Signature] = <Signature (*, data: kittycad.models.curve_get_end_points.CurveGetEndPoints, type: Literal['curve_get_end_points'] = 'curve_get_end_points') -> None>[source]: The synthesized __init__ [Signature][inspect.Signature] of the model.

__slots__ = ('__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__')[source]

__str__()[source]

Return str(self).

Return type:: str

_abc_impl = <_abc._abc_data object>[source]

_calculate_keys(*args, **kwargs)[source]

Return type:: Any

_check_frozen(name, value)[source]

Return type:: None

_copy_and_set_values(*args, **kwargs)[source]

Return type:: Any

classmethod _get_value(*args, **kwargs)[source]

Return type:: Any

_iter(*args, **kwargs)[source]

Return type:: Any

classmethod construct(_fields_set=None, **values)[source]

Return type:: Self

copy(*, include=None, exclude=None, update=None, deep=False)[source]

Returns a copy of the model.

!!! warning “Deprecated”: This method is now deprecated; use model_copy instead.

If you need include or exclude, use:

`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `

Parameters:

include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.

Returns:

A copy of the model with included, excluded and updated fields as specified.

data: CurveGetEndPoints[source]

dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)[source]

Return type:: Dict[str, Any]

classmethod from_orm(obj)[source]

Return type:: Self

json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)[source]

Return type:: str

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}[source]: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'protected_namespaces': ()}[source]: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod model_construct(_fields_set=None, **values)[source]

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note: model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == 'allow', then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == 'ignore' (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == 'forbid' does not result in an error if extra values are passed, but they will be ignored.

Parameters:

_fields_set (set[str] | None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.
values (Any) – Trusted or pre-validated data dictionary.

Return type:

Self

Returns:

A new instance of the Model class with validated data.

model_copy(*, update=None, deep=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy

Returns a copy of the model.

Parameters:

update (dict[str, Any] | None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.
deep (bool) – Set to True to make a deep copy of the model.

Return type:

Self

Returns:

New model instance.

model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters:

mode (Union[Literal['json', 'python'], str]) – The mode in which to_python 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.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to include in the output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to exclude from the output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to use the field’s alias in the dictionary key if defined.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A dictionary representation of the model.

model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

Generates a JSON representation of the model using Pydantic’s to_json method.

Parameters:

indent (int | None) – Indentation to use in the JSON output. If None is passed, the output will be compact.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to include in the JSON output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to exclude from the JSON output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to serialize using field aliases.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A JSON string representation of the model.

property model_extra: dict[str, Any] | None[source]

Get extra fields set during validation.

Returns:: A dictionary of extra fields, or None if config.extra is not set to "allow".

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=CurveGetEndPoints, required=True), 'type': FieldInfo(annotation=Literal['curve_get_end_points'], required=False, default='curve_get_end_points')}[source]

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

property model_fields_set: set[str][source]

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,: i.e. that were not filled from defaults.

classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')[source]

Generates a JSON schema for a model class.

Parameters:

by_alias (bool) – Whether to use attribute aliases or not.
ref_template (str) – The reference template.
schema_generator (type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modifications
mode (Literal['validation', 'serialization']) – The mode in which to generate the schema.

Return type:

Returns:

The JSON schema for the given model class.

classmethod model_parametrized_name(params)[source]

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

Parameters:: params (tuple[type[Any], ...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.
Return type:: str
Returns:: String representing the new class where params are passed to cls as type variables.
Raises:: TypeError – Raised when trying to generate concrete names for non-generic models.

model_post_init(_BaseModel__context)[source]

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

Return type:: None

classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)[source]

Try to rebuild the pydantic-core schema for the model.

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.

Parameters:

force (bool) – Whether to force the rebuilding of the model schema, defaults to False.
raise_errors (bool) – Whether to raise errors, defaults to True.
_parent_namespace_depth (int) – The depth level of the parent namespace, defaults to 2.
_types_namespace (dict[str, Any] | None) – The types namespace, defaults to None.

Return type:

Returns:

Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.

classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)[source]

Validate a pydantic model instance.

Parameters:

obj (Any) – The object to validate.
strict (bool | None) – Whether to enforce types strictly.
from_attributes (bool | None) – Whether to extract data from object attributes.
context (Any | None) – Additional context to pass to the validator.

Raises:

ValidationError – If the object could not be validated.

Return type:

Self

Returns:

The validated model instance.

classmethod model_validate_json(json_data, *, strict=None, context=None)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing

Validate the given JSON data against the Pydantic model.

Parameters:

json_data (str | bytes | bytearray) – The JSON data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

Raises:

ValidationError – If json_data is not a JSON string or the object could not be validated.

classmethod model_validate_strings(obj, *, strict=None, context=None)[source]

Validate the given object with string data against the Pydantic model.

Parameters:

obj (Any) – The object containing string data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod parse_obj(obj)[source]

Return type:: Self

classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod schema(by_alias=True, ref_template='#/$defs/{model}')[source]

Return type:: Dict[str, Any]

classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)[source]

Return type:: str

type: Literal['curve_get_end_points'][source]

classmethod update_forward_refs(**localns)[source]

Return type:: None

classmethod validate(value)[source]

Return type:: Self

class kittycad.models.ok_modeling_cmd_response.OptionCurveGetType(**data)[source][source]

The response to the ‘CurveGetType’ endpoint

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__abstractmethods__ = frozenset({})[source]

__annotations__ = {'__class_vars__': 'ClassVar[set[str]]', '__private_attributes__': 'ClassVar[Dict[str, ModelPrivateAttr]]', '__pydantic_complete__': 'ClassVar[bool]', '__pydantic_core_schema__': 'ClassVar[CoreSchema]', '__pydantic_custom_init__': 'ClassVar[bool]', '__pydantic_decorators__': 'ClassVar[_decorators.DecoratorInfos]', '__pydantic_extra__': 'dict[str, Any] | None', '__pydantic_fields_set__': 'set[str]', '__pydantic_generic_metadata__': 'ClassVar[_generics.PydanticGenericMetadata]', '__pydantic_parent_namespace__': 'ClassVar[Dict[str, Any] | None]', '__pydantic_post_init__': "ClassVar[None | Literal['model_post_init']]", '__pydantic_private__': 'dict[str, Any] | None', '__pydantic_root_model__': 'ClassVar[bool]', '__pydantic_serializer__': 'ClassVar[SchemaSerializer]', '__pydantic_validator__': 'ClassVar[SchemaValidator | PluggableSchemaValidator]', '__signature__': 'ClassVar[Signature]', 'data': <class 'kittycad.models.curve_get_type.CurveGetType'>, 'model_computed_fields': 'ClassVar[Dict[str, ComputedFieldInfo]]', 'model_config': 'ClassVar[ConfigDict]', 'model_fields': 'ClassVar[Dict[str, FieldInfo]]', 'type': typing.Literal['curve_get_type']}[source]

classmethod __class_getitem__(typevar_values)[source]

Return type:: type[BaseModel] | PydanticRecursiveRef

__class_vars__: ClassVar[set[str]] = {}[source]: The names of the class variables defined on the model.

__copy__()[source]

Returns a shallow copy of the model.

Return type:: Self

__deepcopy__(memo=None)[source]

Returns a deep copy of the model.

Return type:: Self

__delattr__(item)[source]

Implement delattr(self, name).

Return type:: Any

__dict__[source]

__eq__(other)[source]

Return self==value.

Return type:: bool

property __fields_set__: set[str][source]

classmethod __get_pydantic_core_schema__(source, handler, /)[source]

Hook into generating the model’s CoreSchema.

Parameters:

source (type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.
handler (GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.

Return type:

Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]

Returns:

A pydantic-core CoreSchema.

classmethod __get_pydantic_json_schema__(core_schema, handler, /)[source]

Hook into generating the model’s JSON schema.

Parameters:

core_schema (Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({'type': 'nullable', 'schema': current_schema}), or just call the handler with the original schema.
handler (GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.

Return type:

Returns:

A JSON schema, as a Python object.

__getattr__(item)[source]

Return type:: Any

__getstate__()[source]

Helper for pickle.

Return type:: dict[Any, Any]

__hash__ = None[source]

__init__(**data)[source]

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__iter__()[source]

So dict(model) works.

Return type:: Generator[Tuple[str, Any], None, None]

__module__ = 'kittycad.models.ok_modeling_cmd_response'[source]

__pretty__(fmt, **kwargs)[source]

Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.

Return type:: Generator[Any, None, None]

__private_attributes__: ClassVar[Dict[str, ModelPrivateAttr]] = {}[source]: Metadata about the private attributes of the model.

__pydantic_complete__: ClassVar[bool] = True[source]: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__: ClassVar[CoreSchema] = {'cls': <class 'kittycad.models.ok_modeling_cmd_response.OptionCurveGetType'>, 'config': {'title': 'OptionCurveGetType'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.ok_modeling_cmd_response.OptionCurveGetType'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.ok_modeling_cmd_response.OptionCurveGetType'>>]}, 'ref': 'kittycad.models.ok_modeling_cmd_response.OptionCurveGetType:94667213675776', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'data': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.curve_get_type.CurveGetType'>, 'config': {'title': 'CurveGetType'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.curve_get_type.CurveGetType'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.curve_get_type.CurveGetType'>>]}, 'ref': 'kittycad.models.curve_get_type.CurveGetType:94667192130960', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'curve_type': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <enum 'CurveType'>, 'members': [CurveType.LINE, CurveType.ARC, CurveType.NURBS], 'metadata': {'pydantic_js_functions': [<function GenerateSchema._enum_schema.<locals>.get_json_schema>]}, 'ref': 'kittycad.models.curve_type.CurveType:94667192129184', 'sub_type': 'str', 'type': 'enum'}, 'type': 'model-field'}}, 'model_name': 'CurveGetType', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}, 'type': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': 'curve_get_type', 'schema': {'expected': ['curve_get_type'], 'type': 'literal'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'OptionCurveGetType', 'type': 'model-fields'}, 'type': 'model'}[source]: The core schema of the model.

__pydantic_custom_init__: ClassVar[bool] = False[source]: Whether the model has a custom __init__ method.

__pydantic_decorators__: ClassVar[_decorators.DecoratorInfos] = DecoratorInfos(validators={}, field_validators={}, root_validators={}, field_serializers={}, model_serializers={}, model_validators={}, computed_fields={})[source]: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_extra__: dict[str, Any] | None[source]: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to 'allow'.

__pydantic_fields_set__: set[str][source]: The names of fields explicitly set during instantiation.

__pydantic_generic_metadata__: ClassVar[_generics.PydanticGenericMetadata] = {'args': (), 'origin': None, 'parameters': ()}[source]: 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.

classmethod __pydantic_init_subclass__(**kwargs)[source]

This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.

This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.

This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.

Parameters:: **kwargs (Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.
Return type:: None

__pydantic_parent_namespace__: ClassVar[Dict[str, Any] | None] = None[source]: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__: ClassVar[None | Literal['model_post_init']] = None[source]: The name of the post-init method for the model, if defined.

__pydantic_private__: dict[str, Any] | None[source]: Values of private attributes set on the model instance.

__pydantic_root_model__: ClassVar[bool] = False[source]: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__: ClassVar[SchemaSerializer] = SchemaSerializer(serializer=Model( ModelSerializer { class: Py( 0x000056196da49d00, ), serializer: Fields( GeneralFieldsSerializer { fields: { "type": SerField { key_py: Py( 0x00007f903823d958, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f90346d5370, ), ), serializer: Literal( LiteralSerializer { expected_int: {}, expected_str: { "curve_get_type", }, expected_py: None, name: "literal['curve_get_type']", }, ), }, ), ), required: true, }, "data": SerField { key_py: Py( 0x00007f9038238fa0, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196c5bdd90, ), serializer: Fields( GeneralFieldsSerializer { fields: { "curve_type": SerField { key_py: Py( 0x00007f90346d7370, ), alias: None, alias_py: None, serializer: Some( Enum( EnumSerializer { class: Py( 0x000056196c5bd6a0, ), serializer: Some( Str( StrSerializer, ), ), }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 1, }, ), has_extra: false, root_model: false, name: "CurveGetType", }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "OptionCurveGetType", }, ), definitions=[])[source]: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__: ClassVar[SchemaValidator | PluggableSchemaValidator] = SchemaValidator(title="OptionCurveGetType", validator=Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "data", lookup_key: Simple { key: "data", py_key: Py( 0x00007f903336eb20, ), path: LookupPath( [ S( "data", Py( 0x00007f903336eaf0, ), ), ], ), }, name_py: Py( 0x00007f9038238fa0, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "curve_type", lookup_key: Simple { key: "curve_type", py_key: Py( 0x00007f903338ac70, ), path: LookupPath( [ S( "curve_type", Py( 0x00007f903338b070, ), ), ], ), }, name_py: Py( 0x00007f90346d7370, ), validator: StrEnum( EnumValidator { phantom: PhantomData<_pydantic_core::validators::enum_::StrEnumValidator>, class: Py( 0x000056196c5bd6a0, ), lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "line": 0, "arc": 1, "nurbs": 2, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f9033b531d0, ), Py( 0x00007f9033b53230, ), Py( 0x00007f9033b53290, ), ], }, missing: None, expected_repr: "'line', 'arc' or 'nurbs'", strict: false, class_repr: "CurveType", name: "str-enum[CurveType]", }, ), frozen: false, }, ], model_name: "CurveGetType", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196c5bdd90, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "CurveGetType", }, ), frozen: false, }, Field { name: "type", lookup_key: Simple { key: "type", py_key: Py( 0x00007f903336eb50, ), path: LookupPath( [ S( "type", Py( 0x00007f903336e760, ), ), ], ), }, name_py: Py( 0x00007f903823d958, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f90346d5370, ), ), on_error: Raise, validator: Literal( LiteralValidator { lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "curve_get_type": 0, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f90346d5370, ), ], }, expected_repr: "'curve_get_type'", name: "literal['curve_get_type']", }, ), validate_default: false, copy_default: false, name: "default[literal['curve_get_type']]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "OptionCurveGetType", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196da49d00, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "OptionCurveGetType", }, ), definitions=[], cache_strings=True)[source]: The pydantic-core SchemaValidator used to validate instances of the model.

__repr__()[source]

Return repr(self).

Return type:: str

__repr_args__()[source]

Return type:: Iterable[tuple[str | None, Any]]

__repr_name__()[source]

Name of the instance’s class, used in __repr__.

Return type:: str

__repr_str__(join_str)[source]

Return type:: str

__rich_repr__()[source]

Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.

Return type:: Iterable[Any | tuple[Any] | tuple[str, Any] | tuple[str, Any, Any]]

__setattr__(name, value)[source]

Implement setattr(self, name, value).

Return type:: None

__setstate__(state)[source]

Return type:: None

__signature__: ClassVar[Signature] = <Signature (*, data: kittycad.models.curve_get_type.CurveGetType, type: Literal['curve_get_type'] = 'curve_get_type') -> None>[source]: The synthesized __init__ [Signature][inspect.Signature] of the model.

__slots__ = ('__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__')[source]

__str__()[source]

Return str(self).

Return type:: str

_abc_impl = <_abc._abc_data object>[source]

_calculate_keys(*args, **kwargs)[source]

Return type:: Any

_check_frozen(name, value)[source]

Return type:: None

_copy_and_set_values(*args, **kwargs)[source]

Return type:: Any

classmethod _get_value(*args, **kwargs)[source]

Return type:: Any

_iter(*args, **kwargs)[source]

Return type:: Any

classmethod construct(_fields_set=None, **values)[source]

Return type:: Self

copy(*, include=None, exclude=None, update=None, deep=False)[source]

Returns a copy of the model.

!!! warning “Deprecated”: This method is now deprecated; use model_copy instead.

If you need include or exclude, use:

`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `

Parameters:

include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.

Returns:

A copy of the model with included, excluded and updated fields as specified.

data: CurveGetType[source]

dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)[source]

Return type:: Dict[str, Any]

classmethod from_orm(obj)[source]

Return type:: Self

json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)[source]

Return type:: str

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}[source]: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'protected_namespaces': ()}[source]: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod model_construct(_fields_set=None, **values)[source]

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note: model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == 'allow', then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == 'ignore' (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == 'forbid' does not result in an error if extra values are passed, but they will be ignored.

Parameters:

_fields_set (set[str] | None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.
values (Any) – Trusted or pre-validated data dictionary.

Return type:

Self

Returns:

A new instance of the Model class with validated data.

model_copy(*, update=None, deep=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy

Returns a copy of the model.

Parameters:

update (dict[str, Any] | None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.
deep (bool) – Set to True to make a deep copy of the model.

Return type:

Self

Returns:

New model instance.

model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters:

mode (Union[Literal['json', 'python'], str]) – The mode in which to_python 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.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to include in the output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to exclude from the output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to use the field’s alias in the dictionary key if defined.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A dictionary representation of the model.

model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

Generates a JSON representation of the model using Pydantic’s to_json method.

Parameters:

indent (int | None) – Indentation to use in the JSON output. If None is passed, the output will be compact.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to include in the JSON output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to exclude from the JSON output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to serialize using field aliases.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A JSON string representation of the model.

property model_extra: dict[str, Any] | None[source]

Get extra fields set during validation.

Returns:: A dictionary of extra fields, or None if config.extra is not set to "allow".

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=CurveGetType, required=True), 'type': FieldInfo(annotation=Literal['curve_get_type'], required=False, default='curve_get_type')}[source]

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

property model_fields_set: set[str][source]

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,: i.e. that were not filled from defaults.

classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')[source]

Generates a JSON schema for a model class.

Parameters:

by_alias (bool) – Whether to use attribute aliases or not.
ref_template (str) – The reference template.
schema_generator (type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modifications
mode (Literal['validation', 'serialization']) – The mode in which to generate the schema.

Return type:

Returns:

The JSON schema for the given model class.

classmethod model_parametrized_name(params)[source]

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

Parameters:: params (tuple[type[Any], ...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.
Return type:: str
Returns:: String representing the new class where params are passed to cls as type variables.
Raises:: TypeError – Raised when trying to generate concrete names for non-generic models.

model_post_init(_BaseModel__context)[source]

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

Return type:: None

classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)[source]

Try to rebuild the pydantic-core schema for the model.

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.

Parameters:

force (bool) – Whether to force the rebuilding of the model schema, defaults to False.
raise_errors (bool) – Whether to raise errors, defaults to True.
_parent_namespace_depth (int) – The depth level of the parent namespace, defaults to 2.
_types_namespace (dict[str, Any] | None) – The types namespace, defaults to None.

Return type:

Returns:

Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.

classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)[source]

Validate a pydantic model instance.

Parameters:

obj (Any) – The object to validate.
strict (bool | None) – Whether to enforce types strictly.
from_attributes (bool | None) – Whether to extract data from object attributes.
context (Any | None) – Additional context to pass to the validator.

Raises:

ValidationError – If the object could not be validated.

Return type:

Self

Returns:

The validated model instance.

classmethod model_validate_json(json_data, *, strict=None, context=None)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing

Validate the given JSON data against the Pydantic model.

Parameters:

json_data (str | bytes | bytearray) – The JSON data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

Raises:

ValidationError – If json_data is not a JSON string or the object could not be validated.

classmethod model_validate_strings(obj, *, strict=None, context=None)[source]

Validate the given object with string data against the Pydantic model.

Parameters:

obj (Any) – The object containing string data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod parse_obj(obj)[source]

Return type:: Self

classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod schema(by_alias=True, ref_template='#/$defs/{model}')[source]

Return type:: Dict[str, Any]

classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)[source]

Return type:: str

type: Literal['curve_get_type'][source]

classmethod update_forward_refs(**localns)[source]

Return type:: None

classmethod validate(value)[source]

Return type:: Self

class kittycad.models.ok_modeling_cmd_response.OptionCurveSetConstraint(**data)[source][source]

The response to the ‘CurveSetConstraint’ endpoint

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__abstractmethods__ = frozenset({})[source]

__annotations__ = {'__class_vars__': 'ClassVar[set[str]]', '__private_attributes__': 'ClassVar[Dict[str, ModelPrivateAttr]]', '__pydantic_complete__': 'ClassVar[bool]', '__pydantic_core_schema__': 'ClassVar[CoreSchema]', '__pydantic_custom_init__': 'ClassVar[bool]', '__pydantic_decorators__': 'ClassVar[_decorators.DecoratorInfos]', '__pydantic_extra__': 'dict[str, Any] | None', '__pydantic_fields_set__': 'set[str]', '__pydantic_generic_metadata__': 'ClassVar[_generics.PydanticGenericMetadata]', '__pydantic_parent_namespace__': 'ClassVar[Dict[str, Any] | None]', '__pydantic_post_init__': "ClassVar[None | Literal['model_post_init']]", '__pydantic_private__': 'dict[str, Any] | None', '__pydantic_root_model__': 'ClassVar[bool]', '__pydantic_serializer__': 'ClassVar[SchemaSerializer]', '__pydantic_validator__': 'ClassVar[SchemaValidator | PluggableSchemaValidator]', '__signature__': 'ClassVar[Signature]', 'data': <class 'kittycad.models.curve_set_constraint.CurveSetConstraint'>, 'model_computed_fields': 'ClassVar[Dict[str, ComputedFieldInfo]]', 'model_config': 'ClassVar[ConfigDict]', 'model_fields': 'ClassVar[Dict[str, FieldInfo]]', 'type': typing.Literal['curve_set_constraint']}[source]

classmethod __class_getitem__(typevar_values)[source]

Return type:: type[BaseModel] | PydanticRecursiveRef

__class_vars__: ClassVar[set[str]] = {}[source]: The names of the class variables defined on the model.

__copy__()[source]

Returns a shallow copy of the model.

Return type:: Self

__deepcopy__(memo=None)[source]

Returns a deep copy of the model.

Return type:: Self

__delattr__(item)[source]

Implement delattr(self, name).

Return type:: Any

__dict__[source]

__eq__(other)[source]

Return self==value.

Return type:: bool

property __fields_set__: set[str][source]

classmethod __get_pydantic_core_schema__(source, handler, /)[source]

Hook into generating the model’s CoreSchema.

Parameters:

source (type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.
handler (GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.

Return type:

Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]

Returns:

A pydantic-core CoreSchema.

classmethod __get_pydantic_json_schema__(core_schema, handler, /)[source]

Hook into generating the model’s JSON schema.

Parameters:

core_schema (Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({'type': 'nullable', 'schema': current_schema}), or just call the handler with the original schema.
handler (GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.

Return type:

Returns:

A JSON schema, as a Python object.

__getattr__(item)[source]

Return type:: Any

__getstate__()[source]

Helper for pickle.

Return type:: dict[Any, Any]

__hash__ = None[source]

__init__(**data)[source]

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__iter__()[source]

So dict(model) works.

Return type:: Generator[Tuple[str, Any], None, None]

__module__ = 'kittycad.models.ok_modeling_cmd_response'[source]

__pretty__(fmt, **kwargs)[source]

Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.

Return type:: Generator[Any, None, None]

__private_attributes__: ClassVar[Dict[str, ModelPrivateAttr]] = {}[source]: Metadata about the private attributes of the model.

__pydantic_complete__: ClassVar[bool] = True[source]: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__: ClassVar[CoreSchema] = {'cls': <class 'kittycad.models.ok_modeling_cmd_response.OptionCurveSetConstraint'>, 'config': {'title': 'OptionCurveSetConstraint'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.ok_modeling_cmd_response.OptionCurveSetConstraint'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.ok_modeling_cmd_response.OptionCurveSetConstraint'>>]}, 'ref': 'kittycad.models.ok_modeling_cmd_response.OptionCurveSetConstraint:94667213027008', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'data': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.curve_set_constraint.CurveSetConstraint'>, 'config': {'title': 'CurveSetConstraint'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.curve_set_constraint.CurveSetConstraint'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.curve_set_constraint.CurveSetConstraint'>>]}, 'ref': 'kittycad.models.curve_set_constraint.CurveSetConstraint:94667192150176', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {}, 'model_name': 'CurveSetConstraint', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}, 'type': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': 'curve_set_constraint', 'schema': {'expected': ['curve_set_constraint'], 'type': 'literal'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'OptionCurveSetConstraint', 'type': 'model-fields'}, 'type': 'model'}[source]: The core schema of the model.

__pydantic_custom_init__: ClassVar[bool] = False[source]: Whether the model has a custom __init__ method.

__pydantic_decorators__: ClassVar[_decorators.DecoratorInfos] = DecoratorInfos(validators={}, field_validators={}, root_validators={}, field_serializers={}, model_serializers={}, model_validators={}, computed_fields={})[source]: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_extra__: dict[str, Any] | None[source]: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to 'allow'.

__pydantic_fields_set__: set[str][source]: The names of fields explicitly set during instantiation.

__pydantic_generic_metadata__: ClassVar[_generics.PydanticGenericMetadata] = {'args': (), 'origin': None, 'parameters': ()}[source]: 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.

classmethod __pydantic_init_subclass__(**kwargs)[source]

This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.

This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.

This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.

Parameters:: **kwargs (Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.
Return type:: None

__pydantic_parent_namespace__: ClassVar[Dict[str, Any] | None] = None[source]: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__: ClassVar[None | Literal['model_post_init']] = None[source]: The name of the post-init method for the model, if defined.

__pydantic_private__: dict[str, Any] | None[source]: Values of private attributes set on the model instance.

__pydantic_root_model__: ClassVar[bool] = False[source]: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__: ClassVar[SchemaSerializer] = SchemaSerializer(serializer=Model( ModelSerializer { class: Py( 0x000056196d9ab6c0, ), serializer: Fields( GeneralFieldsSerializer { fields: { "data": SerField { key_py: Py( 0x00007f9038238fa0, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196c5c28a0, ), serializer: Fields( GeneralFieldsSerializer { fields: {}, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 0, }, ), has_extra: false, root_model: false, name: "CurveSetConstraint", }, ), ), required: true, }, "type": SerField { key_py: Py( 0x00007f903823d958, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f90346d53b0, ), ), serializer: Literal( LiteralSerializer { expected_int: {}, expected_str: { "curve_set_constraint", }, expected_py: None, name: "literal['curve_set_constraint']", }, ), }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "OptionCurveSetConstraint", }, ), definitions=[])[source]: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__: ClassVar[SchemaValidator | PluggableSchemaValidator] = SchemaValidator(title="OptionCurveSetConstraint", validator=Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "data", lookup_key: Simple { key: "data", py_key: Py( 0x00007f90334d6eb0, ), path: LookupPath( [ S( "data", Py( 0x00007f90334d6b20, ), ), ], ), }, name_py: Py( 0x00007f9038238fa0, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [], model_name: "CurveSetConstraint", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196c5c28a0, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "CurveSetConstraint", }, ), frozen: false, }, Field { name: "type", lookup_key: Simple { key: "type", py_key: Py( 0x00007f90334d6bb0, ), path: LookupPath( [ S( "type", Py( 0x00007f90334d6a60, ), ), ], ), }, name_py: Py( 0x00007f903823d958, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f90346d53b0, ), ), on_error: Raise, validator: Literal( LiteralValidator { lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "curve_set_constraint": 0, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f90346d53b0, ), ], }, expected_repr: "'curve_set_constraint'", name: "literal['curve_set_constraint']", }, ), validate_default: false, copy_default: false, name: "default[literal['curve_set_constraint']]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "OptionCurveSetConstraint", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d9ab6c0, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "OptionCurveSetConstraint", }, ), definitions=[], cache_strings=True)[source]: The pydantic-core SchemaValidator used to validate instances of the model.

__repr__()[source]

Return repr(self).

Return type:: str

__repr_args__()[source]

Return type:: Iterable[tuple[str | None, Any]]

__repr_name__()[source]

Name of the instance’s class, used in __repr__.

Return type:: str

__repr_str__(join_str)[source]

Return type:: str

__rich_repr__()[source]

Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.

Return type:: Iterable[Any | tuple[Any] | tuple[str, Any] | tuple[str, Any, Any]]

__setattr__(name, value)[source]

Implement setattr(self, name, value).

Return type:: None

__setstate__(state)[source]

Return type:: None

__signature__: ClassVar[Signature] = <Signature (*, data: kittycad.models.curve_set_constraint.CurveSetConstraint, type: Literal['curve_set_constraint'] = 'curve_set_constraint') -> None>[source]: The synthesized __init__ [Signature][inspect.Signature] of the model.

__slots__ = ('__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__')[source]

__str__()[source]

Return str(self).

Return type:: str

_abc_impl = <_abc._abc_data object>[source]

_calculate_keys(*args, **kwargs)[source]

Return type:: Any

_check_frozen(name, value)[source]

Return type:: None

_copy_and_set_values(*args, **kwargs)[source]

Return type:: Any

classmethod _get_value(*args, **kwargs)[source]

Return type:: Any

_iter(*args, **kwargs)[source]

Return type:: Any

classmethod construct(_fields_set=None, **values)[source]

Return type:: Self

copy(*, include=None, exclude=None, update=None, deep=False)[source]

Returns a copy of the model.

!!! warning “Deprecated”: This method is now deprecated; use model_copy instead.

If you need include or exclude, use:

`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `

Parameters:

include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.

Returns:

A copy of the model with included, excluded and updated fields as specified.

data: CurveSetConstraint[source]

dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)[source]

Return type:: Dict[str, Any]

classmethod from_orm(obj)[source]

Return type:: Self

json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)[source]

Return type:: str

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}[source]: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'protected_namespaces': ()}[source]: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod model_construct(_fields_set=None, **values)[source]

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note: model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == 'allow', then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == 'ignore' (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == 'forbid' does not result in an error if extra values are passed, but they will be ignored.

Parameters:

_fields_set (set[str] | None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.
values (Any) – Trusted or pre-validated data dictionary.

Return type:

Self

Returns:

A new instance of the Model class with validated data.

model_copy(*, update=None, deep=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy

Returns a copy of the model.

Parameters:

update (dict[str, Any] | None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.
deep (bool) – Set to True to make a deep copy of the model.

Return type:

Self

Returns:

New model instance.

model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters:

mode (Union[Literal['json', 'python'], str]) – The mode in which to_python 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.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to include in the output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to exclude from the output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to use the field’s alias in the dictionary key if defined.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A dictionary representation of the model.

model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

Generates a JSON representation of the model using Pydantic’s to_json method.

Parameters:

indent (int | None) – Indentation to use in the JSON output. If None is passed, the output will be compact.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to include in the JSON output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to exclude from the JSON output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to serialize using field aliases.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A JSON string representation of the model.

property model_extra: dict[str, Any] | None[source]

Get extra fields set during validation.

Returns:: A dictionary of extra fields, or None if config.extra is not set to "allow".

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=CurveSetConstraint, required=True), 'type': FieldInfo(annotation=Literal['curve_set_constraint'], required=False, default='curve_set_constraint')}[source]

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

property model_fields_set: set[str][source]

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,: i.e. that were not filled from defaults.

classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')[source]

Generates a JSON schema for a model class.

Parameters:

by_alias (bool) – Whether to use attribute aliases or not.
ref_template (str) – The reference template.
schema_generator (type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modifications
mode (Literal['validation', 'serialization']) – The mode in which to generate the schema.

Return type:

Returns:

The JSON schema for the given model class.

classmethod model_parametrized_name(params)[source]

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

Parameters:: params (tuple[type[Any], ...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.
Return type:: str
Returns:: String representing the new class where params are passed to cls as type variables.
Raises:: TypeError – Raised when trying to generate concrete names for non-generic models.

model_post_init(_BaseModel__context)[source]

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

Return type:: None

classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)[source]

Try to rebuild the pydantic-core schema for the model.

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.

Parameters:

force (bool) – Whether to force the rebuilding of the model schema, defaults to False.
raise_errors (bool) – Whether to raise errors, defaults to True.
_parent_namespace_depth (int) – The depth level of the parent namespace, defaults to 2.
_types_namespace (dict[str, Any] | None) – The types namespace, defaults to None.

Return type:

Returns:

Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.

classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)[source]

Validate a pydantic model instance.

Parameters:

obj (Any) – The object to validate.
strict (bool | None) – Whether to enforce types strictly.
from_attributes (bool | None) – Whether to extract data from object attributes.
context (Any | None) – Additional context to pass to the validator.

Raises:

ValidationError – If the object could not be validated.

Return type:

Self

Returns:

The validated model instance.

classmethod model_validate_json(json_data, *, strict=None, context=None)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing

Validate the given JSON data against the Pydantic model.

Parameters:

json_data (str | bytes | bytearray) – The JSON data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

Raises:

ValidationError – If json_data is not a JSON string or the object could not be validated.

classmethod model_validate_strings(obj, *, strict=None, context=None)[source]

Validate the given object with string data against the Pydantic model.

Parameters:

obj (Any) – The object containing string data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod parse_obj(obj)[source]

Return type:: Self

classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod schema(by_alias=True, ref_template='#/$defs/{model}')[source]

Return type:: Dict[str, Any]

classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)[source]

Return type:: str

type: Literal['curve_set_constraint'][source]

classmethod update_forward_refs(**localns)[source]

Return type:: None

classmethod validate(value)[source]

Return type:: Self

class kittycad.models.ok_modeling_cmd_response.OptionDefaultCameraFocusOn(**data)[source][source]

The response to the ‘DefaultCameraFocusOn’ endpoint

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__abstractmethods__ = frozenset({})[source]

__annotations__ = {'__class_vars__': 'ClassVar[set[str]]', '__private_attributes__': 'ClassVar[Dict[str, ModelPrivateAttr]]', '__pydantic_complete__': 'ClassVar[bool]', '__pydantic_core_schema__': 'ClassVar[CoreSchema]', '__pydantic_custom_init__': 'ClassVar[bool]', '__pydantic_decorators__': 'ClassVar[_decorators.DecoratorInfos]', '__pydantic_extra__': 'dict[str, Any] | None', '__pydantic_fields_set__': 'set[str]', '__pydantic_generic_metadata__': 'ClassVar[_generics.PydanticGenericMetadata]', '__pydantic_parent_namespace__': 'ClassVar[Dict[str, Any] | None]', '__pydantic_post_init__': "ClassVar[None | Literal['model_post_init']]", '__pydantic_private__': 'dict[str, Any] | None', '__pydantic_root_model__': 'ClassVar[bool]', '__pydantic_serializer__': 'ClassVar[SchemaSerializer]', '__pydantic_validator__': 'ClassVar[SchemaValidator | PluggableSchemaValidator]', '__signature__': 'ClassVar[Signature]', 'data': <class 'kittycad.models.default_camera_focus_on.DefaultCameraFocusOn'>, 'model_computed_fields': 'ClassVar[Dict[str, ComputedFieldInfo]]', 'model_config': 'ClassVar[ConfigDict]', 'model_fields': 'ClassVar[Dict[str, FieldInfo]]', 'type': typing.Literal['default_camera_focus_on']}[source]

classmethod __class_getitem__(typevar_values)[source]

Return type:: type[BaseModel] | PydanticRecursiveRef

__class_vars__: ClassVar[set[str]] = {}[source]: The names of the class variables defined on the model.

__copy__()[source]

Returns a shallow copy of the model.

Return type:: Self

__deepcopy__(memo=None)[source]

Returns a deep copy of the model.

Return type:: Self

__delattr__(item)[source]

Implement delattr(self, name).

Return type:: Any

__dict__[source]

__eq__(other)[source]

Return self==value.

Return type:: bool

property __fields_set__: set[str][source]

classmethod __get_pydantic_core_schema__(source, handler, /)[source]

Hook into generating the model’s CoreSchema.

Parameters:

source (type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.
handler (GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.

Return type:

Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]

Returns:

A pydantic-core CoreSchema.

classmethod __get_pydantic_json_schema__(core_schema, handler, /)[source]

Hook into generating the model’s JSON schema.

Parameters:

core_schema (Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({'type': 'nullable', 'schema': current_schema}), or just call the handler with the original schema.
handler (GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.

Return type:

Returns:

A JSON schema, as a Python object.

__getattr__(item)[source]

Return type:: Any

__getstate__()[source]

Helper for pickle.

Return type:: dict[Any, Any]

__hash__ = None[source]

__init__(**data)[source]

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__iter__()[source]

So dict(model) works.

Return type:: Generator[Tuple[str, Any], None, None]

__module__ = 'kittycad.models.ok_modeling_cmd_response'[source]

__pretty__(fmt, **kwargs)[source]

Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.

Return type:: Generator[Any, None, None]

__private_attributes__: ClassVar[Dict[str, ModelPrivateAttr]] = {}[source]: Metadata about the private attributes of the model.

__pydantic_complete__: ClassVar[bool] = True[source]: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__: ClassVar[CoreSchema] = {'cls': <class 'kittycad.models.ok_modeling_cmd_response.OptionDefaultCameraFocusOn'>, 'config': {'title': 'OptionDefaultCameraFocusOn'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.ok_modeling_cmd_response.OptionDefaultCameraFocusOn'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.ok_modeling_cmd_response.OptionDefaultCameraFocusOn'>>]}, 'ref': 'kittycad.models.ok_modeling_cmd_response.OptionDefaultCameraFocusOn:94667213565696', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'data': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.default_camera_focus_on.DefaultCameraFocusOn'>, 'config': {'title': 'DefaultCameraFocusOn'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.default_camera_focus_on.DefaultCameraFocusOn'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.default_camera_focus_on.DefaultCameraFocusOn'>>]}, 'ref': 'kittycad.models.default_camera_focus_on.DefaultCameraFocusOn:94667205964560', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {}, 'model_name': 'DefaultCameraFocusOn', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}, 'type': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': 'default_camera_focus_on', 'schema': {'expected': ['default_camera_focus_on'], 'type': 'literal'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'OptionDefaultCameraFocusOn', 'type': 'model-fields'}, 'type': 'model'}[source]: The core schema of the model.

__pydantic_custom_init__: ClassVar[bool] = False[source]: Whether the model has a custom __init__ method.

__pydantic_decorators__: ClassVar[_decorators.DecoratorInfos] = DecoratorInfos(validators={}, field_validators={}, root_validators={}, field_serializers={}, model_serializers={}, model_validators={}, computed_fields={})[source]: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_extra__: dict[str, Any] | None[source]: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to 'allow'.

__pydantic_fields_set__: set[str][source]: The names of fields explicitly set during instantiation.

__pydantic_generic_metadata__: ClassVar[_generics.PydanticGenericMetadata] = {'args': (), 'origin': None, 'parameters': ()}[source]: 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.

classmethod __pydantic_init_subclass__(**kwargs)[source]

This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.

This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.

This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.

Parameters:: **kwargs (Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.
Return type:: None

__pydantic_parent_namespace__: ClassVar[Dict[str, Any] | None] = None[source]: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__: ClassVar[None | Literal['model_post_init']] = None[source]: The name of the post-init method for the model, if defined.

__pydantic_private__: dict[str, Any] | None[source]: Values of private attributes set on the model instance.

__pydantic_root_model__: ClassVar[bool] = False[source]: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__: ClassVar[SchemaSerializer] = SchemaSerializer(serializer=Model( ModelSerializer { class: Py( 0x000056196da2ef00, ), serializer: Fields( GeneralFieldsSerializer { fields: { "type": SerField { key_py: Py( 0x00007f903823d958, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f90346d58f0, ), ), serializer: Literal( LiteralSerializer { expected_int: {}, expected_str: { "default_camera_focus_on", }, expected_py: None, name: "literal['default_camera_focus_on']", }, ), }, ), ), required: true, }, "data": SerField { key_py: Py( 0x00007f9038238fa0, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196d2ef310, ), serializer: Fields( GeneralFieldsSerializer { fields: {}, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 0, }, ), has_extra: false, root_model: false, name: "DefaultCameraFocusOn", }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "OptionDefaultCameraFocusOn", }, ), definitions=[])[source]: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__: ClassVar[SchemaValidator | PluggableSchemaValidator] = SchemaValidator(title="OptionDefaultCameraFocusOn", validator=Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "data", lookup_key: Simple { key: "data", py_key: Py( 0x00007f903336d5c0, ), path: LookupPath( [ S( "data", Py( 0x00007f903336d5f0, ), ), ], ), }, name_py: Py( 0x00007f9038238fa0, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [], model_name: "DefaultCameraFocusOn", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d2ef310, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "DefaultCameraFocusOn", }, ), frozen: false, }, Field { name: "type", lookup_key: Simple { key: "type", py_key: Py( 0x00007f903336d620, ), path: LookupPath( [ S( "type", Py( 0x00007f903336d650, ), ), ], ), }, name_py: Py( 0x00007f903823d958, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f90346d58f0, ), ), on_error: Raise, validator: Literal( LiteralValidator { lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "default_camera_focus_on": 0, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f90346d58f0, ), ], }, expected_repr: "'default_camera_focus_on'", name: "literal['default_camera_focus_on']", }, ), validate_default: false, copy_default: false, name: "default[literal['default_camera_focus_on']]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "OptionDefaultCameraFocusOn", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196da2ef00, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "OptionDefaultCameraFocusOn", }, ), definitions=[], cache_strings=True)[source]: The pydantic-core SchemaValidator used to validate instances of the model.

__repr__()[source]

Return repr(self).

Return type:: str

__repr_args__()[source]

Return type:: Iterable[tuple[str | None, Any]]

__repr_name__()[source]

Name of the instance’s class, used in __repr__.

Return type:: str

__repr_str__(join_str)[source]

Return type:: str

__rich_repr__()[source]

Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.

Return type:: Iterable[Any | tuple[Any] | tuple[str, Any] | tuple[str, Any, Any]]

__setattr__(name, value)[source]

Implement setattr(self, name, value).

Return type:: None

__setstate__(state)[source]

Return type:: None

__signature__: ClassVar[Signature] = <Signature (*, data: kittycad.models.default_camera_focus_on.DefaultCameraFocusOn, type: Literal['default_camera_focus_on'] = 'default_camera_focus_on') -> None>[source]: The synthesized __init__ [Signature][inspect.Signature] of the model.

__slots__ = ('__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__')[source]

__str__()[source]

Return str(self).

Return type:: str

_abc_impl = <_abc._abc_data object>[source]

_calculate_keys(*args, **kwargs)[source]

Return type:: Any

_check_frozen(name, value)[source]

Return type:: None

_copy_and_set_values(*args, **kwargs)[source]

Return type:: Any

classmethod _get_value(*args, **kwargs)[source]

Return type:: Any

_iter(*args, **kwargs)[source]

Return type:: Any

classmethod construct(_fields_set=None, **values)[source]

Return type:: Self

copy(*, include=None, exclude=None, update=None, deep=False)[source]

Returns a copy of the model.

!!! warning “Deprecated”: This method is now deprecated; use model_copy instead.

If you need include or exclude, use:

`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `

Parameters:

include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.

Returns:

A copy of the model with included, excluded and updated fields as specified.

data: DefaultCameraFocusOn[source]

dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)[source]

Return type:: Dict[str, Any]

classmethod from_orm(obj)[source]

Return type:: Self

json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)[source]

Return type:: str

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}[source]: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'protected_namespaces': ()}[source]: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod model_construct(_fields_set=None, **values)[source]

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note: model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == 'allow', then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == 'ignore' (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == 'forbid' does not result in an error if extra values are passed, but they will be ignored.

Parameters:

_fields_set (set[str] | None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.
values (Any) – Trusted or pre-validated data dictionary.

Return type:

Self

Returns:

A new instance of the Model class with validated data.

model_copy(*, update=None, deep=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy

Returns a copy of the model.

Parameters:

update (dict[str, Any] | None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.
deep (bool) – Set to True to make a deep copy of the model.

Return type:

Self

Returns:

New model instance.

model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters:

mode (Union[Literal['json', 'python'], str]) – The mode in which to_python 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.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to include in the output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to exclude from the output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to use the field’s alias in the dictionary key if defined.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A dictionary representation of the model.

model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

Generates a JSON representation of the model using Pydantic’s to_json method.

Parameters:

indent (int | None) – Indentation to use in the JSON output. If None is passed, the output will be compact.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to include in the JSON output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to exclude from the JSON output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to serialize using field aliases.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A JSON string representation of the model.

property model_extra: dict[str, Any] | None[source]

Get extra fields set during validation.

Returns:: A dictionary of extra fields, or None if config.extra is not set to "allow".

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=DefaultCameraFocusOn, required=True), 'type': FieldInfo(annotation=Literal['default_camera_focus_on'], required=False, default='default_camera_focus_on')}[source]

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

property model_fields_set: set[str][source]

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,: i.e. that were not filled from defaults.

classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')[source]

Generates a JSON schema for a model class.

Parameters:

by_alias (bool) – Whether to use attribute aliases or not.
ref_template (str) – The reference template.
schema_generator (type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modifications
mode (Literal['validation', 'serialization']) – The mode in which to generate the schema.

Return type:

Returns:

The JSON schema for the given model class.

classmethod model_parametrized_name(params)[source]

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

Parameters:: params (tuple[type[Any], ...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.
Return type:: str
Returns:: String representing the new class where params are passed to cls as type variables.
Raises:: TypeError – Raised when trying to generate concrete names for non-generic models.

model_post_init(_BaseModel__context)[source]

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

Return type:: None

classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)[source]

Try to rebuild the pydantic-core schema for the model.

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.

Parameters:

force (bool) – Whether to force the rebuilding of the model schema, defaults to False.
raise_errors (bool) – Whether to raise errors, defaults to True.
_parent_namespace_depth (int) – The depth level of the parent namespace, defaults to 2.
_types_namespace (dict[str, Any] | None) – The types namespace, defaults to None.

Return type:

Returns:

Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.

classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)[source]

Validate a pydantic model instance.

Parameters:

obj (Any) – The object to validate.
strict (bool | None) – Whether to enforce types strictly.
from_attributes (bool | None) – Whether to extract data from object attributes.
context (Any | None) – Additional context to pass to the validator.

Raises:

ValidationError – If the object could not be validated.

Return type:

Self

Returns:

The validated model instance.

classmethod model_validate_json(json_data, *, strict=None, context=None)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing

Validate the given JSON data against the Pydantic model.

Parameters:

json_data (str | bytes | bytearray) – The JSON data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

Raises:

ValidationError – If json_data is not a JSON string or the object could not be validated.

classmethod model_validate_strings(obj, *, strict=None, context=None)[source]

Validate the given object with string data against the Pydantic model.

Parameters:

obj (Any) – The object containing string data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod parse_obj(obj)[source]

Return type:: Self

classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod schema(by_alias=True, ref_template='#/$defs/{model}')[source]

Return type:: Dict[str, Any]

classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)[source]

Return type:: str

type: Literal['default_camera_focus_on'][source]

classmethod update_forward_refs(**localns)[source]

Return type:: None

classmethod validate(value)[source]

Return type:: Self

class kittycad.models.ok_modeling_cmd_response.OptionDefaultCameraGetSettings(**data)[source][source]

The response to the ‘DefaultCameraGetSettings’ endpoint

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__abstractmethods__ = frozenset({})[source]

__annotations__ = {'__class_vars__': 'ClassVar[set[str]]', '__private_attributes__': 'ClassVar[Dict[str, ModelPrivateAttr]]', '__pydantic_complete__': 'ClassVar[bool]', '__pydantic_core_schema__': 'ClassVar[CoreSchema]', '__pydantic_custom_init__': 'ClassVar[bool]', '__pydantic_decorators__': 'ClassVar[_decorators.DecoratorInfos]', '__pydantic_extra__': 'dict[str, Any] | None', '__pydantic_fields_set__': 'set[str]', '__pydantic_generic_metadata__': 'ClassVar[_generics.PydanticGenericMetadata]', '__pydantic_parent_namespace__': 'ClassVar[Dict[str, Any] | None]', '__pydantic_post_init__': "ClassVar[None | Literal['model_post_init']]", '__pydantic_private__': 'dict[str, Any] | None', '__pydantic_root_model__': 'ClassVar[bool]', '__pydantic_serializer__': 'ClassVar[SchemaSerializer]', '__pydantic_validator__': 'ClassVar[SchemaValidator | PluggableSchemaValidator]', '__signature__': 'ClassVar[Signature]', 'data': <class 'kittycad.models.default_camera_get_settings.DefaultCameraGetSettings'>, 'model_computed_fields': 'ClassVar[Dict[str, ComputedFieldInfo]]', 'model_config': 'ClassVar[ConfigDict]', 'model_fields': 'ClassVar[Dict[str, FieldInfo]]', 'type': typing.Literal['default_camera_get_settings']}[source]

classmethod __class_getitem__(typevar_values)[source]

Return type:: type[BaseModel] | PydanticRecursiveRef

__class_vars__: ClassVar[set[str]] = {}[source]: The names of the class variables defined on the model.

__copy__()[source]

Returns a shallow copy of the model.

Return type:: Self

__deepcopy__(memo=None)[source]

Returns a deep copy of the model.

Return type:: Self

__delattr__(item)[source]

Implement delattr(self, name).

Return type:: Any

__dict__[source]

__eq__(other)[source]

Return self==value.

Return type:: bool

property __fields_set__: set[str][source]

classmethod __get_pydantic_core_schema__(source, handler, /)[source]

Hook into generating the model’s CoreSchema.

Parameters:

source (type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.
handler (GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.

Return type:

Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]

Returns:

A pydantic-core CoreSchema.

classmethod __get_pydantic_json_schema__(core_schema, handler, /)[source]

Hook into generating the model’s JSON schema.

Parameters:

core_schema (Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({'type': 'nullable', 'schema': current_schema}), or just call the handler with the original schema.
handler (GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.

Return type:

Returns:

A JSON schema, as a Python object.

__getattr__(item)[source]

Return type:: Any

__getstate__()[source]

Helper for pickle.

Return type:: dict[Any, Any]

__hash__ = None[source]

__init__(**data)[source]

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__iter__()[source]

So dict(model) works.

Return type:: Generator[Tuple[str, Any], None, None]

__module__ = 'kittycad.models.ok_modeling_cmd_response'[source]

__pretty__(fmt, **kwargs)[source]

Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.

Return type:: Generator[Any, None, None]

__private_attributes__: ClassVar[Dict[str, ModelPrivateAttr]] = {}[source]: Metadata about the private attributes of the model.

__pydantic_complete__: ClassVar[bool] = True[source]: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__: ClassVar[CoreSchema] = {'definitions': [{'cls': <class 'kittycad.models.point3d.Point3d'>, 'config': {'title': 'Point3d'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.point3d.Point3d'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.point3d.Point3d'>>]}, 'ref': 'kittycad.models.point3d.Point3d:94667194426368', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'x': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'type': 'float'}, 'type': 'model-field'}, 'y': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'type': 'float'}, 'type': 'model-field'}, 'z': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'type': 'float'}, 'type': 'model-field'}}, 'model_name': 'Point3d', 'type': 'model-fields'}, 'type': 'model'}], 'schema': {'cls': <class 'kittycad.models.ok_modeling_cmd_response.OptionDefaultCameraGetSettings'>, 'config': {'title': 'OptionDefaultCameraGetSettings'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.ok_modeling_cmd_response.OptionDefaultCameraGetSettings'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.ok_modeling_cmd_response.OptionDefaultCameraGetSettings'>>]}, 'ref': 'kittycad.models.ok_modeling_cmd_response.OptionDefaultCameraGetSettings:94667213379456', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'data': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.default_camera_get_settings.DefaultCameraGetSettings'>, 'config': {'title': 'DefaultCameraGetSettings'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.default_camera_get_settings.DefaultCameraGetSettings'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.default_camera_get_settings.DefaultCameraGetSettings'>>]}, 'ref': 'kittycad.models.default_camera_get_settings.DefaultCameraGetSettings:94667205969328', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'settings': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.camera_settings.CameraSettings'>, 'config': {'title': 'CameraSettings'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.camera_settings.CameraSettings'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.camera_settings.CameraSettings'>>]}, 'ref': 'kittycad.models.camera_settings.CameraSettings:94667204631840', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'center': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'schema_ref': 'kittycad.models.point3d.Point3d:94667194426368', 'type': 'definition-ref'}, 'type': 'model-field'}, 'fov_y': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': None, 'schema': {'schema': {'type': 'float'}, 'type': 'nullable'}, 'type': 'default'}, 'type': 'model-field'}, 'orientation': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.point4d.Point4d'>, 'config': {'title': 'Point4d'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.point4d.Point4d'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.point4d.Point4d'>>]}, 'ref': 'kittycad.models.point4d.Point4d:94667204627760', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'w': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'type': 'float'}, 'type': 'model-field'}, 'x': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'type': 'float'}, 'type': 'model-field'}, 'y': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'type': 'float'}, 'type': 'model-field'}, 'z': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'type': 'float'}, 'type': 'model-field'}}, 'model_name': 'Point4d', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}, 'ortho': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'type': 'bool'}, 'type': 'model-field'}, 'ortho_scale': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': None, 'schema': {'schema': {'type': 'float'}, 'type': 'nullable'}, 'type': 'default'}, 'type': 'model-field'}, 'pos': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'schema_ref': 'kittycad.models.point3d.Point3d:94667194426368', 'type': 'definition-ref'}, 'type': 'model-field'}, 'up': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'schema_ref': 'kittycad.models.point3d.Point3d:94667194426368', 'type': 'definition-ref'}, 'type': 'model-field'}}, 'model_name': 'CameraSettings', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}}, 'model_name': 'DefaultCameraGetSettings', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}, 'type': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': 'default_camera_get_settings', 'schema': {'expected': ['default_camera_get_settings'], 'type': 'literal'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'OptionDefaultCameraGetSettings', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'definitions'}[source]: The core schema of the model.

__pydantic_custom_init__: ClassVar[bool] = False[source]: Whether the model has a custom __init__ method.

__pydantic_decorators__: ClassVar[_decorators.DecoratorInfos] = DecoratorInfos(validators={}, field_validators={}, root_validators={}, field_serializers={}, model_serializers={}, model_validators={}, computed_fields={})[source]: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_extra__: dict[str, Any] | None[source]: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to 'allow'.

__pydantic_fields_set__: set[str][source]: The names of fields explicitly set during instantiation.

__pydantic_generic_metadata__: ClassVar[_generics.PydanticGenericMetadata] = {'args': (), 'origin': None, 'parameters': ()}[source]: 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.

classmethod __pydantic_init_subclass__(**kwargs)[source]

This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.

This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.

This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.

Parameters:: **kwargs (Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.
Return type:: None

__pydantic_parent_namespace__: ClassVar[Dict[str, Any] | None] = None[source]: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__: ClassVar[None | Literal['model_post_init']] = None[source]: The name of the post-init method for the model, if defined.

__pydantic_private__: dict[str, Any] | None[source]: Values of private attributes set on the model instance.

__pydantic_root_model__: ClassVar[bool] = False[source]: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__: ClassVar[SchemaSerializer] = SchemaSerializer(serializer=Model( ModelSerializer { class: Py( 0x000056196da01780, ), serializer: Fields( GeneralFieldsSerializer { fields: { "type": SerField { key_py: Py( 0x00007f903823d958, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f9034696330, ), ), serializer: Literal( LiteralSerializer { expected_int: {}, expected_str: { "default_camera_get_settings", }, expected_py: None, name: "literal['default_camera_get_settings']", }, ), }, ), ), required: true, }, "data": SerField { key_py: Py( 0x00007f9038238fa0, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196d2f05b0, ), serializer: Fields( GeneralFieldsSerializer { fields: { "settings": SerField { key_py: Py( 0x00007f903711fa30, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196d1a9d20, ), serializer: Fields( GeneralFieldsSerializer { fields: { "pos": SerField { key_py: Py( 0x00007f903823c150, ), alias: None, alias_py: None, serializer: Some( Recursive( DefinitionRefSerializer { definition: "...", retry_with_lax_check: true, }, ), ), required: true, }, "center": SerField { key_py: Py( 0x00007f9037b08150, ), alias: None, alias_py: None, serializer: Some( Recursive( DefinitionRefSerializer { definition: "...", retry_with_lax_check: true, }, ), ), required: true, }, "ortho_scale": SerField { key_py: Py( 0x00007f9033c27eb0, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f9038148100, ), ), serializer: Nullable( NullableSerializer { serializer: Float( FloatSerializer { inf_nan_mode: Null, }, ), }, ), }, ), ), required: true, }, "ortho": SerField { key_py: Py( 0x00007f9033e16550, ), alias: None, alias_py: None, serializer: Some( Bool( BoolSerializer, ), ), required: true, }, "up": SerField { key_py: Py( 0x00007f9036ff7720, ), alias: None, alias_py: None, serializer: Some( Recursive( DefinitionRefSerializer { definition: "...", retry_with_lax_check: true, }, ), ), required: true, }, "fov_y": SerField { key_py: Py( 0x00007f9033e16400, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f9038148100, ), ), serializer: Nullable( NullableSerializer { serializer: Float( FloatSerializer { inf_nan_mode: Null, }, ), }, ), }, ), ), required: true, }, "orientation": SerField { key_py: Py( 0x00007f9033c27ef0, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196d1a8d30, ), serializer: Fields( GeneralFieldsSerializer { fields: { "w": SerField { key_py: Py( 0x00007f903823f4f8, ), alias: None, alias_py: None, serializer: Some( Float( FloatSerializer { inf_nan_mode: Null, }, ), ), required: true, }, "x": SerField { key_py: Py( 0x00007f903823de18, ), alias: None, alias_py: None, serializer: Some( Float( FloatSerializer { inf_nan_mode: Null, }, ), ), required: true, }, "y": SerField { key_py: Py( 0x00007f903823f558, ), alias: None, alias_py: None, serializer: Some( Float( FloatSerializer { inf_nan_mode: Null, }, ), ), required: true, }, "z": SerField { key_py: Py( 0x00007f903823f588, ), alias: None, alias_py: None, serializer: Some( Float( FloatSerializer { inf_nan_mode: Null, }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 4, }, ), has_extra: false, root_model: false, name: "Point4d", }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 7, }, ), has_extra: false, root_model: false, name: "CameraSettings", }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 1, }, ), has_extra: false, root_model: false, name: "DefaultCameraGetSettings", }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "OptionDefaultCameraGetSettings", }, ), definitions=[Model(ModelSerializer { class: Py(0x56196c7ee400), serializer: Fields(GeneralFieldsSerializer { fields: {"y": SerField { key_py: Py(0x7f903823f558), alias: None, alias_py: None, serializer: Some(Float(FloatSerializer { inf_nan_mode: Null })), required: true }, "z": SerField { key_py: Py(0x7f903823f588), alias: None, alias_py: None, serializer: Some(Float(FloatSerializer { inf_nan_mode: Null })), required: true }, "x": SerField { key_py: Py(0x7f903823de18), alias: None, alias_py: None, serializer: Some(Float(FloatSerializer { inf_nan_mode: Null })), required: true }}, computed_fields: Some(ComputedFields([])), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None }, required_fields: 3 }), has_extra: false, root_model: false, name: "Point3d" })])[source]: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__: ClassVar[SchemaValidator | PluggableSchemaValidator] = SchemaValidator(title="OptionDefaultCameraGetSettings", validator=Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "data", lookup_key: Simple { key: "data", py_key: Py( 0x00007f9033522eb0, ), path: LookupPath( [ S( "data", Py( 0x00007f9033522d90, ), ), ], ), }, name_py: Py( 0x00007f9038238fa0, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "settings", lookup_key: Simple { key: "settings", py_key: Py( 0x00007f903336baf0, ), path: LookupPath( [ S( "settings", Py( 0x00007f903336bb30, ), ), ], ), }, name_py: Py( 0x00007f903711fa30, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "center", lookup_key: Simple { key: "center", py_key: Py( 0x00007f9033520e40, ), path: LookupPath( [ S( "center", Py( 0x00007f9033520d50, ), ), ], ), }, name_py: Py( 0x00007f9037b08150, ), validator: DefinitionRef( DefinitionRefValidator { definition: "...", }, ), frozen: false, }, Field { name: "fov_y", lookup_key: Simple { key: "fov_y", py_key: Py( 0x00007f90335223d0, ), path: LookupPath( [ S( "fov_y", Py( 0x00007f9033520f30, ), ), ], ), }, name_py: Py( 0x00007f9033e16400, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f9038148100, ), ), on_error: Raise, validator: Nullable( NullableValidator { validator: Float( FloatValidator { strict: false, allow_inf_nan: true, }, ), name: "nullable[float]", }, ), validate_default: false, copy_default: false, name: "default[nullable[float]]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, Field { name: "orientation", lookup_key: Simple { key: "orientation", py_key: Py( 0x00007f903336ba30, ), path: LookupPath( [ S( "orientation", Py( 0x00007f903336b9f0, ), ), ], ), }, name_py: Py( 0x00007f9033c27ef0, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "w", lookup_key: Simple { key: "w", py_key: Py( 0x00007f903823f4f8, ), path: LookupPath( [ S( "w", Py( 0x00007f903823f4f8, ), ), ], ), }, name_py: Py( 0x00007f903823f4f8, ), validator: Float( FloatValidator { strict: false, allow_inf_nan: true, }, ), frozen: false, }, Field { name: "x", lookup_key: Simple { key: "x", py_key: Py( 0x00007f903823f528, ), path: LookupPath( [ S( "x", Py( 0x00007f903823f528, ), ), ], ), }, name_py: Py( 0x00007f903823de18, ), validator: Float( FloatValidator { strict: false, allow_inf_nan: true, }, ), frozen: false, }, Field { name: "y", lookup_key: Simple { key: "y", py_key: Py( 0x00007f903823f558, ), path: LookupPath( [ S( "y", Py( 0x00007f903823f558, ), ), ], ), }, name_py: Py( 0x00007f903823f558, ), validator: Float( FloatValidator { strict: false, allow_inf_nan: true, }, ), frozen: false, }, Field { name: "z", lookup_key: Simple { key: "z", py_key: Py( 0x00007f903823f588, ), path: LookupPath( [ S( "z", Py( 0x00007f903823f588, ), ), ], ), }, name_py: Py( 0x00007f903823f588, ), validator: Float( FloatValidator { strict: false, allow_inf_nan: true, }, ), frozen: false, }, ], model_name: "Point4d", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d1a8d30, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "Point4d", }, ), frozen: false, }, Field { name: "ortho", lookup_key: Simple { key: "ortho", py_key: Py( 0x00007f90335227f0, ), path: LookupPath( [ S( "ortho", Py( 0x00007f9033522970, ), ), ], ), }, name_py: Py( 0x00007f9033e16550, ), validator: Bool( BoolValidator { strict: false, }, ), frozen: false, }, Field { name: "ortho_scale", lookup_key: Simple { key: "ortho_scale", py_key: Py( 0x00007f903336bab0, ), path: LookupPath( [ S( "ortho_scale", Py( 0x00007f903336ba70, ), ), ], ), }, name_py: Py( 0x00007f9033c27eb0, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f9038148100, ), ), on_error: Raise, validator: Nullable( NullableValidator { validator: Float( FloatValidator { strict: false, allow_inf_nan: true, }, ), name: "nullable[float]", }, ), validate_default: false, copy_default: false, name: "default[nullable[float]]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, Field { name: "pos", lookup_key: Simple { key: "pos", py_key: Py( 0x00007f9033522c10, ), path: LookupPath( [ S( "pos", Py( 0x00007f9033522c70, ), ), ], ), }, name_py: Py( 0x00007f903823c150, ), validator: DefinitionRef( DefinitionRefValidator { definition: "...", }, ), frozen: false, }, Field { name: "up", lookup_key: Simple { key: "up", py_key: Py( 0x00007f9033522ca0, ), path: LookupPath( [ S( "up", Py( 0x00007f90335225e0, ), ), ], ), }, name_py: Py( 0x00007f9036ff7720, ), validator: DefinitionRef( DefinitionRefValidator { definition: "...", }, ), frozen: false, }, ], model_name: "CameraSettings", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d1a9d20, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "CameraSettings", }, ), frozen: false, }, ], model_name: "DefaultCameraGetSettings", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d2f05b0, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "DefaultCameraGetSettings", }, ), frozen: false, }, Field { name: "type", lookup_key: Simple { key: "type", py_key: Py( 0x00007f9033522d60, ), path: LookupPath( [ S( "type", Py( 0x00007f9033522cd0, ), ), ], ), }, name_py: Py( 0x00007f903823d958, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f9034696330, ), ), on_error: Raise, validator: Literal( LiteralValidator { lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "default_camera_get_settings": 0, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f9034696330, ), ], }, expected_repr: "'default_camera_get_settings'", name: "literal['default_camera_get_settings']", }, ), validate_default: false, copy_default: false, name: "default[literal['default_camera_get_settings']]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "OptionDefaultCameraGetSettings", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196da01780, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "OptionDefaultCameraGetSettings", }, ), definitions=[Model(ModelValidator { revalidate: Never, validator: ModelFields(ModelFieldsValidator { fields: [Field { name: "x", lookup_key: Simple { key: "x", py_key: Py(0x7f903823f528), path: LookupPath([S("x", Py(0x7f903823f528))]) }, name_py: Py(0x7f903823de18), validator: Float(FloatValidator { strict: false, allow_inf_nan: true }), frozen: false }, Field { name: "y", lookup_key: Simple { key: "y", py_key: Py(0x7f903823f558), path: LookupPath([S("y", Py(0x7f903823f558))]) }, name_py: Py(0x7f903823f558), validator: Float(FloatValidator { strict: false, allow_inf_nan: true }), frozen: false }, Field { name: "z", lookup_key: Simple { key: "z", py_key: Py(0x7f903823f588), path: LookupPath([S("z", Py(0x7f903823f588))]) }, name_py: Py(0x7f903823f588), validator: Float(FloatValidator { strict: false, allow_inf_nan: true }), frozen: false }], model_name: "Point3d", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true }), class: Py(0x56196c7ee400), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py(0x7f903629a320), name: "Point3d" })], cache_strings=True)[source]: The pydantic-core SchemaValidator used to validate instances of the model.

__repr__()[source]

Return repr(self).

Return type:: str

__repr_args__()[source]

Return type:: Iterable[tuple[str | None, Any]]

__repr_name__()[source]

Name of the instance’s class, used in __repr__.

Return type:: str

__repr_str__(join_str)[source]

Return type:: str

__rich_repr__()[source]

Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.

Return type:: Iterable[Any | tuple[Any] | tuple[str, Any] | tuple[str, Any, Any]]

__setattr__(name, value)[source]

Implement setattr(self, name, value).

Return type:: None

__setstate__(state)[source]

Return type:: None

__signature__: ClassVar[Signature] = <Signature (*, data: kittycad.models.default_camera_get_settings.DefaultCameraGetSettings, type: Literal['default_camera_get_settings'] = 'default_camera_get_settings') -> None>[source]: The synthesized __init__ [Signature][inspect.Signature] of the model.

__slots__ = ('__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__')[source]

__str__()[source]

Return str(self).

Return type:: str

_abc_impl = <_abc._abc_data object>[source]

_calculate_keys(*args, **kwargs)[source]

Return type:: Any

_check_frozen(name, value)[source]

Return type:: None

_copy_and_set_values(*args, **kwargs)[source]

Return type:: Any

classmethod _get_value(*args, **kwargs)[source]

Return type:: Any

_iter(*args, **kwargs)[source]

Return type:: Any

classmethod construct(_fields_set=None, **values)[source]

Return type:: Self

copy(*, include=None, exclude=None, update=None, deep=False)[source]

Returns a copy of the model.

!!! warning “Deprecated”: This method is now deprecated; use model_copy instead.

If you need include or exclude, use:

`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `

Parameters:

include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.

Returns:

A copy of the model with included, excluded and updated fields as specified.

data: DefaultCameraGetSettings[source]

dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)[source]

Return type:: Dict[str, Any]

classmethod from_orm(obj)[source]

Return type:: Self

json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)[source]

Return type:: str

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}[source]: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'protected_namespaces': ()}[source]: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod model_construct(_fields_set=None, **values)[source]

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note: model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == 'allow', then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == 'ignore' (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == 'forbid' does not result in an error if extra values are passed, but they will be ignored.

Parameters:

_fields_set (set[str] | None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.
values (Any) – Trusted or pre-validated data dictionary.

Return type:

Self

Returns:

A new instance of the Model class with validated data.

model_copy(*, update=None, deep=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy

Returns a copy of the model.

Parameters:

update (dict[str, Any] | None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.
deep (bool) – Set to True to make a deep copy of the model.

Return type:

Self

Returns:

New model instance.

model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters:

mode (Union[Literal['json', 'python'], str]) – The mode in which to_python 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.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to include in the output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to exclude from the output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to use the field’s alias in the dictionary key if defined.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A dictionary representation of the model.

model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

Generates a JSON representation of the model using Pydantic’s to_json method.

Parameters:

indent (int | None) – Indentation to use in the JSON output. If None is passed, the output will be compact.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to include in the JSON output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to exclude from the JSON output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to serialize using field aliases.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A JSON string representation of the model.

property model_extra: dict[str, Any] | None[source]

Get extra fields set during validation.

Returns:: A dictionary of extra fields, or None if config.extra is not set to "allow".

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=DefaultCameraGetSettings, required=True), 'type': FieldInfo(annotation=Literal['default_camera_get_settings'], required=False, default='default_camera_get_settings')}[source]

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

property model_fields_set: set[str][source]

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,: i.e. that were not filled from defaults.

classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')[source]

Generates a JSON schema for a model class.

Parameters:

by_alias (bool) – Whether to use attribute aliases or not.
ref_template (str) – The reference template.
schema_generator (type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modifications
mode (Literal['validation', 'serialization']) – The mode in which to generate the schema.

Return type:

Returns:

The JSON schema for the given model class.

classmethod model_parametrized_name(params)[source]

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

Parameters:: params (tuple[type[Any], ...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.
Return type:: str
Returns:: String representing the new class where params are passed to cls as type variables.
Raises:: TypeError – Raised when trying to generate concrete names for non-generic models.

model_post_init(_BaseModel__context)[source]

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

Return type:: None

classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)[source]

Try to rebuild the pydantic-core schema for the model.

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.

Parameters:

force (bool) – Whether to force the rebuilding of the model schema, defaults to False.
raise_errors (bool) – Whether to raise errors, defaults to True.
_parent_namespace_depth (int) – The depth level of the parent namespace, defaults to 2.
_types_namespace (dict[str, Any] | None) – The types namespace, defaults to None.

Return type:

Returns:

Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.

classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)[source]

Validate a pydantic model instance.

Parameters:

obj (Any) – The object to validate.
strict (bool | None) – Whether to enforce types strictly.
from_attributes (bool | None) – Whether to extract data from object attributes.
context (Any | None) – Additional context to pass to the validator.

Raises:

ValidationError – If the object could not be validated.

Return type:

Self

Returns:

The validated model instance.

classmethod model_validate_json(json_data, *, strict=None, context=None)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing

Validate the given JSON data against the Pydantic model.

Parameters:

json_data (str | bytes | bytearray) – The JSON data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

Raises:

ValidationError – If json_data is not a JSON string or the object could not be validated.

classmethod model_validate_strings(obj, *, strict=None, context=None)[source]

Validate the given object with string data against the Pydantic model.

Parameters:

obj (Any) – The object containing string data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod parse_obj(obj)[source]

Return type:: Self

classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod schema(by_alias=True, ref_template='#/$defs/{model}')[source]

Return type:: Dict[str, Any]

classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)[source]

Return type:: str

type: Literal['default_camera_get_settings'][source]

classmethod update_forward_refs(**localns)[source]

Return type:: None

classmethod validate(value)[source]

Return type:: Self

class kittycad.models.ok_modeling_cmd_response.OptionDefaultCameraLookAt(**data)[source][source]

The response to the ‘DefaultCameraLookAt’ endpoint

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__abstractmethods__ = frozenset({})[source]

__annotations__ = {'__class_vars__': 'ClassVar[set[str]]', '__private_attributes__': 'ClassVar[Dict[str, ModelPrivateAttr]]', '__pydantic_complete__': 'ClassVar[bool]', '__pydantic_core_schema__': 'ClassVar[CoreSchema]', '__pydantic_custom_init__': 'ClassVar[bool]', '__pydantic_decorators__': 'ClassVar[_decorators.DecoratorInfos]', '__pydantic_extra__': 'dict[str, Any] | None', '__pydantic_fields_set__': 'set[str]', '__pydantic_generic_metadata__': 'ClassVar[_generics.PydanticGenericMetadata]', '__pydantic_parent_namespace__': 'ClassVar[Dict[str, Any] | None]', '__pydantic_post_init__': "ClassVar[None | Literal['model_post_init']]", '__pydantic_private__': 'dict[str, Any] | None', '__pydantic_root_model__': 'ClassVar[bool]', '__pydantic_serializer__': 'ClassVar[SchemaSerializer]', '__pydantic_validator__': 'ClassVar[SchemaValidator | PluggableSchemaValidator]', '__signature__': 'ClassVar[Signature]', 'data': <class 'kittycad.models.default_camera_look_at.DefaultCameraLookAt'>, 'model_computed_fields': 'ClassVar[Dict[str, ComputedFieldInfo]]', 'model_config': 'ClassVar[ConfigDict]', 'model_fields': 'ClassVar[Dict[str, FieldInfo]]', 'type': typing.Literal['default_camera_look_at']}[source]

classmethod __class_getitem__(typevar_values)[source]

Return type:: type[BaseModel] | PydanticRecursiveRef

__class_vars__: ClassVar[set[str]] = {}[source]: The names of the class variables defined on the model.

__copy__()[source]

Returns a shallow copy of the model.

Return type:: Self

__deepcopy__(memo=None)[source]

Returns a deep copy of the model.

Return type:: Self

__delattr__(item)[source]

Implement delattr(self, name).

Return type:: Any

__dict__[source]

__eq__(other)[source]

Return self==value.

Return type:: bool

property __fields_set__: set[str][source]

classmethod __get_pydantic_core_schema__(source, handler, /)[source]

Hook into generating the model’s CoreSchema.

Parameters:

source (type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.
handler (GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.

Return type:

Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]

Returns:

A pydantic-core CoreSchema.

classmethod __get_pydantic_json_schema__(core_schema, handler, /)[source]

Hook into generating the model’s JSON schema.

Parameters:

core_schema (Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({'type': 'nullable', 'schema': current_schema}), or just call the handler with the original schema.
handler (GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.

Return type:

Returns:

A JSON schema, as a Python object.

__getattr__(item)[source]

Return type:: Any

__getstate__()[source]

Helper for pickle.

Return type:: dict[Any, Any]

__hash__ = None[source]

__init__(**data)[source]

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__iter__()[source]

So dict(model) works.

Return type:: Generator[Tuple[str, Any], None, None]

__module__ = 'kittycad.models.ok_modeling_cmd_response'[source]

__pretty__(fmt, **kwargs)[source]

Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.

Return type:: Generator[Any, None, None]

__private_attributes__: ClassVar[Dict[str, ModelPrivateAttr]] = {}[source]: Metadata about the private attributes of the model.

__pydantic_complete__: ClassVar[bool] = True[source]: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__: ClassVar[CoreSchema] = {'cls': <class 'kittycad.models.ok_modeling_cmd_response.OptionDefaultCameraLookAt'>, 'config': {'title': 'OptionDefaultCameraLookAt'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.ok_modeling_cmd_response.OptionDefaultCameraLookAt'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.ok_modeling_cmd_response.OptionDefaultCameraLookAt'>>]}, 'ref': 'kittycad.models.ok_modeling_cmd_response.OptionDefaultCameraLookAt:94667212775600', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'data': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.default_camera_look_at.DefaultCameraLookAt'>, 'config': {'title': 'DefaultCameraLookAt'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.default_camera_look_at.DefaultCameraLookAt'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.default_camera_look_at.DefaultCameraLookAt'>>]}, 'ref': 'kittycad.models.default_camera_look_at.DefaultCameraLookAt:94667206003840', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {}, 'model_name': 'DefaultCameraLookAt', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}, 'type': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': 'default_camera_look_at', 'schema': {'expected': ['default_camera_look_at'], 'type': 'literal'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'OptionDefaultCameraLookAt', 'type': 'model-fields'}, 'type': 'model'}[source]: The core schema of the model.

__pydantic_custom_init__: ClassVar[bool] = False[source]: Whether the model has a custom __init__ method.

__pydantic_decorators__: ClassVar[_decorators.DecoratorInfos] = DecoratorInfos(validators={}, field_validators={}, root_validators={}, field_serializers={}, model_serializers={}, model_validators={}, computed_fields={})[source]: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_extra__: dict[str, Any] | None[source]: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to 'allow'.

__pydantic_fields_set__: set[str][source]: The names of fields explicitly set during instantiation.

__pydantic_generic_metadata__: ClassVar[_generics.PydanticGenericMetadata] = {'args': (), 'origin': None, 'parameters': ()}[source]: 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.

classmethod __pydantic_init_subclass__(**kwargs)[source]

This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.

This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.

This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.

Parameters:: **kwargs (Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.
Return type:: None

__pydantic_parent_namespace__: ClassVar[Dict[str, Any] | None] = None[source]: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__: ClassVar[None | Literal['model_post_init']] = None[source]: The name of the post-init method for the model, if defined.

__pydantic_private__: dict[str, Any] | None[source]: Values of private attributes set on the model instance.

__pydantic_root_model__: ClassVar[bool] = False[source]: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__: ClassVar[SchemaSerializer] = SchemaSerializer(serializer=Model( ModelSerializer { class: Py( 0x000056196d96e0b0, ), serializer: Fields( GeneralFieldsSerializer { fields: { "data": SerField { key_py: Py( 0x00007f9038238fa0, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196d2f8c80, ), serializer: Fields( GeneralFieldsSerializer { fields: {}, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 0, }, ), has_extra: false, root_model: false, name: "DefaultCameraLookAt", }, ), ), required: true, }, "type": SerField { key_py: Py( 0x00007f903823d958, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f9034c742b0, ), ), serializer: Literal( LiteralSerializer { expected_int: {}, expected_str: { "default_camera_look_at", }, expected_py: None, name: "literal['default_camera_look_at']", }, ), }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "OptionDefaultCameraLookAt", }, ), definitions=[])[source]: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__: ClassVar[SchemaValidator | PluggableSchemaValidator] = SchemaValidator(title="OptionDefaultCameraLookAt", validator=Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "data", lookup_key: Simple { key: "data", py_key: Py( 0x00007f9033607510, ), path: LookupPath( [ S( "data", Py( 0x00007f9033607180, ), ), ], ), }, name_py: Py( 0x00007f9038238fa0, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [], model_name: "DefaultCameraLookAt", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d2f8c80, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "DefaultCameraLookAt", }, ), frozen: false, }, Field { name: "type", lookup_key: Simple { key: "type", py_key: Py( 0x00007f9033607210, ), path: LookupPath( [ S( "type", Py( 0x00007f90336070c0, ), ), ], ), }, name_py: Py( 0x00007f903823d958, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f9034c742b0, ), ), on_error: Raise, validator: Literal( LiteralValidator { lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "default_camera_look_at": 0, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f9034c742b0, ), ], }, expected_repr: "'default_camera_look_at'", name: "literal['default_camera_look_at']", }, ), validate_default: false, copy_default: false, name: "default[literal['default_camera_look_at']]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "OptionDefaultCameraLookAt", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d96e0b0, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "OptionDefaultCameraLookAt", }, ), definitions=[], cache_strings=True)[source]: The pydantic-core SchemaValidator used to validate instances of the model.

__repr__()[source]

Return repr(self).

Return type:: str

__repr_args__()[source]

Return type:: Iterable[tuple[str | None, Any]]

__repr_name__()[source]

Name of the instance’s class, used in __repr__.

Return type:: str

__repr_str__(join_str)[source]

Return type:: str

__rich_repr__()[source]

Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.

Return type:: Iterable[Any | tuple[Any] | tuple[str, Any] | tuple[str, Any, Any]]

__setattr__(name, value)[source]

Implement setattr(self, name, value).

Return type:: None

__setstate__(state)[source]

Return type:: None

__signature__: ClassVar[Signature] = <Signature (*, data: kittycad.models.default_camera_look_at.DefaultCameraLookAt, type: Literal['default_camera_look_at'] = 'default_camera_look_at') -> None>[source]: The synthesized __init__ [Signature][inspect.Signature] of the model.

__slots__ = ('__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__')[source]

__str__()[source]

Return str(self).

Return type:: str

_abc_impl = <_abc._abc_data object>[source]

_calculate_keys(*args, **kwargs)[source]

Return type:: Any

_check_frozen(name, value)[source]

Return type:: None

_copy_and_set_values(*args, **kwargs)[source]

Return type:: Any

classmethod _get_value(*args, **kwargs)[source]

Return type:: Any

_iter(*args, **kwargs)[source]

Return type:: Any

classmethod construct(_fields_set=None, **values)[source]

Return type:: Self

copy(*, include=None, exclude=None, update=None, deep=False)[source]

Returns a copy of the model.

!!! warning “Deprecated”: This method is now deprecated; use model_copy instead.

If you need include or exclude, use:

`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `

Parameters:

include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.

Returns:

A copy of the model with included, excluded and updated fields as specified.

data: DefaultCameraLookAt[source]

dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)[source]

Return type:: Dict[str, Any]

classmethod from_orm(obj)[source]

Return type:: Self

json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)[source]

Return type:: str

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}[source]: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'protected_namespaces': ()}[source]: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod model_construct(_fields_set=None, **values)[source]

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note: model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == 'allow', then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == 'ignore' (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == 'forbid' does not result in an error if extra values are passed, but they will be ignored.

Parameters:

_fields_set (set[str] | None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.
values (Any) – Trusted or pre-validated data dictionary.

Return type:

Self

Returns:

A new instance of the Model class with validated data.

model_copy(*, update=None, deep=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy

Returns a copy of the model.

Parameters:

update (dict[str, Any] | None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.
deep (bool) – Set to True to make a deep copy of the model.

Return type:

Self

Returns:

New model instance.

model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters:

mode (Union[Literal['json', 'python'], str]) – The mode in which to_python 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.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to include in the output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to exclude from the output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to use the field’s alias in the dictionary key if defined.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A dictionary representation of the model.

model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

Generates a JSON representation of the model using Pydantic’s to_json method.

Parameters:

indent (int | None) – Indentation to use in the JSON output. If None is passed, the output will be compact.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to include in the JSON output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to exclude from the JSON output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to serialize using field aliases.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A JSON string representation of the model.

property model_extra: dict[str, Any] | None[source]

Get extra fields set during validation.

Returns:: A dictionary of extra fields, or None if config.extra is not set to "allow".

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=DefaultCameraLookAt, required=True), 'type': FieldInfo(annotation=Literal['default_camera_look_at'], required=False, default='default_camera_look_at')}[source]

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

property model_fields_set: set[str][source]

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,: i.e. that were not filled from defaults.

classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')[source]

Generates a JSON schema for a model class.

Parameters:

by_alias (bool) – Whether to use attribute aliases or not.
ref_template (str) – The reference template.
schema_generator (type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modifications
mode (Literal['validation', 'serialization']) – The mode in which to generate the schema.

Return type:

Returns:

The JSON schema for the given model class.

classmethod model_parametrized_name(params)[source]

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

Parameters:: params (tuple[type[Any], ...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.
Return type:: str
Returns:: String representing the new class where params are passed to cls as type variables.
Raises:: TypeError – Raised when trying to generate concrete names for non-generic models.

model_post_init(_BaseModel__context)[source]

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

Return type:: None

classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)[source]

Try to rebuild the pydantic-core schema for the model.

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.

Parameters:

force (bool) – Whether to force the rebuilding of the model schema, defaults to False.
raise_errors (bool) – Whether to raise errors, defaults to True.
_parent_namespace_depth (int) – The depth level of the parent namespace, defaults to 2.
_types_namespace (dict[str, Any] | None) – The types namespace, defaults to None.

Return type:

Returns:

Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.

classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)[source]

Validate a pydantic model instance.

Parameters:

obj (Any) – The object to validate.
strict (bool | None) – Whether to enforce types strictly.
from_attributes (bool | None) – Whether to extract data from object attributes.
context (Any | None) – Additional context to pass to the validator.

Raises:

ValidationError – If the object could not be validated.

Return type:

Self

Returns:

The validated model instance.

classmethod model_validate_json(json_data, *, strict=None, context=None)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing

Validate the given JSON data against the Pydantic model.

Parameters:

json_data (str | bytes | bytearray) – The JSON data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

Raises:

ValidationError – If json_data is not a JSON string or the object could not be validated.

classmethod model_validate_strings(obj, *, strict=None, context=None)[source]

Validate the given object with string data against the Pydantic model.

Parameters:

obj (Any) – The object containing string data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod parse_obj(obj)[source]

Return type:: Self

classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod schema(by_alias=True, ref_template='#/$defs/{model}')[source]

Return type:: Dict[str, Any]

classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)[source]

Return type:: str

type: Literal['default_camera_look_at'][source]

classmethod update_forward_refs(**localns)[source]

Return type:: None

classmethod validate(value)[source]

Return type:: Self

class kittycad.models.ok_modeling_cmd_response.OptionDefaultCameraPerspectiveSettings(**data)[source][source]

The response to the ‘DefaultCameraPerspectiveSettings’ endpoint

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__abstractmethods__ = frozenset({})[source]

__annotations__ = {'__class_vars__': 'ClassVar[set[str]]', '__private_attributes__': 'ClassVar[Dict[str, ModelPrivateAttr]]', '__pydantic_complete__': 'ClassVar[bool]', '__pydantic_core_schema__': 'ClassVar[CoreSchema]', '__pydantic_custom_init__': 'ClassVar[bool]', '__pydantic_decorators__': 'ClassVar[_decorators.DecoratorInfos]', '__pydantic_extra__': 'dict[str, Any] | None', '__pydantic_fields_set__': 'set[str]', '__pydantic_generic_metadata__': 'ClassVar[_generics.PydanticGenericMetadata]', '__pydantic_parent_namespace__': 'ClassVar[Dict[str, Any] | None]', '__pydantic_post_init__': "ClassVar[None | Literal['model_post_init']]", '__pydantic_private__': 'dict[str, Any] | None', '__pydantic_root_model__': 'ClassVar[bool]', '__pydantic_serializer__': 'ClassVar[SchemaSerializer]', '__pydantic_validator__': 'ClassVar[SchemaValidator | PluggableSchemaValidator]', '__signature__': 'ClassVar[Signature]', 'data': <class 'kittycad.models.default_camera_perspective_settings.DefaultCameraPerspectiveSettings'>, 'model_computed_fields': 'ClassVar[Dict[str, ComputedFieldInfo]]', 'model_config': 'ClassVar[ConfigDict]', 'model_fields': 'ClassVar[Dict[str, FieldInfo]]', 'type': typing.Literal['default_camera_perspective_settings']}[source]

classmethod __class_getitem__(typevar_values)[source]

Return type:: type[BaseModel] | PydanticRecursiveRef

__class_vars__: ClassVar[set[str]] = {}[source]: The names of the class variables defined on the model.

__copy__()[source]

Returns a shallow copy of the model.

Return type:: Self

__deepcopy__(memo=None)[source]

Returns a deep copy of the model.

Return type:: Self

__delattr__(item)[source]

Implement delattr(self, name).

Return type:: Any

__dict__[source]

__eq__(other)[source]

Return self==value.

Return type:: bool

property __fields_set__: set[str][source]

classmethod __get_pydantic_core_schema__(source, handler, /)[source]

Hook into generating the model’s CoreSchema.

Parameters:

source (type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.
handler (GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.

Return type:

Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]

Returns:

A pydantic-core CoreSchema.

classmethod __get_pydantic_json_schema__(core_schema, handler, /)[source]

Hook into generating the model’s JSON schema.

Parameters:

core_schema (Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({'type': 'nullable', 'schema': current_schema}), or just call the handler with the original schema.
handler (GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.

Return type:

Returns:

A JSON schema, as a Python object.

__getattr__(item)[source]

Return type:: Any

__getstate__()[source]

Helper for pickle.

Return type:: dict[Any, Any]

__hash__ = None[source]

__init__(**data)[source]

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__iter__()[source]

So dict(model) works.

Return type:: Generator[Tuple[str, Any], None, None]

__module__ = 'kittycad.models.ok_modeling_cmd_response'[source]

__pretty__(fmt, **kwargs)[source]

Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.

Return type:: Generator[Any, None, None]

__private_attributes__: ClassVar[Dict[str, ModelPrivateAttr]] = {}[source]: Metadata about the private attributes of the model.

__pydantic_complete__: ClassVar[bool] = True[source]: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__: ClassVar[CoreSchema] = {'cls': <class 'kittycad.models.ok_modeling_cmd_response.OptionDefaultCameraPerspectiveSettings'>, 'config': {'title': 'OptionDefaultCameraPerspectiveSettings'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.ok_modeling_cmd_response.OptionDefaultCameraPerspectiveSettings'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.ok_modeling_cmd_response.OptionDefaultCameraPerspectiveSettings'>>]}, 'ref': 'kittycad.models.ok_modeling_cmd_response.OptionDefaultCameraPerspectiveSettings:94667212784656', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'data': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.default_camera_perspective_settings.DefaultCameraPerspectiveSettings'>, 'config': {'title': 'DefaultCameraPerspectiveSettings'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.default_camera_perspective_settings.DefaultCameraPerspectiveSettings'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.default_camera_perspective_settings.DefaultCameraPerspectiveSettings'>>]}, 'ref': 'kittycad.models.default_camera_perspective_settings.DefaultCameraPerspectiveSettings:94667206010448', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {}, 'model_name': 'DefaultCameraPerspectiveSettings', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}, 'type': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': 'default_camera_perspective_settings', 'schema': {'expected': ['default_camera_perspective_settings'], 'type': 'literal'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'OptionDefaultCameraPerspectiveSettings', 'type': 'model-fields'}, 'type': 'model'}[source]: The core schema of the model.

__pydantic_custom_init__: ClassVar[bool] = False[source]: Whether the model has a custom __init__ method.

__pydantic_decorators__: ClassVar[_decorators.DecoratorInfos] = DecoratorInfos(validators={}, field_validators={}, root_validators={}, field_serializers={}, model_serializers={}, model_validators={}, computed_fields={})[source]: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_extra__: dict[str, Any] | None[source]: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to 'allow'.

__pydantic_fields_set__: set[str][source]: The names of fields explicitly set during instantiation.

__pydantic_generic_metadata__: ClassVar[_generics.PydanticGenericMetadata] = {'args': (), 'origin': None, 'parameters': ()}[source]: 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.

classmethod __pydantic_init_subclass__(**kwargs)[source]

This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.

This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.

This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.

Parameters:: **kwargs (Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.
Return type:: None

__pydantic_parent_namespace__: ClassVar[Dict[str, Any] | None] = None[source]: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__: ClassVar[None | Literal['model_post_init']] = None[source]: The name of the post-init method for the model, if defined.

__pydantic_private__: dict[str, Any] | None[source]: Values of private attributes set on the model instance.

__pydantic_root_model__: ClassVar[bool] = False[source]: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__: ClassVar[SchemaSerializer] = SchemaSerializer(serializer=Model( ModelSerializer { class: Py( 0x000056196d970410, ), serializer: Fields( GeneralFieldsSerializer { fields: { "data": SerField { key_py: Py( 0x00007f9038238fa0, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196d2fa650, ), serializer: Fields( GeneralFieldsSerializer { fields: {}, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 0, }, ), has_extra: false, root_model: false, name: "DefaultCameraPerspectiveSettings", }, ), ), required: true, }, "type": SerField { key_py: Py( 0x00007f903823d958, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f9034696420, ), ), serializer: Literal( LiteralSerializer { expected_int: {}, expected_str: { "default_camera_perspective_settings", }, expected_py: None, name: "literal['default_camera_perspective_settings']", }, ), }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "OptionDefaultCameraPerspectiveSettings", }, ), definitions=[])[source]: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__: ClassVar[SchemaValidator | PluggableSchemaValidator] = SchemaValidator(title="OptionDefaultCameraPerspectiveSettings", validator=Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "data", lookup_key: Simple { key: "data", py_key: Py( 0x00007f9033606a60, ), path: LookupPath( [ S( "data", Py( 0x00007f9033606ac0, ), ), ], ), }, name_py: Py( 0x00007f9038238fa0, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [], model_name: "DefaultCameraPerspectiveSettings", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d2fa650, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "DefaultCameraPerspectiveSettings", }, ), frozen: false, }, Field { name: "type", lookup_key: Simple { key: "type", py_key: Py( 0x00007f9033606af0, ), path: LookupPath( [ S( "type", Py( 0x00007f90336069a0, ), ), ], ), }, name_py: Py( 0x00007f903823d958, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f9034696420, ), ), on_error: Raise, validator: Literal( LiteralValidator { lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "default_camera_perspective_settings": 0, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f9034696420, ), ], }, expected_repr: "'default_camera_perspective_settings'", name: "literal['default_camera_perspective_settings']", }, ), validate_default: false, copy_default: false, name: "default[literal['default_camera_perspective_settings']]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "OptionDefaultCameraPerspectiveSettings", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d970410, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "OptionDefaultCameraPerspectiveSettings", }, ), definitions=[], cache_strings=True)[source]: The pydantic-core SchemaValidator used to validate instances of the model.

__repr__()[source]

Return repr(self).

Return type:: str

__repr_args__()[source]

Return type:: Iterable[tuple[str | None, Any]]

__repr_name__()[source]

Name of the instance’s class, used in __repr__.

Return type:: str

__repr_str__(join_str)[source]

Return type:: str

__rich_repr__()[source]

Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.

Return type:: Iterable[Any | tuple[Any] | tuple[str, Any] | tuple[str, Any, Any]]

__setattr__(name, value)[source]

Implement setattr(self, name, value).

Return type:: None

__setstate__(state)[source]

Return type:: None

__signature__: ClassVar[Signature] = <Signature (*, data: kittycad.models.default_camera_perspective_settings.DefaultCameraPerspectiveSettings, type: Literal['default_camera_perspective_settings'] = 'default_camera_perspective_settings') -> None>[source]: The synthesized __init__ [Signature][inspect.Signature] of the model.

__slots__ = ('__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__')[source]

__str__()[source]

Return str(self).

Return type:: str

_abc_impl = <_abc._abc_data object>[source]

_calculate_keys(*args, **kwargs)[source]

Return type:: Any

_check_frozen(name, value)[source]

Return type:: None

_copy_and_set_values(*args, **kwargs)[source]

Return type:: Any

classmethod _get_value(*args, **kwargs)[source]

Return type:: Any

_iter(*args, **kwargs)[source]

Return type:: Any

classmethod construct(_fields_set=None, **values)[source]

Return type:: Self

copy(*, include=None, exclude=None, update=None, deep=False)[source]

Returns a copy of the model.

!!! warning “Deprecated”: This method is now deprecated; use model_copy instead.

If you need include or exclude, use:

`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `

Parameters:

include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.

Returns:

A copy of the model with included, excluded and updated fields as specified.

data: DefaultCameraPerspectiveSettings[source]

dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)[source]

Return type:: Dict[str, Any]

classmethod from_orm(obj)[source]

Return type:: Self

json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)[source]

Return type:: str

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}[source]: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'protected_namespaces': ()}[source]: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod model_construct(_fields_set=None, **values)[source]

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note: model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == 'allow', then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == 'ignore' (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == 'forbid' does not result in an error if extra values are passed, but they will be ignored.

Parameters:

_fields_set (set[str] | None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.
values (Any) – Trusted or pre-validated data dictionary.

Return type:

Self

Returns:

A new instance of the Model class with validated data.

model_copy(*, update=None, deep=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy

Returns a copy of the model.

Parameters:

update (dict[str, Any] | None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.
deep (bool) – Set to True to make a deep copy of the model.

Return type:

Self

Returns:

New model instance.

model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters:

mode (Union[Literal['json', 'python'], str]) – The mode in which to_python 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.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to include in the output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to exclude from the output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to use the field’s alias in the dictionary key if defined.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A dictionary representation of the model.

model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

Generates a JSON representation of the model using Pydantic’s to_json method.

Parameters:

indent (int | None) – Indentation to use in the JSON output. If None is passed, the output will be compact.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to include in the JSON output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to exclude from the JSON output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to serialize using field aliases.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A JSON string representation of the model.

property model_extra: dict[str, Any] | None[source]

Get extra fields set during validation.

Returns:: A dictionary of extra fields, or None if config.extra is not set to "allow".

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=DefaultCameraPerspectiveSettings, required=True), 'type': FieldInfo(annotation=Literal['default_camera_perspective_settings'], required=False, default='default_camera_perspective_settings')}[source]

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

property model_fields_set: set[str][source]

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,: i.e. that were not filled from defaults.

classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')[source]

Generates a JSON schema for a model class.

Parameters:

by_alias (bool) – Whether to use attribute aliases or not.
ref_template (str) – The reference template.
schema_generator (type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modifications
mode (Literal['validation', 'serialization']) – The mode in which to generate the schema.

Return type:

Returns:

The JSON schema for the given model class.

classmethod model_parametrized_name(params)[source]

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

Parameters:: params (tuple[type[Any], ...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.
Return type:: str
Returns:: String representing the new class where params are passed to cls as type variables.
Raises:: TypeError – Raised when trying to generate concrete names for non-generic models.

model_post_init(_BaseModel__context)[source]

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

Return type:: None

classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)[source]

Try to rebuild the pydantic-core schema for the model.

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.

Parameters:

force (bool) – Whether to force the rebuilding of the model schema, defaults to False.
raise_errors (bool) – Whether to raise errors, defaults to True.
_parent_namespace_depth (int) – The depth level of the parent namespace, defaults to 2.
_types_namespace (dict[str, Any] | None) – The types namespace, defaults to None.

Return type:

Returns:

Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.

classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)[source]

Validate a pydantic model instance.

Parameters:

obj (Any) – The object to validate.
strict (bool | None) – Whether to enforce types strictly.
from_attributes (bool | None) – Whether to extract data from object attributes.
context (Any | None) – Additional context to pass to the validator.

Raises:

ValidationError – If the object could not be validated.

Return type:

Self

Returns:

The validated model instance.

classmethod model_validate_json(json_data, *, strict=None, context=None)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing

Validate the given JSON data against the Pydantic model.

Parameters:

json_data (str | bytes | bytearray) – The JSON data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

Raises:

ValidationError – If json_data is not a JSON string or the object could not be validated.

classmethod model_validate_strings(obj, *, strict=None, context=None)[source]

Validate the given object with string data against the Pydantic model.

Parameters:

obj (Any) – The object containing string data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod parse_obj(obj)[source]

Return type:: Self

classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod schema(by_alias=True, ref_template='#/$defs/{model}')[source]

Return type:: Dict[str, Any]

classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)[source]

Return type:: str

type: Literal['default_camera_perspective_settings'][source]

classmethod update_forward_refs(**localns)[source]

Return type:: None

classmethod validate(value)[source]

Return type:: Self

class kittycad.models.ok_modeling_cmd_response.OptionDefaultCameraSetOrthographic(**data)[source][source]

The response to the ‘DefaultCameraSetOrthographic’ endpoint

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__abstractmethods__ = frozenset({})[source]

__annotations__ = {'__class_vars__': 'ClassVar[set[str]]', '__private_attributes__': 'ClassVar[Dict[str, ModelPrivateAttr]]', '__pydantic_complete__': 'ClassVar[bool]', '__pydantic_core_schema__': 'ClassVar[CoreSchema]', '__pydantic_custom_init__': 'ClassVar[bool]', '__pydantic_decorators__': 'ClassVar[_decorators.DecoratorInfos]', '__pydantic_extra__': 'dict[str, Any] | None', '__pydantic_fields_set__': 'set[str]', '__pydantic_generic_metadata__': 'ClassVar[_generics.PydanticGenericMetadata]', '__pydantic_parent_namespace__': 'ClassVar[Dict[str, Any] | None]', '__pydantic_post_init__': "ClassVar[None | Literal['model_post_init']]", '__pydantic_private__': 'dict[str, Any] | None', '__pydantic_root_model__': 'ClassVar[bool]', '__pydantic_serializer__': 'ClassVar[SchemaSerializer]', '__pydantic_validator__': 'ClassVar[SchemaValidator | PluggableSchemaValidator]', '__signature__': 'ClassVar[Signature]', 'data': <class 'kittycad.models.default_camera_set_orthographic.DefaultCameraSetOrthographic'>, 'model_computed_fields': 'ClassVar[Dict[str, ComputedFieldInfo]]', 'model_config': 'ClassVar[ConfigDict]', 'model_fields': 'ClassVar[Dict[str, FieldInfo]]', 'type': typing.Literal['default_camera_set_orthographic']}[source]

classmethod __class_getitem__(typevar_values)[source]

Return type:: type[BaseModel] | PydanticRecursiveRef

__class_vars__: ClassVar[set[str]] = {}[source]: The names of the class variables defined on the model.

__copy__()[source]

Returns a shallow copy of the model.

Return type:: Self

__deepcopy__(memo=None)[source]

Returns a deep copy of the model.

Return type:: Self

__delattr__(item)[source]

Implement delattr(self, name).

Return type:: Any

__dict__[source]

__eq__(other)[source]

Return self==value.

Return type:: bool

property __fields_set__: set[str][source]

classmethod __get_pydantic_core_schema__(source, handler, /)[source]

Hook into generating the model’s CoreSchema.

Parameters:

source (type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.
handler (GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.

Return type:

Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]

Returns:

A pydantic-core CoreSchema.

classmethod __get_pydantic_json_schema__(core_schema, handler, /)[source]

Hook into generating the model’s JSON schema.

Parameters:

core_schema (Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({'type': 'nullable', 'schema': current_schema}), or just call the handler with the original schema.
handler (GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.

Return type:

Returns:

A JSON schema, as a Python object.

__getattr__(item)[source]

Return type:: Any

__getstate__()[source]

Helper for pickle.

Return type:: dict[Any, Any]

__hash__ = None[source]

__init__(**data)[source]

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__iter__()[source]

So dict(model) works.

Return type:: Generator[Tuple[str, Any], None, None]

__module__ = 'kittycad.models.ok_modeling_cmd_response'[source]

__pretty__(fmt, **kwargs)[source]

Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.

Return type:: Generator[Any, None, None]

__private_attributes__: ClassVar[Dict[str, ModelPrivateAttr]] = {}[source]: Metadata about the private attributes of the model.

__pydantic_complete__: ClassVar[bool] = True[source]: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__: ClassVar[CoreSchema] = {'cls': <class 'kittycad.models.ok_modeling_cmd_response.OptionDefaultCameraSetOrthographic'>, 'config': {'title': 'OptionDefaultCameraSetOrthographic'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.ok_modeling_cmd_response.OptionDefaultCameraSetOrthographic'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.ok_modeling_cmd_response.OptionDefaultCameraSetOrthographic'>>]}, 'ref': 'kittycad.models.ok_modeling_cmd_response.OptionDefaultCameraSetOrthographic:94667213167904', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'data': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.default_camera_set_orthographic.DefaultCameraSetOrthographic'>, 'config': {'title': 'DefaultCameraSetOrthographic'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.default_camera_set_orthographic.DefaultCameraSetOrthographic'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.default_camera_set_orthographic.DefaultCameraSetOrthographic'>>]}, 'ref': 'kittycad.models.default_camera_set_orthographic.DefaultCameraSetOrthographic:94667206013392', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {}, 'model_name': 'DefaultCameraSetOrthographic', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}, 'type': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': 'default_camera_set_orthographic', 'schema': {'expected': ['default_camera_set_orthographic'], 'type': 'literal'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'OptionDefaultCameraSetOrthographic', 'type': 'model-fields'}, 'type': 'model'}[source]: The core schema of the model.

__pydantic_custom_init__: ClassVar[bool] = False[source]: Whether the model has a custom __init__ method.

__pydantic_decorators__: ClassVar[_decorators.DecoratorInfos] = DecoratorInfos(validators={}, field_validators={}, root_validators={}, field_serializers={}, model_serializers={}, model_validators={}, computed_fields={})[source]: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_extra__: dict[str, Any] | None[source]: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to 'allow'.

__pydantic_fields_set__: set[str][source]: The names of fields explicitly set during instantiation.

__pydantic_generic_metadata__: ClassVar[_generics.PydanticGenericMetadata] = {'args': (), 'origin': None, 'parameters': ()}[source]: 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.

classmethod __pydantic_init_subclass__(**kwargs)[source]

This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.

This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.

This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.

Parameters:: **kwargs (Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.
Return type:: None

__pydantic_parent_namespace__: ClassVar[Dict[str, Any] | None] = None[source]: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__: ClassVar[None | Literal['model_post_init']] = None[source]: The name of the post-init method for the model, if defined.

__pydantic_private__: dict[str, Any] | None[source]: Values of private attributes set on the model instance.

__pydantic_root_model__: ClassVar[bool] = False[source]: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__: ClassVar[SchemaSerializer] = SchemaSerializer(serializer=Model( ModelSerializer { class: Py( 0x000056196d9cdd20, ), serializer: Fields( GeneralFieldsSerializer { fields: { "type": SerField { key_py: Py( 0x00007f903823d958, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f9034696510, ), ), serializer: Literal( LiteralSerializer { expected_int: {}, expected_str: { "default_camera_set_orthographic", }, expected_py: None, name: "literal['default_camera_set_orthographic']", }, ), }, ), ), required: true, }, "data": SerField { key_py: Py( 0x00007f9038238fa0, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196d2fb1d0, ), serializer: Fields( GeneralFieldsSerializer { fields: {}, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 0, }, ), has_extra: false, root_model: false, name: "DefaultCameraSetOrthographic", }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "OptionDefaultCameraSetOrthographic", }, ), definitions=[])[source]: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__: ClassVar[SchemaValidator | PluggableSchemaValidator] = SchemaValidator(title="OptionDefaultCameraSetOrthographic", validator=Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "data", lookup_key: Simple { key: "data", py_key: Py( 0x00007f9033520e10, ), path: LookupPath( [ S( "data", Py( 0x00007f9033520a80, ), ), ], ), }, name_py: Py( 0x00007f9038238fa0, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [], model_name: "DefaultCameraSetOrthographic", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d2fb1d0, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "DefaultCameraSetOrthographic", }, ), frozen: false, }, Field { name: "type", lookup_key: Simple { key: "type", py_key: Py( 0x00007f9033520b10, ), path: LookupPath( [ S( "type", Py( 0x00007f90335209c0, ), ), ], ), }, name_py: Py( 0x00007f903823d958, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f9034696510, ), ), on_error: Raise, validator: Literal( LiteralValidator { lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "default_camera_set_orthographic": 0, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f9034696510, ), ], }, expected_repr: "'default_camera_set_orthographic'", name: "literal['default_camera_set_orthographic']", }, ), validate_default: false, copy_default: false, name: "default[literal['default_camera_set_orthographic']]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "OptionDefaultCameraSetOrthographic", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d9cdd20, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "OptionDefaultCameraSetOrthographic", }, ), definitions=[], cache_strings=True)[source]: The pydantic-core SchemaValidator used to validate instances of the model.

__repr__()[source]

Return repr(self).

Return type:: str

__repr_args__()[source]

Return type:: Iterable[tuple[str | None, Any]]

__repr_name__()[source]

Name of the instance’s class, used in __repr__.

Return type:: str

__repr_str__(join_str)[source]

Return type:: str

__rich_repr__()[source]

Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.

Return type:: Iterable[Any | tuple[Any] | tuple[str, Any] | tuple[str, Any, Any]]

__setattr__(name, value)[source]

Implement setattr(self, name, value).

Return type:: None

__setstate__(state)[source]

Return type:: None

__signature__: ClassVar[Signature] = <Signature (*, data: kittycad.models.default_camera_set_orthographic.DefaultCameraSetOrthographic, type: Literal['default_camera_set_orthographic'] = 'default_camera_set_orthographic') -> None>[source]: The synthesized __init__ [Signature][inspect.Signature] of the model.

__slots__ = ('__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__')[source]

__str__()[source]

Return str(self).

Return type:: str

_abc_impl = <_abc._abc_data object>[source]

_calculate_keys(*args, **kwargs)[source]

Return type:: Any

_check_frozen(name, value)[source]

Return type:: None

_copy_and_set_values(*args, **kwargs)[source]

Return type:: Any

classmethod _get_value(*args, **kwargs)[source]

Return type:: Any

_iter(*args, **kwargs)[source]

Return type:: Any

classmethod construct(_fields_set=None, **values)[source]

Return type:: Self

copy(*, include=None, exclude=None, update=None, deep=False)[source]

Returns a copy of the model.

!!! warning “Deprecated”: This method is now deprecated; use model_copy instead.

If you need include or exclude, use:

`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `

Parameters:

include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.

Returns:

A copy of the model with included, excluded and updated fields as specified.

data: DefaultCameraSetOrthographic[source]

dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)[source]

Return type:: Dict[str, Any]

classmethod from_orm(obj)[source]

Return type:: Self

json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)[source]

Return type:: str

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}[source]: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'protected_namespaces': ()}[source]: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod model_construct(_fields_set=None, **values)[source]

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note: model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == 'allow', then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == 'ignore' (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == 'forbid' does not result in an error if extra values are passed, but they will be ignored.

Parameters:

_fields_set (set[str] | None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.
values (Any) – Trusted or pre-validated data dictionary.

Return type:

Self

Returns:

A new instance of the Model class with validated data.

model_copy(*, update=None, deep=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy

Returns a copy of the model.

Parameters:

update (dict[str, Any] | None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.
deep (bool) – Set to True to make a deep copy of the model.

Return type:

Self

Returns:

New model instance.

model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters:

mode (Union[Literal['json', 'python'], str]) – The mode in which to_python 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.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to include in the output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to exclude from the output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to use the field’s alias in the dictionary key if defined.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A dictionary representation of the model.

model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

Generates a JSON representation of the model using Pydantic’s to_json method.

Parameters:

indent (int | None) – Indentation to use in the JSON output. If None is passed, the output will be compact.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to include in the JSON output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to exclude from the JSON output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to serialize using field aliases.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A JSON string representation of the model.

property model_extra: dict[str, Any] | None[source]

Get extra fields set during validation.

Returns:: A dictionary of extra fields, or None if config.extra is not set to "allow".

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=DefaultCameraSetOrthographic, required=True), 'type': FieldInfo(annotation=Literal['default_camera_set_orthographic'], required=False, default='default_camera_set_orthographic')}[source]

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

property model_fields_set: set[str][source]

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,: i.e. that were not filled from defaults.

classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')[source]

Generates a JSON schema for a model class.

Parameters:

by_alias (bool) – Whether to use attribute aliases or not.
ref_template (str) – The reference template.
schema_generator (type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modifications
mode (Literal['validation', 'serialization']) – The mode in which to generate the schema.

Return type:

Returns:

The JSON schema for the given model class.

classmethod model_parametrized_name(params)[source]

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

Parameters:: params (tuple[type[Any], ...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.
Return type:: str
Returns:: String representing the new class where params are passed to cls as type variables.
Raises:: TypeError – Raised when trying to generate concrete names for non-generic models.

model_post_init(_BaseModel__context)[source]

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

Return type:: None

classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)[source]

Try to rebuild the pydantic-core schema for the model.

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.

Parameters:

force (bool) – Whether to force the rebuilding of the model schema, defaults to False.
raise_errors (bool) – Whether to raise errors, defaults to True.
_parent_namespace_depth (int) – The depth level of the parent namespace, defaults to 2.
_types_namespace (dict[str, Any] | None) – The types namespace, defaults to None.

Return type:

Returns:

Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.

classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)[source]

Validate a pydantic model instance.

Parameters:

obj (Any) – The object to validate.
strict (bool | None) – Whether to enforce types strictly.
from_attributes (bool | None) – Whether to extract data from object attributes.
context (Any | None) – Additional context to pass to the validator.

Raises:

ValidationError – If the object could not be validated.

Return type:

Self

Returns:

The validated model instance.

classmethod model_validate_json(json_data, *, strict=None, context=None)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing

Validate the given JSON data against the Pydantic model.

Parameters:

json_data (str | bytes | bytearray) – The JSON data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

Raises:

ValidationError – If json_data is not a JSON string or the object could not be validated.

classmethod model_validate_strings(obj, *, strict=None, context=None)[source]

Validate the given object with string data against the Pydantic model.

Parameters:

obj (Any) – The object containing string data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod parse_obj(obj)[source]

Return type:: Self

classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod schema(by_alias=True, ref_template='#/$defs/{model}')[source]

Return type:: Dict[str, Any]

classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)[source]

Return type:: str

type: Literal['default_camera_set_orthographic'][source]

classmethod update_forward_refs(**localns)[source]

Return type:: None

classmethod validate(value)[source]

Return type:: Self

class kittycad.models.ok_modeling_cmd_response.OptionDefaultCameraSetPerspective(**data)[source][source]

The response to the ‘DefaultCameraSetPerspective’ endpoint

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__abstractmethods__ = frozenset({})[source]

__annotations__ = {'__class_vars__': 'ClassVar[set[str]]', '__private_attributes__': 'ClassVar[Dict[str, ModelPrivateAttr]]', '__pydantic_complete__': 'ClassVar[bool]', '__pydantic_core_schema__': 'ClassVar[CoreSchema]', '__pydantic_custom_init__': 'ClassVar[bool]', '__pydantic_decorators__': 'ClassVar[_decorators.DecoratorInfos]', '__pydantic_extra__': 'dict[str, Any] | None', '__pydantic_fields_set__': 'set[str]', '__pydantic_generic_metadata__': 'ClassVar[_generics.PydanticGenericMetadata]', '__pydantic_parent_namespace__': 'ClassVar[Dict[str, Any] | None]', '__pydantic_post_init__': "ClassVar[None | Literal['model_post_init']]", '__pydantic_private__': 'dict[str, Any] | None', '__pydantic_root_model__': 'ClassVar[bool]', '__pydantic_serializer__': 'ClassVar[SchemaSerializer]', '__pydantic_validator__': 'ClassVar[SchemaValidator | PluggableSchemaValidator]', '__signature__': 'ClassVar[Signature]', 'data': <class 'kittycad.models.default_camera_set_perspective.DefaultCameraSetPerspective'>, 'model_computed_fields': 'ClassVar[Dict[str, ComputedFieldInfo]]', 'model_config': 'ClassVar[ConfigDict]', 'model_fields': 'ClassVar[Dict[str, FieldInfo]]', 'type': typing.Literal['default_camera_set_perspective']}[source]

classmethod __class_getitem__(typevar_values)[source]

Return type:: type[BaseModel] | PydanticRecursiveRef

__class_vars__: ClassVar[set[str]] = {}[source]: The names of the class variables defined on the model.

__copy__()[source]

Returns a shallow copy of the model.

Return type:: Self

__deepcopy__(memo=None)[source]

Returns a deep copy of the model.

Return type:: Self

__delattr__(item)[source]

Implement delattr(self, name).

Return type:: Any

__dict__[source]

__eq__(other)[source]

Return self==value.

Return type:: bool

property __fields_set__: set[str][source]

classmethod __get_pydantic_core_schema__(source, handler, /)[source]

Hook into generating the model’s CoreSchema.

Parameters:

source (type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.
handler (GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.

Return type:

Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]

Returns:

A pydantic-core CoreSchema.

classmethod __get_pydantic_json_schema__(core_schema, handler, /)[source]

Hook into generating the model’s JSON schema.

Parameters:

core_schema (Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({'type': 'nullable', 'schema': current_schema}), or just call the handler with the original schema.
handler (GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.

Return type:

Returns:

A JSON schema, as a Python object.

__getattr__(item)[source]

Return type:: Any

__getstate__()[source]

Helper for pickle.

Return type:: dict[Any, Any]

__hash__ = None[source]

__init__(**data)[source]

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__iter__()[source]

So dict(model) works.

Return type:: Generator[Tuple[str, Any], None, None]

__module__ = 'kittycad.models.ok_modeling_cmd_response'[source]

__pretty__(fmt, **kwargs)[source]

Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.

Return type:: Generator[Any, None, None]

__private_attributes__: ClassVar[Dict[str, ModelPrivateAttr]] = {}[source]: Metadata about the private attributes of the model.

__pydantic_complete__: ClassVar[bool] = True[source]: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__: ClassVar[CoreSchema] = {'cls': <class 'kittycad.models.ok_modeling_cmd_response.OptionDefaultCameraSetPerspective'>, 'config': {'title': 'OptionDefaultCameraSetPerspective'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.ok_modeling_cmd_response.OptionDefaultCameraSetPerspective'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.ok_modeling_cmd_response.OptionDefaultCameraSetPerspective'>>]}, 'ref': 'kittycad.models.ok_modeling_cmd_response.OptionDefaultCameraSetPerspective:94667213177232', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'data': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.default_camera_set_perspective.DefaultCameraSetPerspective'>, 'config': {'title': 'DefaultCameraSetPerspective'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.default_camera_set_perspective.DefaultCameraSetPerspective'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.default_camera_set_perspective.DefaultCameraSetPerspective'>>]}, 'ref': 'kittycad.models.default_camera_set_perspective.DefaultCameraSetPerspective:94667206016848', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {}, 'model_name': 'DefaultCameraSetPerspective', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}, 'type': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': 'default_camera_set_perspective', 'schema': {'expected': ['default_camera_set_perspective'], 'type': 'literal'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'OptionDefaultCameraSetPerspective', 'type': 'model-fields'}, 'type': 'model'}[source]: The core schema of the model.

__pydantic_custom_init__: ClassVar[bool] = False[source]: Whether the model has a custom __init__ method.

__pydantic_decorators__: ClassVar[_decorators.DecoratorInfos] = DecoratorInfos(validators={}, field_validators={}, root_validators={}, field_serializers={}, model_serializers={}, model_validators={}, computed_fields={})[source]: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_extra__: dict[str, Any] | None[source]: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to 'allow'.

__pydantic_fields_set__: set[str][source]: The names of fields explicitly set during instantiation.

__pydantic_generic_metadata__: ClassVar[_generics.PydanticGenericMetadata] = {'args': (), 'origin': None, 'parameters': ()}[source]: 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.

classmethod __pydantic_init_subclass__(**kwargs)[source]

This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.

This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.

This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.

Parameters:: **kwargs (Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.
Return type:: None

__pydantic_parent_namespace__: ClassVar[Dict[str, Any] | None] = None[source]: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__: ClassVar[None | Literal['model_post_init']] = None[source]: The name of the post-init method for the model, if defined.

__pydantic_private__: dict[str, Any] | None[source]: Values of private attributes set on the model instance.

__pydantic_root_model__: ClassVar[bool] = False[source]: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__: ClassVar[SchemaSerializer] = SchemaSerializer(serializer=Model( ModelSerializer { class: Py( 0x000056196d9d0190, ), serializer: Fields( GeneralFieldsSerializer { fields: { "type": SerField { key_py: Py( 0x00007f903823d958, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f9034696920, ), ), serializer: Literal( LiteralSerializer { expected_int: {}, expected_str: { "default_camera_set_perspective", }, expected_py: None, name: "literal['default_camera_set_perspective']", }, ), }, ), ), required: true, }, "data": SerField { key_py: Py( 0x00007f9038238fa0, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196d2fbf50, ), serializer: Fields( GeneralFieldsSerializer { fields: {}, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 0, }, ), has_extra: false, root_model: false, name: "DefaultCameraSetPerspective", }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "OptionDefaultCameraSetPerspective", }, ), definitions=[])[source]: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__: ClassVar[SchemaValidator | PluggableSchemaValidator] = SchemaValidator(title="OptionDefaultCameraSetPerspective", validator=Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "data", lookup_key: Simple { key: "data", py_key: Py( 0x00007f9033521500, ), path: LookupPath( [ S( "data", Py( 0x00007f9033521530, ), ), ], ), }, name_py: Py( 0x00007f9038238fa0, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [], model_name: "DefaultCameraSetPerspective", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d2fbf50, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "DefaultCameraSetPerspective", }, ), frozen: false, }, Field { name: "type", lookup_key: Simple { key: "type", py_key: Py( 0x00007f9033521560, ), path: LookupPath( [ S( "type", Py( 0x00007f9033521590, ), ), ], ), }, name_py: Py( 0x00007f903823d958, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f9034696920, ), ), on_error: Raise, validator: Literal( LiteralValidator { lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "default_camera_set_perspective": 0, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f9034696920, ), ], }, expected_repr: "'default_camera_set_perspective'", name: "literal['default_camera_set_perspective']", }, ), validate_default: false, copy_default: false, name: "default[literal['default_camera_set_perspective']]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "OptionDefaultCameraSetPerspective", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d9d0190, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "OptionDefaultCameraSetPerspective", }, ), definitions=[], cache_strings=True)[source]: The pydantic-core SchemaValidator used to validate instances of the model.

__repr__()[source]

Return repr(self).

Return type:: str

__repr_args__()[source]

Return type:: Iterable[tuple[str | None, Any]]

__repr_name__()[source]

Name of the instance’s class, used in __repr__.

Return type:: str

__repr_str__(join_str)[source]

Return type:: str

__rich_repr__()[source]

Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.

Return type:: Iterable[Any | tuple[Any] | tuple[str, Any] | tuple[str, Any, Any]]

__setattr__(name, value)[source]

Implement setattr(self, name, value).

Return type:: None

__setstate__(state)[source]

Return type:: None

__signature__: ClassVar[Signature] = <Signature (*, data: kittycad.models.default_camera_set_perspective.DefaultCameraSetPerspective, type: Literal['default_camera_set_perspective'] = 'default_camera_set_perspective') -> None>[source]: The synthesized __init__ [Signature][inspect.Signature] of the model.

__slots__ = ('__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__')[source]

__str__()[source]

Return str(self).

Return type:: str

_abc_impl = <_abc._abc_data object>[source]

_calculate_keys(*args, **kwargs)[source]

Return type:: Any

_check_frozen(name, value)[source]

Return type:: None

_copy_and_set_values(*args, **kwargs)[source]

Return type:: Any

classmethod _get_value(*args, **kwargs)[source]

Return type:: Any

_iter(*args, **kwargs)[source]

Return type:: Any

classmethod construct(_fields_set=None, **values)[source]

Return type:: Self

copy(*, include=None, exclude=None, update=None, deep=False)[source]

Returns a copy of the model.

!!! warning “Deprecated”: This method is now deprecated; use model_copy instead.

If you need include or exclude, use:

`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `

Parameters:

include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.

Returns:

A copy of the model with included, excluded and updated fields as specified.

data: DefaultCameraSetPerspective[source]

dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)[source]

Return type:: Dict[str, Any]

classmethod from_orm(obj)[source]

Return type:: Self

json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)[source]

Return type:: str

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}[source]: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'protected_namespaces': ()}[source]: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod model_construct(_fields_set=None, **values)[source]

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note: model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == 'allow', then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == 'ignore' (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == 'forbid' does not result in an error if extra values are passed, but they will be ignored.

Parameters:

_fields_set (set[str] | None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.
values (Any) – Trusted or pre-validated data dictionary.

Return type:

Self

Returns:

A new instance of the Model class with validated data.

model_copy(*, update=None, deep=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy

Returns a copy of the model.

Parameters:

update (dict[str, Any] | None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.
deep (bool) – Set to True to make a deep copy of the model.

Return type:

Self

Returns:

New model instance.

model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters:

mode (Union[Literal['json', 'python'], str]) – The mode in which to_python 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.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to include in the output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to exclude from the output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to use the field’s alias in the dictionary key if defined.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A dictionary representation of the model.

model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

Generates a JSON representation of the model using Pydantic’s to_json method.

Parameters:

indent (int | None) – Indentation to use in the JSON output. If None is passed, the output will be compact.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to include in the JSON output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to exclude from the JSON output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to serialize using field aliases.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A JSON string representation of the model.

property model_extra: dict[str, Any] | None[source]

Get extra fields set during validation.

Returns:: A dictionary of extra fields, or None if config.extra is not set to "allow".

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=DefaultCameraSetPerspective, required=True), 'type': FieldInfo(annotation=Literal['default_camera_set_perspective'], required=False, default='default_camera_set_perspective')}[source]

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

property model_fields_set: set[str][source]

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,: i.e. that were not filled from defaults.

classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')[source]

Generates a JSON schema for a model class.

Parameters:

by_alias (bool) – Whether to use attribute aliases or not.
ref_template (str) – The reference template.
schema_generator (type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modifications
mode (Literal['validation', 'serialization']) – The mode in which to generate the schema.

Return type:

Returns:

The JSON schema for the given model class.

classmethod model_parametrized_name(params)[source]

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

Parameters:: params (tuple[type[Any], ...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.
Return type:: str
Returns:: String representing the new class where params are passed to cls as type variables.
Raises:: TypeError – Raised when trying to generate concrete names for non-generic models.

model_post_init(_BaseModel__context)[source]

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

Return type:: None

classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)[source]

Try to rebuild the pydantic-core schema for the model.

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.

Parameters:

force (bool) – Whether to force the rebuilding of the model schema, defaults to False.
raise_errors (bool) – Whether to raise errors, defaults to True.
_parent_namespace_depth (int) – The depth level of the parent namespace, defaults to 2.
_types_namespace (dict[str, Any] | None) – The types namespace, defaults to None.

Return type:

Returns:

Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.

classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)[source]

Validate a pydantic model instance.

Parameters:

obj (Any) – The object to validate.
strict (bool | None) – Whether to enforce types strictly.
from_attributes (bool | None) – Whether to extract data from object attributes.
context (Any | None) – Additional context to pass to the validator.

Raises:

ValidationError – If the object could not be validated.

Return type:

Self

Returns:

The validated model instance.

classmethod model_validate_json(json_data, *, strict=None, context=None)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing

Validate the given JSON data against the Pydantic model.

Parameters:

json_data (str | bytes | bytearray) – The JSON data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

Raises:

ValidationError – If json_data is not a JSON string or the object could not be validated.

classmethod model_validate_strings(obj, *, strict=None, context=None)[source]

Validate the given object with string data against the Pydantic model.

Parameters:

obj (Any) – The object containing string data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod parse_obj(obj)[source]

Return type:: Self

classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod schema(by_alias=True, ref_template='#/$defs/{model}')[source]

Return type:: Dict[str, Any]

classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)[source]

Return type:: str

type: Literal['default_camera_set_perspective'][source]

classmethod update_forward_refs(**localns)[source]

Return type:: None

classmethod validate(value)[source]

Return type:: Self

class kittycad.models.ok_modeling_cmd_response.OptionDefaultCameraZoom(**data)[source][source]

The response to the ‘DefaultCameraZoom’ endpoint

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__abstractmethods__ = frozenset({})[source]

__annotations__ = {'__class_vars__': 'ClassVar[set[str]]', '__private_attributes__': 'ClassVar[Dict[str, ModelPrivateAttr]]', '__pydantic_complete__': 'ClassVar[bool]', '__pydantic_core_schema__': 'ClassVar[CoreSchema]', '__pydantic_custom_init__': 'ClassVar[bool]', '__pydantic_decorators__': 'ClassVar[_decorators.DecoratorInfos]', '__pydantic_extra__': 'dict[str, Any] | None', '__pydantic_fields_set__': 'set[str]', '__pydantic_generic_metadata__': 'ClassVar[_generics.PydanticGenericMetadata]', '__pydantic_parent_namespace__': 'ClassVar[Dict[str, Any] | None]', '__pydantic_post_init__': "ClassVar[None | Literal['model_post_init']]", '__pydantic_private__': 'dict[str, Any] | None', '__pydantic_root_model__': 'ClassVar[bool]', '__pydantic_serializer__': 'ClassVar[SchemaSerializer]', '__pydantic_validator__': 'ClassVar[SchemaValidator | PluggableSchemaValidator]', '__signature__': 'ClassVar[Signature]', 'data': <class 'kittycad.models.default_camera_zoom.DefaultCameraZoom'>, 'model_computed_fields': 'ClassVar[Dict[str, ComputedFieldInfo]]', 'model_config': 'ClassVar[ConfigDict]', 'model_fields': 'ClassVar[Dict[str, FieldInfo]]', 'type': typing.Literal['default_camera_zoom']}[source]

classmethod __class_getitem__(typevar_values)[source]

Return type:: type[BaseModel] | PydanticRecursiveRef

__class_vars__: ClassVar[set[str]] = {}[source]: The names of the class variables defined on the model.

__copy__()[source]

Returns a shallow copy of the model.

Return type:: Self

__deepcopy__(memo=None)[source]

Returns a deep copy of the model.

Return type:: Self

__delattr__(item)[source]

Implement delattr(self, name).

Return type:: Any

__dict__[source]

__eq__(other)[source]

Return self==value.

Return type:: bool

property __fields_set__: set[str][source]

classmethod __get_pydantic_core_schema__(source, handler, /)[source]

Hook into generating the model’s CoreSchema.

Parameters:

source (type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.
handler (GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.

Return type:

Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]

Returns:

A pydantic-core CoreSchema.

classmethod __get_pydantic_json_schema__(core_schema, handler, /)[source]

Hook into generating the model’s JSON schema.

Parameters:

core_schema (Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({'type': 'nullable', 'schema': current_schema}), or just call the handler with the original schema.
handler (GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.

Return type:

Returns:

A JSON schema, as a Python object.

__getattr__(item)[source]

Return type:: Any

__getstate__()[source]

Helper for pickle.

Return type:: dict[Any, Any]

__hash__ = None[source]

__init__(**data)[source]

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__iter__()[source]

So dict(model) works.

Return type:: Generator[Tuple[str, Any], None, None]

__module__ = 'kittycad.models.ok_modeling_cmd_response'[source]

__pretty__(fmt, **kwargs)[source]

Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.

Return type:: Generator[Any, None, None]

__private_attributes__: ClassVar[Dict[str, ModelPrivateAttr]] = {}[source]: Metadata about the private attributes of the model.

__pydantic_complete__: ClassVar[bool] = True[source]: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__: ClassVar[CoreSchema] = {'definitions': [{'cls': <class 'kittycad.models.point3d.Point3d'>, 'config': {'title': 'Point3d'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.point3d.Point3d'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.point3d.Point3d'>>]}, 'ref': 'kittycad.models.point3d.Point3d:94667194426368', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'x': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'type': 'float'}, 'type': 'model-field'}, 'y': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'type': 'float'}, 'type': 'model-field'}, 'z': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'type': 'float'}, 'type': 'model-field'}}, 'model_name': 'Point3d', 'type': 'model-fields'}, 'type': 'model'}], 'schema': {'cls': <class 'kittycad.models.ok_modeling_cmd_response.OptionDefaultCameraZoom'>, 'config': {'title': 'OptionDefaultCameraZoom'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.ok_modeling_cmd_response.OptionDefaultCameraZoom'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.ok_modeling_cmd_response.OptionDefaultCameraZoom'>>]}, 'ref': 'kittycad.models.ok_modeling_cmd_response.OptionDefaultCameraZoom:94667213416432', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'data': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.default_camera_zoom.DefaultCameraZoom'>, 'config': {'title': 'DefaultCameraZoom'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.default_camera_zoom.DefaultCameraZoom'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.default_camera_zoom.DefaultCameraZoom'>>]}, 'ref': 'kittycad.models.default_camera_zoom.DefaultCameraZoom:94667206019440', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'settings': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.camera_settings.CameraSettings'>, 'config': {'title': 'CameraSettings'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.camera_settings.CameraSettings'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.camera_settings.CameraSettings'>>]}, 'ref': 'kittycad.models.camera_settings.CameraSettings:94667204631840', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'center': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'schema_ref': 'kittycad.models.point3d.Point3d:94667194426368', 'type': 'definition-ref'}, 'type': 'model-field'}, 'fov_y': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': None, 'schema': {'schema': {'type': 'float'}, 'type': 'nullable'}, 'type': 'default'}, 'type': 'model-field'}, 'orientation': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.point4d.Point4d'>, 'config': {'title': 'Point4d'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.point4d.Point4d'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.point4d.Point4d'>>]}, 'ref': 'kittycad.models.point4d.Point4d:94667204627760', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'w': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'type': 'float'}, 'type': 'model-field'}, 'x': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'type': 'float'}, 'type': 'model-field'}, 'y': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'type': 'float'}, 'type': 'model-field'}, 'z': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'type': 'float'}, 'type': 'model-field'}}, 'model_name': 'Point4d', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}, 'ortho': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'type': 'bool'}, 'type': 'model-field'}, 'ortho_scale': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': None, 'schema': {'schema': {'type': 'float'}, 'type': 'nullable'}, 'type': 'default'}, 'type': 'model-field'}, 'pos': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'schema_ref': 'kittycad.models.point3d.Point3d:94667194426368', 'type': 'definition-ref'}, 'type': 'model-field'}, 'up': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'schema_ref': 'kittycad.models.point3d.Point3d:94667194426368', 'type': 'definition-ref'}, 'type': 'model-field'}}, 'model_name': 'CameraSettings', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}}, 'model_name': 'DefaultCameraZoom', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}, 'type': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': 'default_camera_zoom', 'schema': {'expected': ['default_camera_zoom'], 'type': 'literal'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'OptionDefaultCameraZoom', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'definitions'}[source]: The core schema of the model.

__pydantic_custom_init__: ClassVar[bool] = False[source]: Whether the model has a custom __init__ method.

__pydantic_decorators__: ClassVar[_decorators.DecoratorInfos] = DecoratorInfos(validators={}, field_validators={}, root_validators={}, field_serializers={}, model_serializers={}, model_validators={}, computed_fields={})[source]: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_extra__: dict[str, Any] | None[source]: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to 'allow'.

__pydantic_fields_set__: set[str][source]: The names of fields explicitly set during instantiation.

__pydantic_generic_metadata__: ClassVar[_generics.PydanticGenericMetadata] = {'args': (), 'origin': None, 'parameters': ()}[source]: 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.

classmethod __pydantic_init_subclass__(**kwargs)[source]

This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.

This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.

This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.

Parameters:: **kwargs (Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.
Return type:: None

__pydantic_parent_namespace__: ClassVar[Dict[str, Any] | None] = None[source]: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__: ClassVar[None | Literal['model_post_init']] = None[source]: The name of the post-init method for the model, if defined.

__pydantic_private__: dict[str, Any] | None[source]: Values of private attributes set on the model instance.

__pydantic_root_model__: ClassVar[bool] = False[source]: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__: ClassVar[SchemaSerializer] = SchemaSerializer(serializer=Model( ModelSerializer { class: Py( 0x000056196da0a7f0, ), serializer: Fields( GeneralFieldsSerializer { fields: { "type": SerField { key_py: Py( 0x00007f903823d958, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f9034c77a70, ), ), serializer: Literal( LiteralSerializer { expected_int: {}, expected_str: { "default_camera_zoom", }, expected_py: None, name: "literal['default_camera_zoom']", }, ), }, ), ), required: true, }, "data": SerField { key_py: Py( 0x00007f9038238fa0, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196d2fc970, ), serializer: Fields( GeneralFieldsSerializer { fields: { "settings": SerField { key_py: Py( 0x00007f903711fa30, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196d1a9d20, ), serializer: Fields( GeneralFieldsSerializer { fields: { "fov_y": SerField { key_py: Py( 0x00007f9033e16400, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f9038148100, ), ), serializer: Nullable( NullableSerializer { serializer: Float( FloatSerializer { inf_nan_mode: Null, }, ), }, ), }, ), ), required: true, }, "orientation": SerField { key_py: Py( 0x00007f9033c27ef0, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196d1a8d30, ), serializer: Fields( GeneralFieldsSerializer { fields: { "w": SerField { key_py: Py( 0x00007f903823f4f8, ), alias: None, alias_py: None, serializer: Some( Float( FloatSerializer { inf_nan_mode: Null, }, ), ), required: true, }, "x": SerField { key_py: Py( 0x00007f903823de18, ), alias: None, alias_py: None, serializer: Some( Float( FloatSerializer { inf_nan_mode: Null, }, ), ), required: true, }, "y": SerField { key_py: Py( 0x00007f903823f558, ), alias: None, alias_py: None, serializer: Some( Float( FloatSerializer { inf_nan_mode: Null, }, ), ), required: true, }, "z": SerField { key_py: Py( 0x00007f903823f588, ), alias: None, alias_py: None, serializer: Some( Float( FloatSerializer { inf_nan_mode: Null, }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 4, }, ), has_extra: false, root_model: false, name: "Point4d", }, ), ), required: true, }, "up": SerField { key_py: Py( 0x00007f9036ff7720, ), alias: None, alias_py: None, serializer: Some( Recursive( DefinitionRefSerializer { definition: "...", retry_with_lax_check: true, }, ), ), required: true, }, "ortho": SerField { key_py: Py( 0x00007f9033e16550, ), alias: None, alias_py: None, serializer: Some( Bool( BoolSerializer, ), ), required: true, }, "center": SerField { key_py: Py( 0x00007f9037b08150, ), alias: None, alias_py: None, serializer: Some( Recursive( DefinitionRefSerializer { definition: "...", retry_with_lax_check: true, }, ), ), required: true, }, "pos": SerField { key_py: Py( 0x00007f903823c150, ), alias: None, alias_py: None, serializer: Some( Recursive( DefinitionRefSerializer { definition: "...", retry_with_lax_check: true, }, ), ), required: true, }, "ortho_scale": SerField { key_py: Py( 0x00007f9033c27eb0, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f9038148100, ), ), serializer: Nullable( NullableSerializer { serializer: Float( FloatSerializer { inf_nan_mode: Null, }, ), }, ), }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 7, }, ), has_extra: false, root_model: false, name: "CameraSettings", }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 1, }, ), has_extra: false, root_model: false, name: "DefaultCameraZoom", }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "OptionDefaultCameraZoom", }, ), definitions=[Model(ModelSerializer { class: Py(0x56196c7ee400), serializer: Fields(GeneralFieldsSerializer { fields: {"z": SerField { key_py: Py(0x7f903823f588), alias: None, alias_py: None, serializer: Some(Float(FloatSerializer { inf_nan_mode: Null })), required: true }, "x": SerField { key_py: Py(0x7f903823de18), alias: None, alias_py: None, serializer: Some(Float(FloatSerializer { inf_nan_mode: Null })), required: true }, "y": SerField { key_py: Py(0x7f903823f558), alias: None, alias_py: None, serializer: Some(Float(FloatSerializer { inf_nan_mode: Null })), required: true }}, computed_fields: Some(ComputedFields([])), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None }, required_fields: 3 }), has_extra: false, root_model: false, name: "Point3d" })])[source]: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__: ClassVar[SchemaValidator | PluggableSchemaValidator] = SchemaValidator(title="OptionDefaultCameraZoom", validator=Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "data", lookup_key: Simple { key: "data", py_key: Py( 0x00007f903336c630, ), path: LookupPath( [ S( "data", Py( 0x00007f903336c660, ), ), ], ), }, name_py: Py( 0x00007f9038238fa0, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "settings", lookup_key: Simple { key: "settings", py_key: Py( 0x00007f90333769b0, ), path: LookupPath( [ S( "settings", Py( 0x00007f90333769f0, ), ), ], ), }, name_py: Py( 0x00007f903711fa30, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "center", lookup_key: Simple { key: "center", py_key: Py( 0x00007f903336c450, ), path: LookupPath( [ S( "center", Py( 0x00007f903336c480, ), ), ], ), }, name_py: Py( 0x00007f9037b08150, ), validator: DefinitionRef( DefinitionRefValidator { definition: "...", }, ), frozen: false, }, Field { name: "fov_y", lookup_key: Simple { key: "fov_y", py_key: Py( 0x00007f903336c4b0, ), path: LookupPath( [ S( "fov_y", Py( 0x00007f903336c4e0, ), ), ], ), }, name_py: Py( 0x00007f9033e16400, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f9038148100, ), ), on_error: Raise, validator: Nullable( NullableValidator { validator: Float( FloatValidator { strict: false, allow_inf_nan: true, }, ), name: "nullable[float]", }, ), validate_default: false, copy_default: false, name: "default[nullable[float]]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, Field { name: "orientation", lookup_key: Simple { key: "orientation", py_key: Py( 0x00007f90333768f0, ), path: LookupPath( [ S( "orientation", Py( 0x00007f90333768b0, ), ), ], ), }, name_py: Py( 0x00007f9033c27ef0, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "w", lookup_key: Simple { key: "w", py_key: Py( 0x00007f903823f4f8, ), path: LookupPath( [ S( "w", Py( 0x00007f903823f4f8, ), ), ], ), }, name_py: Py( 0x00007f903823f4f8, ), validator: Float( FloatValidator { strict: false, allow_inf_nan: true, }, ), frozen: false, }, Field { name: "x", lookup_key: Simple { key: "x", py_key: Py( 0x00007f903823f528, ), path: LookupPath( [ S( "x", Py( 0x00007f903823f528, ), ), ], ), }, name_py: Py( 0x00007f903823de18, ), validator: Float( FloatValidator { strict: false, allow_inf_nan: true, }, ), frozen: false, }, Field { name: "y", lookup_key: Simple { key: "y", py_key: Py( 0x00007f903823f558, ), path: LookupPath( [ S( "y", Py( 0x00007f903823f558, ), ), ], ), }, name_py: Py( 0x00007f903823f558, ), validator: Float( FloatValidator { strict: false, allow_inf_nan: true, }, ), frozen: false, }, Field { name: "z", lookup_key: Simple { key: "z", py_key: Py( 0x00007f903823f588, ), path: LookupPath( [ S( "z", Py( 0x00007f903823f588, ), ), ], ), }, name_py: Py( 0x00007f903823f588, ), validator: Float( FloatValidator { strict: false, allow_inf_nan: true, }, ), frozen: false, }, ], model_name: "Point4d", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d1a8d30, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "Point4d", }, ), frozen: false, }, Field { name: "ortho", lookup_key: Simple { key: "ortho", py_key: Py( 0x00007f903336c510, ), path: LookupPath( [ S( "ortho", Py( 0x00007f903336c540, ), ), ], ), }, name_py: Py( 0x00007f9033e16550, ), validator: Bool( BoolValidator { strict: false, }, ), frozen: false, }, Field { name: "ortho_scale", lookup_key: Simple { key: "ortho_scale", py_key: Py( 0x00007f9033376970, ), path: LookupPath( [ S( "ortho_scale", Py( 0x00007f9033376930, ), ), ], ), }, name_py: Py( 0x00007f9033c27eb0, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f9038148100, ), ), on_error: Raise, validator: Nullable( NullableValidator { validator: Float( FloatValidator { strict: false, allow_inf_nan: true, }, ), name: "nullable[float]", }, ), validate_default: false, copy_default: false, name: "default[nullable[float]]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, Field { name: "pos", lookup_key: Simple { key: "pos", py_key: Py( 0x00007f903336c570, ), path: LookupPath( [ S( "pos", Py( 0x00007f903336c5a0, ), ), ], ), }, name_py: Py( 0x00007f903823c150, ), validator: DefinitionRef( DefinitionRefValidator { definition: "...", }, ), frozen: false, }, Field { name: "up", lookup_key: Simple { key: "up", py_key: Py( 0x00007f903336c5d0, ), path: LookupPath( [ S( "up", Py( 0x00007f903336c600, ), ), ], ), }, name_py: Py( 0x00007f9036ff7720, ), validator: DefinitionRef( DefinitionRefValidator { definition: "...", }, ), frozen: false, }, ], model_name: "CameraSettings", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d1a9d20, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "CameraSettings", }, ), frozen: false, }, ], model_name: "DefaultCameraZoom", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d2fc970, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "DefaultCameraZoom", }, ), frozen: false, }, Field { name: "type", lookup_key: Simple { key: "type", py_key: Py( 0x00007f903336c690, ), path: LookupPath( [ S( "type", Py( 0x00007f903336c6c0, ), ), ], ), }, name_py: Py( 0x00007f903823d958, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f9034c77a70, ), ), on_error: Raise, validator: Literal( LiteralValidator { lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "default_camera_zoom": 0, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f9034c77a70, ), ], }, expected_repr: "'default_camera_zoom'", name: "literal['default_camera_zoom']", }, ), validate_default: false, copy_default: false, name: "default[literal['default_camera_zoom']]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "OptionDefaultCameraZoom", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196da0a7f0, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "OptionDefaultCameraZoom", }, ), definitions=[Model(ModelValidator { revalidate: Never, validator: ModelFields(ModelFieldsValidator { fields: [Field { name: "x", lookup_key: Simple { key: "x", py_key: Py(0x7f903823f528), path: LookupPath([S("x", Py(0x7f903823f528))]) }, name_py: Py(0x7f903823de18), validator: Float(FloatValidator { strict: false, allow_inf_nan: true }), frozen: false }, Field { name: "y", lookup_key: Simple { key: "y", py_key: Py(0x7f903823f558), path: LookupPath([S("y", Py(0x7f903823f558))]) }, name_py: Py(0x7f903823f558), validator: Float(FloatValidator { strict: false, allow_inf_nan: true }), frozen: false }, Field { name: "z", lookup_key: Simple { key: "z", py_key: Py(0x7f903823f588), path: LookupPath([S("z", Py(0x7f903823f588))]) }, name_py: Py(0x7f903823f588), validator: Float(FloatValidator { strict: false, allow_inf_nan: true }), frozen: false }], model_name: "Point3d", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true }), class: Py(0x56196c7ee400), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py(0x7f903629a320), name: "Point3d" })], cache_strings=True)[source]: The pydantic-core SchemaValidator used to validate instances of the model.

__repr__()[source]

Return repr(self).

Return type:: str

__repr_args__()[source]

Return type:: Iterable[tuple[str | None, Any]]

__repr_name__()[source]

Name of the instance’s class, used in __repr__.

Return type:: str

__repr_str__(join_str)[source]

Return type:: str

__rich_repr__()[source]

Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.

Return type:: Iterable[Any | tuple[Any] | tuple[str, Any] | tuple[str, Any, Any]]

__setattr__(name, value)[source]

Implement setattr(self, name, value).

Return type:: None

__setstate__(state)[source]

Return type:: None

__signature__: ClassVar[Signature] = <Signature (*, data: kittycad.models.default_camera_zoom.DefaultCameraZoom, type: Literal['default_camera_zoom'] = 'default_camera_zoom') -> None>[source]: The synthesized __init__ [Signature][inspect.Signature] of the model.

__slots__ = ('__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__')[source]

__str__()[source]

Return str(self).

Return type:: str

_abc_impl = <_abc._abc_data object>[source]

_calculate_keys(*args, **kwargs)[source]

Return type:: Any

_check_frozen(name, value)[source]

Return type:: None

_copy_and_set_values(*args, **kwargs)[source]

Return type:: Any

classmethod _get_value(*args, **kwargs)[source]

Return type:: Any

_iter(*args, **kwargs)[source]

Return type:: Any

classmethod construct(_fields_set=None, **values)[source]

Return type:: Self

copy(*, include=None, exclude=None, update=None, deep=False)[source]

Returns a copy of the model.

!!! warning “Deprecated”: This method is now deprecated; use model_copy instead.

If you need include or exclude, use:

`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `

Parameters:

include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.

Returns:

A copy of the model with included, excluded and updated fields as specified.

data: DefaultCameraZoom[source]

dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)[source]

Return type:: Dict[str, Any]

classmethod from_orm(obj)[source]

Return type:: Self

json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)[source]

Return type:: str

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}[source]: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'protected_namespaces': ()}[source]: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod model_construct(_fields_set=None, **values)[source]

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note: model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == 'allow', then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == 'ignore' (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == 'forbid' does not result in an error if extra values are passed, but they will be ignored.

Parameters:

_fields_set (set[str] | None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.
values (Any) – Trusted or pre-validated data dictionary.

Return type:

Self

Returns:

A new instance of the Model class with validated data.

model_copy(*, update=None, deep=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy

Returns a copy of the model.

Parameters:

update (dict[str, Any] | None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.
deep (bool) – Set to True to make a deep copy of the model.

Return type:

Self

Returns:

New model instance.

model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters:

mode (Union[Literal['json', 'python'], str]) – The mode in which to_python 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.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to include in the output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to exclude from the output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to use the field’s alias in the dictionary key if defined.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A dictionary representation of the model.

model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

Generates a JSON representation of the model using Pydantic’s to_json method.

Parameters:

indent (int | None) – Indentation to use in the JSON output. If None is passed, the output will be compact.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to include in the JSON output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to exclude from the JSON output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to serialize using field aliases.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A JSON string representation of the model.

property model_extra: dict[str, Any] | None[source]

Get extra fields set during validation.

Returns:: A dictionary of extra fields, or None if config.extra is not set to "allow".

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=DefaultCameraZoom, required=True), 'type': FieldInfo(annotation=Literal['default_camera_zoom'], required=False, default='default_camera_zoom')}[source]

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

property model_fields_set: set[str][source]

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,: i.e. that were not filled from defaults.

classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')[source]

Generates a JSON schema for a model class.

Parameters:

by_alias (bool) – Whether to use attribute aliases or not.
ref_template (str) – The reference template.
schema_generator (type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modifications
mode (Literal['validation', 'serialization']) – The mode in which to generate the schema.

Return type:

Returns:

The JSON schema for the given model class.

classmethod model_parametrized_name(params)[source]

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

Parameters:: params (tuple[type[Any], ...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.
Return type:: str
Returns:: String representing the new class where params are passed to cls as type variables.
Raises:: TypeError – Raised when trying to generate concrete names for non-generic models.

model_post_init(_BaseModel__context)[source]

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

Return type:: None

classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)[source]

Try to rebuild the pydantic-core schema for the model.

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.

Parameters:

force (bool) – Whether to force the rebuilding of the model schema, defaults to False.
raise_errors (bool) – Whether to raise errors, defaults to True.
_parent_namespace_depth (int) – The depth level of the parent namespace, defaults to 2.
_types_namespace (dict[str, Any] | None) – The types namespace, defaults to None.

Return type:

Returns:

Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.

classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)[source]

Validate a pydantic model instance.

Parameters:

obj (Any) – The object to validate.
strict (bool | None) – Whether to enforce types strictly.
from_attributes (bool | None) – Whether to extract data from object attributes.
context (Any | None) – Additional context to pass to the validator.

Raises:

ValidationError – If the object could not be validated.

Return type:

Self

Returns:

The validated model instance.

classmethod model_validate_json(json_data, *, strict=None, context=None)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing

Validate the given JSON data against the Pydantic model.

Parameters:

json_data (str | bytes | bytearray) – The JSON data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

Raises:

ValidationError – If json_data is not a JSON string or the object could not be validated.

classmethod model_validate_strings(obj, *, strict=None, context=None)[source]

Validate the given object with string data against the Pydantic model.

Parameters:

obj (Any) – The object containing string data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod parse_obj(obj)[source]

Return type:: Self

classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod schema(by_alias=True, ref_template='#/$defs/{model}')[source]

Return type:: Dict[str, Any]

classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)[source]

Return type:: str

type: Literal['default_camera_zoom'][source]

classmethod update_forward_refs(**localns)[source]

Return type:: None

classmethod validate(value)[source]

Return type:: Self

class kittycad.models.ok_modeling_cmd_response.OptionDensity(**data)[source][source]

The response to the ‘Density’ endpoint

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__abstractmethods__ = frozenset({})[source]

__annotations__ = {'__class_vars__': 'ClassVar[set[str]]', '__private_attributes__': 'ClassVar[Dict[str, ModelPrivateAttr]]', '__pydantic_complete__': 'ClassVar[bool]', '__pydantic_core_schema__': 'ClassVar[CoreSchema]', '__pydantic_custom_init__': 'ClassVar[bool]', '__pydantic_decorators__': 'ClassVar[_decorators.DecoratorInfos]', '__pydantic_extra__': 'dict[str, Any] | None', '__pydantic_fields_set__': 'set[str]', '__pydantic_generic_metadata__': 'ClassVar[_generics.PydanticGenericMetadata]', '__pydantic_parent_namespace__': 'ClassVar[Dict[str, Any] | None]', '__pydantic_post_init__': "ClassVar[None | Literal['model_post_init']]", '__pydantic_private__': 'dict[str, Any] | None', '__pydantic_root_model__': 'ClassVar[bool]', '__pydantic_serializer__': 'ClassVar[SchemaSerializer]', '__pydantic_validator__': 'ClassVar[SchemaValidator | PluggableSchemaValidator]', '__signature__': 'ClassVar[Signature]', 'data': <class 'kittycad.models.density.Density'>, 'model_computed_fields': 'ClassVar[Dict[str, ComputedFieldInfo]]', 'model_config': 'ClassVar[ConfigDict]', 'model_fields': 'ClassVar[Dict[str, FieldInfo]]', 'type': typing.Literal['density']}[source]

classmethod __class_getitem__(typevar_values)[source]

Return type:: type[BaseModel] | PydanticRecursiveRef

__class_vars__: ClassVar[set[str]] = {}[source]: The names of the class variables defined on the model.

__copy__()[source]

Returns a shallow copy of the model.

Return type:: Self

__deepcopy__(memo=None)[source]

Returns a deep copy of the model.

Return type:: Self

__delattr__(item)[source]

Implement delattr(self, name).

Return type:: Any

__dict__[source]

__eq__(other)[source]

Return self==value.

Return type:: bool

property __fields_set__: set[str][source]

classmethod __get_pydantic_core_schema__(source, handler, /)[source]

Hook into generating the model’s CoreSchema.

Parameters:

source (type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.
handler (GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.

Return type:

Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]

Returns:

A pydantic-core CoreSchema.

classmethod __get_pydantic_json_schema__(core_schema, handler, /)[source]

Hook into generating the model’s JSON schema.

Parameters:

core_schema (Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({'type': 'nullable', 'schema': current_schema}), or just call the handler with the original schema.
handler (GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.

Return type:

Returns:

A JSON schema, as a Python object.

__getattr__(item)[source]

Return type:: Any

__getstate__()[source]

Helper for pickle.

Return type:: dict[Any, Any]

__hash__ = None[source]

__init__(**data)[source]

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__iter__()[source]

So dict(model) works.

Return type:: Generator[Tuple[str, Any], None, None]

__module__ = 'kittycad.models.ok_modeling_cmd_response'[source]

__pretty__(fmt, **kwargs)[source]

Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.

Return type:: Generator[Any, None, None]

__private_attributes__: ClassVar[Dict[str, ModelPrivateAttr]] = {}[source]: Metadata about the private attributes of the model.

__pydantic_complete__: ClassVar[bool] = True[source]: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__: ClassVar[CoreSchema] = {'cls': <class 'kittycad.models.ok_modeling_cmd_response.OptionDensity'>, 'config': {'title': 'OptionDensity'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.ok_modeling_cmd_response.OptionDensity'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.ok_modeling_cmd_response.OptionDensity'>>]}, 'ref': 'kittycad.models.ok_modeling_cmd_response.OptionDensity:94667213972016', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'data': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.density.Density'>, 'config': {'title': 'Density'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.density.Density'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.density.Density'>>]}, 'ref': 'kittycad.models.density.Density:94667206049424', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'density': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'type': 'float'}, 'type': 'model-field'}, 'output_unit': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <enum 'UnitDensity'>, 'members': [UnitDensity.LB_FT3, UnitDensity.KG_M3], 'metadata': {'pydantic_js_functions': [<function GenerateSchema._enum_schema.<locals>.get_json_schema>]}, 'ref': 'kittycad.models.unit_density.UnitDensity:94667203582912', 'sub_type': 'str', 'type': 'enum'}, 'type': 'model-field'}}, 'model_name': 'Density', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}, 'type': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': 'density', 'schema': {'expected': ['density'], 'type': 'literal'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'OptionDensity', 'type': 'model-fields'}, 'type': 'model'}[source]: The core schema of the model.

__pydantic_custom_init__: ClassVar[bool] = False[source]: Whether the model has a custom __init__ method.

__pydantic_decorators__: ClassVar[_decorators.DecoratorInfos] = DecoratorInfos(validators={}, field_validators={}, root_validators={}, field_serializers={}, model_serializers={}, model_validators={}, computed_fields={})[source]: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_extra__: dict[str, Any] | None[source]: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to 'allow'.

__pydantic_fields_set__: set[str][source]: The names of fields explicitly set during instantiation.

__pydantic_generic_metadata__: ClassVar[_generics.PydanticGenericMetadata] = {'args': (), 'origin': None, 'parameters': ()}[source]: 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.

classmethod __pydantic_init_subclass__(**kwargs)[source]

This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.

This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.

This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.

Parameters:: **kwargs (Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.
Return type:: None

__pydantic_parent_namespace__: ClassVar[Dict[str, Any] | None] = None[source]: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__: ClassVar[None | Literal['model_post_init']] = None[source]: The name of the post-init method for the model, if defined.

__pydantic_private__: dict[str, Any] | None[source]: Values of private attributes set on the model instance.

__pydantic_root_model__: ClassVar[bool] = False[source]: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__: ClassVar[SchemaSerializer] = SchemaSerializer(serializer=Model( ModelSerializer { class: Py( 0x000056196da92230, ), serializer: Fields( GeneralFieldsSerializer { fields: { "data": SerField { key_py: Py( 0x00007f9038238fa0, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196d303e90, ), serializer: Fields( GeneralFieldsSerializer { fields: { "output_unit": SerField { key_py: Py( 0x00007f903459f8b0, ), alias: None, alias_py: None, serializer: Some( Enum( EnumSerializer { class: Py( 0x000056196d0a9bc0, ), serializer: Some( Str( StrSerializer, ), ), }, ), ), required: true, }, "density": SerField { key_py: Py( 0x00007f903552e190, ), alias: None, alias_py: None, serializer: Some( Float( FloatSerializer { inf_nan_mode: Null, }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "Density", }, ), ), required: true, }, "type": SerField { key_py: Py( 0x00007f903823d958, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f903552e190, ), ), serializer: Literal( LiteralSerializer { expected_int: {}, expected_str: { "density", }, expected_py: None, name: "literal['density']", }, ), }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "OptionDensity", }, ), definitions=[])[source]: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__: ClassVar[SchemaValidator | PluggableSchemaValidator] = SchemaValidator(title="OptionDensity", validator=Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "data", lookup_key: Simple { key: "data", py_key: Py( 0x00007f90333aa4c0, ), path: LookupPath( [ S( "data", Py( 0x00007f90333aa4f0, ), ), ], ), }, name_py: Py( 0x00007f9038238fa0, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "density", lookup_key: Simple { key: "density", py_key: Py( 0x00007f90333aa460, ), path: LookupPath( [ S( "density", Py( 0x00007f90333aa490, ), ), ], ), }, name_py: Py( 0x00007f903552e190, ), validator: Float( FloatValidator { strict: false, allow_inf_nan: true, }, ), frozen: false, }, Field { name: "output_unit", lookup_key: Simple { key: "output_unit", py_key: Py( 0x00007f90333ca630, ), path: LookupPath( [ S( "output_unit", Py( 0x00007f90333ca5f0, ), ), ], ), }, name_py: Py( 0x00007f903459f8b0, ), validator: StrEnum( EnumValidator { phantom: PhantomData<_pydantic_core::validators::enum_::StrEnumValidator>, class: Py( 0x000056196d0a9bc0, ), lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "lb:ft3": 0, "kg:m3": 1, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f9033cab8f0, ), Py( 0x00007f9033cab950, ), ], }, missing: None, expected_repr: "'lb:ft3' or 'kg:m3'", strict: false, class_repr: "UnitDensity", name: "str-enum[UnitDensity]", }, ), frozen: false, }, ], model_name: "Density", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d303e90, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "Density", }, ), frozen: false, }, Field { name: "type", lookup_key: Simple { key: "type", py_key: Py( 0x00007f90333aa520, ), path: LookupPath( [ S( "type", Py( 0x00007f90333aa550, ), ), ], ), }, name_py: Py( 0x00007f903823d958, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f903552e190, ), ), on_error: Raise, validator: Literal( LiteralValidator { lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "density": 0, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f903552e190, ), ], }, expected_repr: "'density'", name: "literal['density']", }, ), validate_default: false, copy_default: false, name: "default[literal['density']]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "OptionDensity", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196da92230, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "OptionDensity", }, ), definitions=[], cache_strings=True)[source]: The pydantic-core SchemaValidator used to validate instances of the model.

__repr__()[source]

Return repr(self).

Return type:: str

__repr_args__()[source]

Return type:: Iterable[tuple[str | None, Any]]

__repr_name__()[source]

Name of the instance’s class, used in __repr__.

Return type:: str

__repr_str__(join_str)[source]

Return type:: str

__rich_repr__()[source]

Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.

Return type:: Iterable[Any | tuple[Any] | tuple[str, Any] | tuple[str, Any, Any]]

__setattr__(name, value)[source]

Implement setattr(self, name, value).

Return type:: None

__setstate__(state)[source]

Return type:: None

__signature__: ClassVar[Signature] = <Signature (*, data: kittycad.models.density.Density, type: Literal['density'] = 'density') -> None>[source]: The synthesized __init__ [Signature][inspect.Signature] of the model.

__slots__ = ('__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__')[source]

__str__()[source]

Return str(self).

Return type:: str

_abc_impl = <_abc._abc_data object>[source]

_calculate_keys(*args, **kwargs)[source]

Return type:: Any

_check_frozen(name, value)[source]

Return type:: None

_copy_and_set_values(*args, **kwargs)[source]

Return type:: Any

classmethod _get_value(*args, **kwargs)[source]

Return type:: Any

_iter(*args, **kwargs)[source]

Return type:: Any

classmethod construct(_fields_set=None, **values)[source]

Return type:: Self

copy(*, include=None, exclude=None, update=None, deep=False)[source]

Returns a copy of the model.

!!! warning “Deprecated”: This method is now deprecated; use model_copy instead.

If you need include or exclude, use:

`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `

Parameters:

include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.

Returns:

A copy of the model with included, excluded and updated fields as specified.

data: Density[source]

dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)[source]

Return type:: Dict[str, Any]

classmethod from_orm(obj)[source]

Return type:: Self

json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)[source]

Return type:: str

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}[source]: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'protected_namespaces': ()}[source]: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod model_construct(_fields_set=None, **values)[source]

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note: model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == 'allow', then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == 'ignore' (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == 'forbid' does not result in an error if extra values are passed, but they will be ignored.

Parameters:

_fields_set (set[str] | None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.
values (Any) – Trusted or pre-validated data dictionary.

Return type:

Self

Returns:

A new instance of the Model class with validated data.

model_copy(*, update=None, deep=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy

Returns a copy of the model.

Parameters:

update (dict[str, Any] | None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.
deep (bool) – Set to True to make a deep copy of the model.

Return type:

Self

Returns:

New model instance.

model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters:

mode (Union[Literal['json', 'python'], str]) – The mode in which to_python 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.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to include in the output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to exclude from the output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to use the field’s alias in the dictionary key if defined.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A dictionary representation of the model.

model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

Generates a JSON representation of the model using Pydantic’s to_json method.

Parameters:

indent (int | None) – Indentation to use in the JSON output. If None is passed, the output will be compact.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to include in the JSON output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to exclude from the JSON output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to serialize using field aliases.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A JSON string representation of the model.

property model_extra: dict[str, Any] | None[source]

Get extra fields set during validation.

Returns:: A dictionary of extra fields, or None if config.extra is not set to "allow".

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=Density, required=True), 'type': FieldInfo(annotation=Literal['density'], required=False, default='density')}[source]

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

property model_fields_set: set[str][source]

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,: i.e. that were not filled from defaults.

classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')[source]

Generates a JSON schema for a model class.

Parameters:

by_alias (bool) – Whether to use attribute aliases or not.
ref_template (str) – The reference template.
schema_generator (type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modifications
mode (Literal['validation', 'serialization']) – The mode in which to generate the schema.

Return type:

Returns:

The JSON schema for the given model class.

classmethod model_parametrized_name(params)[source]

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

Parameters:: params (tuple[type[Any], ...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.
Return type:: str
Returns:: String representing the new class where params are passed to cls as type variables.
Raises:: TypeError – Raised when trying to generate concrete names for non-generic models.

model_post_init(_BaseModel__context)[source]

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

Return type:: None

classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)[source]

Try to rebuild the pydantic-core schema for the model.

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.

Parameters:

force (bool) – Whether to force the rebuilding of the model schema, defaults to False.
raise_errors (bool) – Whether to raise errors, defaults to True.
_parent_namespace_depth (int) – The depth level of the parent namespace, defaults to 2.
_types_namespace (dict[str, Any] | None) – The types namespace, defaults to None.

Return type:

Returns:

Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.

classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)[source]

Validate a pydantic model instance.

Parameters:

obj (Any) – The object to validate.
strict (bool | None) – Whether to enforce types strictly.
from_attributes (bool | None) – Whether to extract data from object attributes.
context (Any | None) – Additional context to pass to the validator.

Raises:

ValidationError – If the object could not be validated.

Return type:

Self

Returns:

The validated model instance.

classmethod model_validate_json(json_data, *, strict=None, context=None)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing

Validate the given JSON data against the Pydantic model.

Parameters:

json_data (str | bytes | bytearray) – The JSON data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

Raises:

ValidationError – If json_data is not a JSON string or the object could not be validated.

classmethod model_validate_strings(obj, *, strict=None, context=None)[source]

Validate the given object with string data against the Pydantic model.

Parameters:

obj (Any) – The object containing string data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod parse_obj(obj)[source]

Return type:: Self

classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod schema(by_alias=True, ref_template='#/$defs/{model}')[source]

Return type:: Dict[str, Any]

classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)[source]

Return type:: str

type: Literal['density'][source]

classmethod update_forward_refs(**localns)[source]

Return type:: None

classmethod validate(value)[source]

Return type:: Self

class kittycad.models.ok_modeling_cmd_response.OptionEdgeLinesVisible(**data)[source][source]

The response to the ‘EdgeLinesVisible’ endpoint

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__abstractmethods__ = frozenset({})[source]

__annotations__ = {'__class_vars__': 'ClassVar[set[str]]', '__private_attributes__': 'ClassVar[Dict[str, ModelPrivateAttr]]', '__pydantic_complete__': 'ClassVar[bool]', '__pydantic_core_schema__': 'ClassVar[CoreSchema]', '__pydantic_custom_init__': 'ClassVar[bool]', '__pydantic_decorators__': 'ClassVar[_decorators.DecoratorInfos]', '__pydantic_extra__': 'dict[str, Any] | None', '__pydantic_fields_set__': 'set[str]', '__pydantic_generic_metadata__': 'ClassVar[_generics.PydanticGenericMetadata]', '__pydantic_parent_namespace__': 'ClassVar[Dict[str, Any] | None]', '__pydantic_post_init__': "ClassVar[None | Literal['model_post_init']]", '__pydantic_private__': 'dict[str, Any] | None', '__pydantic_root_model__': 'ClassVar[bool]', '__pydantic_serializer__': 'ClassVar[SchemaSerializer]', '__pydantic_validator__': 'ClassVar[SchemaValidator | PluggableSchemaValidator]', '__signature__': 'ClassVar[Signature]', 'data': <class 'kittycad.models.edge_lines_visible.EdgeLinesVisible'>, 'model_computed_fields': 'ClassVar[Dict[str, ComputedFieldInfo]]', 'model_config': 'ClassVar[ConfigDict]', 'model_fields': 'ClassVar[Dict[str, FieldInfo]]', 'type': typing.Literal['edge_lines_visible']}[source]

classmethod __class_getitem__(typevar_values)[source]

Return type:: type[BaseModel] | PydanticRecursiveRef

__class_vars__: ClassVar[set[str]] = {}[source]: The names of the class variables defined on the model.

__copy__()[source]

Returns a shallow copy of the model.

Return type:: Self

__deepcopy__(memo=None)[source]

Returns a deep copy of the model.

Return type:: Self

__delattr__(item)[source]

Implement delattr(self, name).

Return type:: Any

__dict__[source]

__eq__(other)[source]

Return self==value.

Return type:: bool

property __fields_set__: set[str][source]

classmethod __get_pydantic_core_schema__(source, handler, /)[source]

Hook into generating the model’s CoreSchema.

Parameters:

source (type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.
handler (GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.

Return type:

Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]

Returns:

A pydantic-core CoreSchema.

classmethod __get_pydantic_json_schema__(core_schema, handler, /)[source]

Hook into generating the model’s JSON schema.

Parameters:

core_schema (Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({'type': 'nullable', 'schema': current_schema}), or just call the handler with the original schema.
handler (GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.

Return type:

Returns:

A JSON schema, as a Python object.

__getattr__(item)[source]

Return type:: Any

__getstate__()[source]

Helper for pickle.

Return type:: dict[Any, Any]

__hash__ = None[source]

__init__(**data)[source]

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__iter__()[source]

So dict(model) works.

Return type:: Generator[Tuple[str, Any], None, None]

__module__ = 'kittycad.models.ok_modeling_cmd_response'[source]

__pretty__(fmt, **kwargs)[source]

Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.

Return type:: Generator[Any, None, None]

__private_attributes__: ClassVar[Dict[str, ModelPrivateAttr]] = {}[source]: Metadata about the private attributes of the model.

__pydantic_complete__: ClassVar[bool] = True[source]: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__: ClassVar[CoreSchema] = {'cls': <class 'kittycad.models.ok_modeling_cmd_response.OptionEdgeLinesVisible'>, 'config': {'title': 'OptionEdgeLinesVisible'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.ok_modeling_cmd_response.OptionEdgeLinesVisible'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.ok_modeling_cmd_response.OptionEdgeLinesVisible'>>]}, 'ref': 'kittycad.models.ok_modeling_cmd_response.OptionEdgeLinesVisible:94667212896704', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'data': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.edge_lines_visible.EdgeLinesVisible'>, 'config': {'title': 'EdgeLinesVisible'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.edge_lines_visible.EdgeLinesVisible'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.edge_lines_visible.EdgeLinesVisible'>>]}, 'ref': 'kittycad.models.edge_lines_visible.EdgeLinesVisible:94667206166208', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {}, 'model_name': 'EdgeLinesVisible', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}, 'type': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': 'edge_lines_visible', 'schema': {'expected': ['edge_lines_visible'], 'type': 'literal'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'OptionEdgeLinesVisible', 'type': 'model-fields'}, 'type': 'model'}[source]: The core schema of the model.

__pydantic_custom_init__: ClassVar[bool] = False[source]: Whether the model has a custom __init__ method.

__pydantic_decorators__: ClassVar[_decorators.DecoratorInfos] = DecoratorInfos(validators={}, field_validators={}, root_validators={}, field_serializers={}, model_serializers={}, model_validators={}, computed_fields={})[source]: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_extra__: dict[str, Any] | None[source]: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to 'allow'.

__pydantic_fields_set__: set[str][source]: The names of fields explicitly set during instantiation.

__pydantic_generic_metadata__: ClassVar[_generics.PydanticGenericMetadata] = {'args': (), 'origin': None, 'parameters': ()}[source]: 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.

classmethod __pydantic_init_subclass__(**kwargs)[source]

This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.

This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.

This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.

Parameters:: **kwargs (Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.
Return type:: None

__pydantic_parent_namespace__: ClassVar[Dict[str, Any] | None] = None[source]: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__: ClassVar[None | Literal['model_post_init']] = None[source]: The name of the post-init method for the model, if defined.

__pydantic_private__: dict[str, Any] | None[source]: Values of private attributes set on the model instance.

__pydantic_root_model__: ClassVar[bool] = False[source]: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__: ClassVar[SchemaSerializer] = SchemaSerializer(serializer=Model( ModelSerializer { class: Py( 0x000056196d98b9c0, ), serializer: Fields( GeneralFieldsSerializer { fields: { "data": SerField { key_py: Py( 0x00007f9038238fa0, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196d3206c0, ), serializer: Fields( GeneralFieldsSerializer { fields: {}, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 0, }, ), has_extra: false, root_model: false, name: "EdgeLinesVisible", }, ), ), required: true, }, "type": SerField { key_py: Py( 0x00007f903823d958, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f9034c75df0, ), ), serializer: Literal( LiteralSerializer { expected_int: {}, expected_str: { "edge_lines_visible", }, expected_py: None, name: "literal['edge_lines_visible']", }, ), }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "OptionEdgeLinesVisible", }, ), definitions=[])[source]: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__: ClassVar[SchemaValidator | PluggableSchemaValidator] = SchemaValidator(title="OptionEdgeLinesVisible", validator=Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "data", lookup_key: Simple { key: "data", py_key: Py( 0x00007f90336053b0, ), path: LookupPath( [ S( "data", Py( 0x00007f9033604840, ), ), ], ), }, name_py: Py( 0x00007f9038238fa0, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [], model_name: "EdgeLinesVisible", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d3206c0, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "EdgeLinesVisible", }, ), frozen: false, }, Field { name: "type", lookup_key: Simple { key: "type", py_key: Py( 0x00007f9033605e30, ), path: LookupPath( [ S( "type", Py( 0x00007f9033605bc0, ), ), ], ), }, name_py: Py( 0x00007f903823d958, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f9034c75df0, ), ), on_error: Raise, validator: Literal( LiteralValidator { lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "edge_lines_visible": 0, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f9034c75df0, ), ], }, expected_repr: "'edge_lines_visible'", name: "literal['edge_lines_visible']", }, ), validate_default: false, copy_default: false, name: "default[literal['edge_lines_visible']]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "OptionEdgeLinesVisible", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d98b9c0, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "OptionEdgeLinesVisible", }, ), definitions=[], cache_strings=True)[source]: The pydantic-core SchemaValidator used to validate instances of the model.

__repr__()[source]

Return repr(self).

Return type:: str

__repr_args__()[source]

Return type:: Iterable[tuple[str | None, Any]]

__repr_name__()[source]

Name of the instance’s class, used in __repr__.

Return type:: str

__repr_str__(join_str)[source]

Return type:: str

__rich_repr__()[source]

Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.

Return type:: Iterable[Any | tuple[Any] | tuple[str, Any] | tuple[str, Any, Any]]

__setattr__(name, value)[source]

Implement setattr(self, name, value).

Return type:: None

__setstate__(state)[source]

Return type:: None

__signature__: ClassVar[Signature] = <Signature (*, data: kittycad.models.edge_lines_visible.EdgeLinesVisible, type: Literal['edge_lines_visible'] = 'edge_lines_visible') -> None>[source]: The synthesized __init__ [Signature][inspect.Signature] of the model.

__slots__ = ('__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__')[source]

__str__()[source]

Return str(self).

Return type:: str

_abc_impl = <_abc._abc_data object>[source]

_calculate_keys(*args, **kwargs)[source]

Return type:: Any

_check_frozen(name, value)[source]

Return type:: None

_copy_and_set_values(*args, **kwargs)[source]

Return type:: Any

classmethod _get_value(*args, **kwargs)[source]

Return type:: Any

_iter(*args, **kwargs)[source]

Return type:: Any

classmethod construct(_fields_set=None, **values)[source]

Return type:: Self

copy(*, include=None, exclude=None, update=None, deep=False)[source]

Returns a copy of the model.

!!! warning “Deprecated”: This method is now deprecated; use model_copy instead.

If you need include or exclude, use:

`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `

Parameters:

include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.

Returns:

A copy of the model with included, excluded and updated fields as specified.

data: EdgeLinesVisible[source]

dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)[source]

Return type:: Dict[str, Any]

classmethod from_orm(obj)[source]

Return type:: Self

json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)[source]

Return type:: str

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}[source]: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'protected_namespaces': ()}[source]: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod model_construct(_fields_set=None, **values)[source]

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note: model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == 'allow', then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == 'ignore' (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == 'forbid' does not result in an error if extra values are passed, but they will be ignored.

Parameters:

_fields_set (set[str] | None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.
values (Any) – Trusted or pre-validated data dictionary.

Return type:

Self

Returns:

A new instance of the Model class with validated data.

model_copy(*, update=None, deep=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy

Returns a copy of the model.

Parameters:

update (dict[str, Any] | None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.
deep (bool) – Set to True to make a deep copy of the model.

Return type:

Self

Returns:

New model instance.

model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters:

mode (Union[Literal['json', 'python'], str]) – The mode in which to_python 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.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to include in the output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to exclude from the output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to use the field’s alias in the dictionary key if defined.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A dictionary representation of the model.

model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

Generates a JSON representation of the model using Pydantic’s to_json method.

Parameters:

indent (int | None) – Indentation to use in the JSON output. If None is passed, the output will be compact.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to include in the JSON output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to exclude from the JSON output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to serialize using field aliases.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A JSON string representation of the model.

property model_extra: dict[str, Any] | None[source]

Get extra fields set during validation.

Returns:: A dictionary of extra fields, or None if config.extra is not set to "allow".

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=EdgeLinesVisible, required=True), 'type': FieldInfo(annotation=Literal['edge_lines_visible'], required=False, default='edge_lines_visible')}[source]

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

property model_fields_set: set[str][source]

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,: i.e. that were not filled from defaults.

classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')[source]

Generates a JSON schema for a model class.

Parameters:

by_alias (bool) – Whether to use attribute aliases or not.
ref_template (str) – The reference template.
schema_generator (type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modifications
mode (Literal['validation', 'serialization']) – The mode in which to generate the schema.

Return type:

Returns:

The JSON schema for the given model class.

classmethod model_parametrized_name(params)[source]

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

Parameters:: params (tuple[type[Any], ...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.
Return type:: str
Returns:: String representing the new class where params are passed to cls as type variables.
Raises:: TypeError – Raised when trying to generate concrete names for non-generic models.

model_post_init(_BaseModel__context)[source]

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

Return type:: None

classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)[source]

Try to rebuild the pydantic-core schema for the model.

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.

Parameters:

force (bool) – Whether to force the rebuilding of the model schema, defaults to False.
raise_errors (bool) – Whether to raise errors, defaults to True.
_parent_namespace_depth (int) – The depth level of the parent namespace, defaults to 2.
_types_namespace (dict[str, Any] | None) – The types namespace, defaults to None.

Return type:

Returns:

Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.

classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)[source]

Validate a pydantic model instance.

Parameters:

obj (Any) – The object to validate.
strict (bool | None) – Whether to enforce types strictly.
from_attributes (bool | None) – Whether to extract data from object attributes.
context (Any | None) – Additional context to pass to the validator.

Raises:

ValidationError – If the object could not be validated.

Return type:

Self

Returns:

The validated model instance.

classmethod model_validate_json(json_data, *, strict=None, context=None)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing

Validate the given JSON data against the Pydantic model.

Parameters:

json_data (str | bytes | bytearray) – The JSON data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

Raises:

ValidationError – If json_data is not a JSON string or the object could not be validated.

classmethod model_validate_strings(obj, *, strict=None, context=None)[source]

Validate the given object with string data against the Pydantic model.

Parameters:

obj (Any) – The object containing string data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod parse_obj(obj)[source]

Return type:: Self

classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod schema(by_alias=True, ref_template='#/$defs/{model}')[source]

Return type:: Dict[str, Any]

classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)[source]

Return type:: str

type: Literal['edge_lines_visible'][source]

classmethod update_forward_refs(**localns)[source]

Return type:: None

classmethod validate(value)[source]

Return type:: Self

class kittycad.models.ok_modeling_cmd_response.OptionEditModeEnter(**data)[source][source]

The response to the ‘EditModeEnter’ endpoint

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__abstractmethods__ = frozenset({})[source]

__annotations__ = {'__class_vars__': 'ClassVar[set[str]]', '__private_attributes__': 'ClassVar[Dict[str, ModelPrivateAttr]]', '__pydantic_complete__': 'ClassVar[bool]', '__pydantic_core_schema__': 'ClassVar[CoreSchema]', '__pydantic_custom_init__': 'ClassVar[bool]', '__pydantic_decorators__': 'ClassVar[_decorators.DecoratorInfos]', '__pydantic_extra__': 'dict[str, Any] | None', '__pydantic_fields_set__': 'set[str]', '__pydantic_generic_metadata__': 'ClassVar[_generics.PydanticGenericMetadata]', '__pydantic_parent_namespace__': 'ClassVar[Dict[str, Any] | None]', '__pydantic_post_init__': "ClassVar[None | Literal['model_post_init']]", '__pydantic_private__': 'dict[str, Any] | None', '__pydantic_root_model__': 'ClassVar[bool]', '__pydantic_serializer__': 'ClassVar[SchemaSerializer]', '__pydantic_validator__': 'ClassVar[SchemaValidator | PluggableSchemaValidator]', '__signature__': 'ClassVar[Signature]', 'data': <class 'kittycad.models.edit_mode_enter.EditModeEnter'>, 'model_computed_fields': 'ClassVar[Dict[str, ComputedFieldInfo]]', 'model_config': 'ClassVar[ConfigDict]', 'model_fields': 'ClassVar[Dict[str, FieldInfo]]', 'type': typing.Literal['edit_mode_enter']}[source]

classmethod __class_getitem__(typevar_values)[source]

Return type:: type[BaseModel] | PydanticRecursiveRef

__class_vars__: ClassVar[set[str]] = {}[source]: The names of the class variables defined on the model.

__copy__()[source]

Returns a shallow copy of the model.

Return type:: Self

__deepcopy__(memo=None)[source]

Returns a deep copy of the model.

Return type:: Self

__delattr__(item)[source]

Implement delattr(self, name).

Return type:: Any

__dict__[source]

__eq__(other)[source]

Return self==value.

Return type:: bool

property __fields_set__: set[str][source]

classmethod __get_pydantic_core_schema__(source, handler, /)[source]

Hook into generating the model’s CoreSchema.

Parameters:

source (type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.
handler (GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.

Return type:

Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]

Returns:

A pydantic-core CoreSchema.

classmethod __get_pydantic_json_schema__(core_schema, handler, /)[source]

Hook into generating the model’s JSON schema.

Parameters:

core_schema (Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({'type': 'nullable', 'schema': current_schema}), or just call the handler with the original schema.
handler (GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.

Return type:

Returns:

A JSON schema, as a Python object.

__getattr__(item)[source]

Return type:: Any

__getstate__()[source]

Helper for pickle.

Return type:: dict[Any, Any]

__hash__ = None[source]

__init__(**data)[source]

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__iter__()[source]

So dict(model) works.

Return type:: Generator[Tuple[str, Any], None, None]

__module__ = 'kittycad.models.ok_modeling_cmd_response'[source]

__pretty__(fmt, **kwargs)[source]

Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.

Return type:: Generator[Any, None, None]

__private_attributes__: ClassVar[Dict[str, ModelPrivateAttr]] = {}[source]: Metadata about the private attributes of the model.

__pydantic_complete__: ClassVar[bool] = True[source]: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__: ClassVar[CoreSchema] = {'cls': <class 'kittycad.models.ok_modeling_cmd_response.OptionEditModeEnter'>, 'config': {'title': 'OptionEditModeEnter'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.ok_modeling_cmd_response.OptionEditModeEnter'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.ok_modeling_cmd_response.OptionEditModeEnter'>>]}, 'ref': 'kittycad.models.ok_modeling_cmd_response.OptionEditModeEnter:94667212822176', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'data': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.edit_mode_enter.EditModeEnter'>, 'config': {'title': 'EditModeEnter'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.edit_mode_enter.EditModeEnter'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.edit_mode_enter.EditModeEnter'>>]}, 'ref': 'kittycad.models.edit_mode_enter.EditModeEnter:94667206168672', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {}, 'model_name': 'EditModeEnter', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}, 'type': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': 'edit_mode_enter', 'schema': {'expected': ['edit_mode_enter'], 'type': 'literal'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'OptionEditModeEnter', 'type': 'model-fields'}, 'type': 'model'}[source]: The core schema of the model.

__pydantic_custom_init__: ClassVar[bool] = False[source]: Whether the model has a custom __init__ method.

__pydantic_decorators__: ClassVar[_decorators.DecoratorInfos] = DecoratorInfos(validators={}, field_validators={}, root_validators={}, field_serializers={}, model_serializers={}, model_validators={}, computed_fields={})[source]: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_extra__: dict[str, Any] | None[source]: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to 'allow'.

__pydantic_fields_set__: set[str][source]: The names of fields explicitly set during instantiation.

__pydantic_generic_metadata__: ClassVar[_generics.PydanticGenericMetadata] = {'args': (), 'origin': None, 'parameters': ()}[source]: 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.

classmethod __pydantic_init_subclass__(**kwargs)[source]

This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.

This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.

This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.

Parameters:: **kwargs (Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.
Return type:: None

__pydantic_parent_namespace__: ClassVar[Dict[str, Any] | None] = None[source]: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__: ClassVar[None | Literal['model_post_init']] = None[source]: The name of the post-init method for the model, if defined.

__pydantic_private__: dict[str, Any] | None[source]: Values of private attributes set on the model instance.

__pydantic_root_model__: ClassVar[bool] = False[source]: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__: ClassVar[SchemaSerializer] = SchemaSerializer(serializer=Model( ModelSerializer { class: Py( 0x000056196d9796a0, ), serializer: Fields( GeneralFieldsSerializer { fields: { "type": SerField { key_py: Py( 0x00007f903823d958, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f9034c76070, ), ), serializer: Literal( LiteralSerializer { expected_int: {}, expected_str: { "edit_mode_enter", }, expected_py: None, name: "literal['edit_mode_enter']", }, ), }, ), ), required: true, }, "data": SerField { key_py: Py( 0x00007f9038238fa0, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196d321060, ), serializer: Fields( GeneralFieldsSerializer { fields: {}, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 0, }, ), has_extra: false, root_model: false, name: "EditModeEnter", }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "OptionEditModeEnter", }, ), definitions=[])[source]: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__: ClassVar[SchemaValidator | PluggableSchemaValidator] = SchemaValidator(title="OptionEditModeEnter", validator=Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "data", lookup_key: Simple { key: "data", py_key: Py( 0x00007f90334d40c0, ), path: LookupPath( [ S( "data", Py( 0x00007f90334d40f0, ), ), ], ), }, name_py: Py( 0x00007f9038238fa0, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [], model_name: "EditModeEnter", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d321060, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "EditModeEnter", }, ), frozen: false, }, Field { name: "type", lookup_key: Simple { key: "type", py_key: Py( 0x00007f90334d4120, ), path: LookupPath( [ S( "type", Py( 0x00007f90334d4150, ), ), ], ), }, name_py: Py( 0x00007f903823d958, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f9034c76070, ), ), on_error: Raise, validator: Literal( LiteralValidator { lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "edit_mode_enter": 0, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f9034c76070, ), ], }, expected_repr: "'edit_mode_enter'", name: "literal['edit_mode_enter']", }, ), validate_default: false, copy_default: false, name: "default[literal['edit_mode_enter']]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "OptionEditModeEnter", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d9796a0, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "OptionEditModeEnter", }, ), definitions=[], cache_strings=True)[source]: The pydantic-core SchemaValidator used to validate instances of the model.

__repr__()[source]

Return repr(self).

Return type:: str

__repr_args__()[source]

Return type:: Iterable[tuple[str | None, Any]]

__repr_name__()[source]

Name of the instance’s class, used in __repr__.

Return type:: str

__repr_str__(join_str)[source]

Return type:: str

__rich_repr__()[source]

Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.

Return type:: Iterable[Any | tuple[Any] | tuple[str, Any] | tuple[str, Any, Any]]

__setattr__(name, value)[source]

Implement setattr(self, name, value).

Return type:: None

__setstate__(state)[source]

Return type:: None

__signature__: ClassVar[Signature] = <Signature (*, data: kittycad.models.edit_mode_enter.EditModeEnter, type: Literal['edit_mode_enter'] = 'edit_mode_enter') -> None>[source]: The synthesized __init__ [Signature][inspect.Signature] of the model.

__slots__ = ('__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__')[source]

__str__()[source]

Return str(self).

Return type:: str

_abc_impl = <_abc._abc_data object>[source]

_calculate_keys(*args, **kwargs)[source]

Return type:: Any

_check_frozen(name, value)[source]

Return type:: None

_copy_and_set_values(*args, **kwargs)[source]

Return type:: Any

classmethod _get_value(*args, **kwargs)[source]

Return type:: Any

_iter(*args, **kwargs)[source]

Return type:: Any

classmethod construct(_fields_set=None, **values)[source]

Return type:: Self

copy(*, include=None, exclude=None, update=None, deep=False)[source]

Returns a copy of the model.

!!! warning “Deprecated”: This method is now deprecated; use model_copy instead.

If you need include or exclude, use:

`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `

Parameters:

include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.

Returns:

A copy of the model with included, excluded and updated fields as specified.

data: EditModeEnter[source]

dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)[source]

Return type:: Dict[str, Any]

classmethod from_orm(obj)[source]

Return type:: Self

json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)[source]

Return type:: str

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}[source]: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'protected_namespaces': ()}[source]: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod model_construct(_fields_set=None, **values)[source]

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note: model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == 'allow', then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == 'ignore' (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == 'forbid' does not result in an error if extra values are passed, but they will be ignored.

Parameters:

_fields_set (set[str] | None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.
values (Any) – Trusted or pre-validated data dictionary.

Return type:

Self

Returns:

A new instance of the Model class with validated data.

model_copy(*, update=None, deep=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy

Returns a copy of the model.

Parameters:

update (dict[str, Any] | None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.
deep (bool) – Set to True to make a deep copy of the model.

Return type:

Self

Returns:

New model instance.

model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters:

mode (Union[Literal['json', 'python'], str]) – The mode in which to_python 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.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to include in the output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to exclude from the output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to use the field’s alias in the dictionary key if defined.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A dictionary representation of the model.

model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

Generates a JSON representation of the model using Pydantic’s to_json method.

Parameters:

indent (int | None) – Indentation to use in the JSON output. If None is passed, the output will be compact.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to include in the JSON output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to exclude from the JSON output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to serialize using field aliases.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A JSON string representation of the model.

property model_extra: dict[str, Any] | None[source]

Get extra fields set during validation.

Returns:: A dictionary of extra fields, or None if config.extra is not set to "allow".

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=EditModeEnter, required=True), 'type': FieldInfo(annotation=Literal['edit_mode_enter'], required=False, default='edit_mode_enter')}[source]

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

property model_fields_set: set[str][source]

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,: i.e. that were not filled from defaults.

classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')[source]

Generates a JSON schema for a model class.

Parameters:

by_alias (bool) – Whether to use attribute aliases or not.
ref_template (str) – The reference template.
schema_generator (type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modifications
mode (Literal['validation', 'serialization']) – The mode in which to generate the schema.

Return type:

Returns:

The JSON schema for the given model class.

classmethod model_parametrized_name(params)[source]

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

Parameters:: params (tuple[type[Any], ...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.
Return type:: str
Returns:: String representing the new class where params are passed to cls as type variables.
Raises:: TypeError – Raised when trying to generate concrete names for non-generic models.

model_post_init(_BaseModel__context)[source]

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

Return type:: None

classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)[source]

Try to rebuild the pydantic-core schema for the model.

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.

Parameters:

force (bool) – Whether to force the rebuilding of the model schema, defaults to False.
raise_errors (bool) – Whether to raise errors, defaults to True.
_parent_namespace_depth (int) – The depth level of the parent namespace, defaults to 2.
_types_namespace (dict[str, Any] | None) – The types namespace, defaults to None.

Return type:

Returns:

Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.

classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)[source]

Validate a pydantic model instance.

Parameters:

obj (Any) – The object to validate.
strict (bool | None) – Whether to enforce types strictly.
from_attributes (bool | None) – Whether to extract data from object attributes.
context (Any | None) – Additional context to pass to the validator.

Raises:

ValidationError – If the object could not be validated.

Return type:

Self

Returns:

The validated model instance.

classmethod model_validate_json(json_data, *, strict=None, context=None)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing

Validate the given JSON data against the Pydantic model.

Parameters:

json_data (str | bytes | bytearray) – The JSON data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

Raises:

ValidationError – If json_data is not a JSON string or the object could not be validated.

classmethod model_validate_strings(obj, *, strict=None, context=None)[source]

Validate the given object with string data against the Pydantic model.

Parameters:

obj (Any) – The object containing string data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod parse_obj(obj)[source]

Return type:: Self

classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod schema(by_alias=True, ref_template='#/$defs/{model}')[source]

Return type:: Dict[str, Any]

classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)[source]

Return type:: str

type: Literal['edit_mode_enter'][source]

classmethod update_forward_refs(**localns)[source]

Return type:: None

classmethod validate(value)[source]

Return type:: Self

class kittycad.models.ok_modeling_cmd_response.OptionEditModeExit(**data)[source][source]

The response to the ‘EditModeExit’ endpoint

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__abstractmethods__ = frozenset({})[source]

__annotations__ = {'__class_vars__': 'ClassVar[set[str]]', '__private_attributes__': 'ClassVar[Dict[str, ModelPrivateAttr]]', '__pydantic_complete__': 'ClassVar[bool]', '__pydantic_core_schema__': 'ClassVar[CoreSchema]', '__pydantic_custom_init__': 'ClassVar[bool]', '__pydantic_decorators__': 'ClassVar[_decorators.DecoratorInfos]', '__pydantic_extra__': 'dict[str, Any] | None', '__pydantic_fields_set__': 'set[str]', '__pydantic_generic_metadata__': 'ClassVar[_generics.PydanticGenericMetadata]', '__pydantic_parent_namespace__': 'ClassVar[Dict[str, Any] | None]', '__pydantic_post_init__': "ClassVar[None | Literal['model_post_init']]", '__pydantic_private__': 'dict[str, Any] | None', '__pydantic_root_model__': 'ClassVar[bool]', '__pydantic_serializer__': 'ClassVar[SchemaSerializer]', '__pydantic_validator__': 'ClassVar[SchemaValidator | PluggableSchemaValidator]', '__signature__': 'ClassVar[Signature]', 'data': <class 'kittycad.models.edit_mode_exit.EditModeExit'>, 'model_computed_fields': 'ClassVar[Dict[str, ComputedFieldInfo]]', 'model_config': 'ClassVar[ConfigDict]', 'model_fields': 'ClassVar[Dict[str, FieldInfo]]', 'type': typing.Literal['edit_mode_exit']}[source]

classmethod __class_getitem__(typevar_values)[source]

Return type:: type[BaseModel] | PydanticRecursiveRef

__class_vars__: ClassVar[set[str]] = {}[source]: The names of the class variables defined on the model.

__copy__()[source]

Returns a shallow copy of the model.

Return type:: Self

__deepcopy__(memo=None)[source]

Returns a deep copy of the model.

Return type:: Self

__delattr__(item)[source]

Implement delattr(self, name).

Return type:: Any

__dict__[source]

__eq__(other)[source]

Return self==value.

Return type:: bool

property __fields_set__: set[str][source]

classmethod __get_pydantic_core_schema__(source, handler, /)[source]

Hook into generating the model’s CoreSchema.

Parameters:

source (type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.
handler (GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.

Return type:

Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]

Returns:

A pydantic-core CoreSchema.

classmethod __get_pydantic_json_schema__(core_schema, handler, /)[source]

Hook into generating the model’s JSON schema.

Parameters:

core_schema (Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({'type': 'nullable', 'schema': current_schema}), or just call the handler with the original schema.
handler (GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.

Return type:

Returns:

A JSON schema, as a Python object.

__getattr__(item)[source]

Return type:: Any

__getstate__()[source]

Helper for pickle.

Return type:: dict[Any, Any]

__hash__ = None[source]

__init__(**data)[source]

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__iter__()[source]

So dict(model) works.

Return type:: Generator[Tuple[str, Any], None, None]

__module__ = 'kittycad.models.ok_modeling_cmd_response'[source]

__pretty__(fmt, **kwargs)[source]

Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.

Return type:: Generator[Any, None, None]

__private_attributes__: ClassVar[Dict[str, ModelPrivateAttr]] = {}[source]: Metadata about the private attributes of the model.

__pydantic_complete__: ClassVar[bool] = True[source]: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__: ClassVar[CoreSchema] = {'cls': <class 'kittycad.models.ok_modeling_cmd_response.OptionEditModeExit'>, 'config': {'title': 'OptionEditModeExit'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.ok_modeling_cmd_response.OptionEditModeExit'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.ok_modeling_cmd_response.OptionEditModeExit'>>]}, 'ref': 'kittycad.models.ok_modeling_cmd_response.OptionEditModeExit:94667213186768', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'data': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.edit_mode_exit.EditModeExit'>, 'config': {'title': 'EditModeExit'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.edit_mode_exit.EditModeExit'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.edit_mode_exit.EditModeExit'>>]}, 'ref': 'kittycad.models.edit_mode_exit.EditModeExit:94667206171920', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {}, 'model_name': 'EditModeExit', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}, 'type': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': 'edit_mode_exit', 'schema': {'expected': ['edit_mode_exit'], 'type': 'literal'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'OptionEditModeExit', 'type': 'model-fields'}, 'type': 'model'}[source]: The core schema of the model.

__pydantic_custom_init__: ClassVar[bool] = False[source]: Whether the model has a custom __init__ method.

__pydantic_decorators__: ClassVar[_decorators.DecoratorInfos] = DecoratorInfos(validators={}, field_validators={}, root_validators={}, field_serializers={}, model_serializers={}, model_validators={}, computed_fields={})[source]: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_extra__: dict[str, Any] | None[source]: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to 'allow'.

__pydantic_fields_set__: set[str][source]: The names of fields explicitly set during instantiation.

__pydantic_generic_metadata__: ClassVar[_generics.PydanticGenericMetadata] = {'args': (), 'origin': None, 'parameters': ()}[source]: 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.

classmethod __pydantic_init_subclass__(**kwargs)[source]

This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.

This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.

This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.

Parameters:: **kwargs (Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.
Return type:: None

__pydantic_parent_namespace__: ClassVar[Dict[str, Any] | None] = None[source]: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__: ClassVar[None | Literal['model_post_init']] = None[source]: The name of the post-init method for the model, if defined.

__pydantic_private__: dict[str, Any] | None[source]: Values of private attributes set on the model instance.

__pydantic_root_model__: ClassVar[bool] = False[source]: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__: ClassVar[SchemaSerializer] = SchemaSerializer(serializer=Model( ModelSerializer { class: Py( 0x000056196d9d26d0, ), serializer: Fields( GeneralFieldsSerializer { fields: { "type": SerField { key_py: Py( 0x00007f903823d958, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f9034c75f70, ), ), serializer: Literal( LiteralSerializer { expected_int: {}, expected_str: { "edit_mode_exit", }, expected_py: None, name: "literal['edit_mode_exit']", }, ), }, ), ), required: true, }, "data": SerField { key_py: Py( 0x00007f9038238fa0, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196d321d10, ), serializer: Fields( GeneralFieldsSerializer { fields: {}, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 0, }, ), has_extra: false, root_model: false, name: "EditModeExit", }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "OptionEditModeExit", }, ), definitions=[])[source]: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__: ClassVar[SchemaValidator | PluggableSchemaValidator] = SchemaValidator(title="OptionEditModeExit", validator=Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "data", lookup_key: Simple { key: "data", py_key: Py( 0x00007f9033521a40, ), path: LookupPath( [ S( "data", Py( 0x00007f9033521a70, ), ), ], ), }, name_py: Py( 0x00007f9038238fa0, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [], model_name: "EditModeExit", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d321d10, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "EditModeExit", }, ), frozen: false, }, Field { name: "type", lookup_key: Simple { key: "type", py_key: Py( 0x00007f9033521aa0, ), path: LookupPath( [ S( "type", Py( 0x00007f9033521ad0, ), ), ], ), }, name_py: Py( 0x00007f903823d958, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f9034c75f70, ), ), on_error: Raise, validator: Literal( LiteralValidator { lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "edit_mode_exit": 0, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f9034c75f70, ), ], }, expected_repr: "'edit_mode_exit'", name: "literal['edit_mode_exit']", }, ), validate_default: false, copy_default: false, name: "default[literal['edit_mode_exit']]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "OptionEditModeExit", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d9d26d0, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "OptionEditModeExit", }, ), definitions=[], cache_strings=True)[source]: The pydantic-core SchemaValidator used to validate instances of the model.

__repr__()[source]

Return repr(self).

Return type:: str

__repr_args__()[source]

Return type:: Iterable[tuple[str | None, Any]]

__repr_name__()[source]

Name of the instance’s class, used in __repr__.

Return type:: str

__repr_str__(join_str)[source]

Return type:: str

__rich_repr__()[source]

Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.

Return type:: Iterable[Any | tuple[Any] | tuple[str, Any] | tuple[str, Any, Any]]

__setattr__(name, value)[source]

Implement setattr(self, name, value).

Return type:: None

__setstate__(state)[source]

Return type:: None

__signature__: ClassVar[Signature] = <Signature (*, data: kittycad.models.edit_mode_exit.EditModeExit, type: Literal['edit_mode_exit'] = 'edit_mode_exit') -> None>[source]: The synthesized __init__ [Signature][inspect.Signature] of the model.

__slots__ = ('__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__')[source]

__str__()[source]

Return str(self).

Return type:: str

_abc_impl = <_abc._abc_data object>[source]

_calculate_keys(*args, **kwargs)[source]

Return type:: Any

_check_frozen(name, value)[source]

Return type:: None

_copy_and_set_values(*args, **kwargs)[source]

Return type:: Any

classmethod _get_value(*args, **kwargs)[source]

Return type:: Any

_iter(*args, **kwargs)[source]

Return type:: Any

classmethod construct(_fields_set=None, **values)[source]

Return type:: Self

copy(*, include=None, exclude=None, update=None, deep=False)[source]

Returns a copy of the model.

!!! warning “Deprecated”: This method is now deprecated; use model_copy instead.

If you need include or exclude, use:

`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `

Parameters:

include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.

Returns:

A copy of the model with included, excluded and updated fields as specified.

data: EditModeExit[source]

dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)[source]

Return type:: Dict[str, Any]

classmethod from_orm(obj)[source]

Return type:: Self

json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)[source]

Return type:: str

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}[source]: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'protected_namespaces': ()}[source]: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod model_construct(_fields_set=None, **values)[source]

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note: model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == 'allow', then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == 'ignore' (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == 'forbid' does not result in an error if extra values are passed, but they will be ignored.

Parameters:

_fields_set (set[str] | None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.
values (Any) – Trusted or pre-validated data dictionary.

Return type:

Self

Returns:

A new instance of the Model class with validated data.

model_copy(*, update=None, deep=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy

Returns a copy of the model.

Parameters:

update (dict[str, Any] | None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.
deep (bool) – Set to True to make a deep copy of the model.

Return type:

Self

Returns:

New model instance.

model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters:

mode (Union[Literal['json', 'python'], str]) – The mode in which to_python 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.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to include in the output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to exclude from the output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to use the field’s alias in the dictionary key if defined.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A dictionary representation of the model.

model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

Generates a JSON representation of the model using Pydantic’s to_json method.

Parameters:

indent (int | None) – Indentation to use in the JSON output. If None is passed, the output will be compact.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to include in the JSON output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to exclude from the JSON output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to serialize using field aliases.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A JSON string representation of the model.

property model_extra: dict[str, Any] | None[source]

Get extra fields set during validation.

Returns:: A dictionary of extra fields, or None if config.extra is not set to "allow".

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=EditModeExit, required=True), 'type': FieldInfo(annotation=Literal['edit_mode_exit'], required=False, default='edit_mode_exit')}[source]

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

property model_fields_set: set[str][source]

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,: i.e. that were not filled from defaults.

classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')[source]

Generates a JSON schema for a model class.

Parameters:

by_alias (bool) – Whether to use attribute aliases or not.
ref_template (str) – The reference template.
schema_generator (type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modifications
mode (Literal['validation', 'serialization']) – The mode in which to generate the schema.

Return type:

Returns:

The JSON schema for the given model class.

classmethod model_parametrized_name(params)[source]

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

Parameters:: params (tuple[type[Any], ...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.
Return type:: str
Returns:: String representing the new class where params are passed to cls as type variables.
Raises:: TypeError – Raised when trying to generate concrete names for non-generic models.

model_post_init(_BaseModel__context)[source]

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

Return type:: None

classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)[source]

Try to rebuild the pydantic-core schema for the model.

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.

Parameters:

force (bool) – Whether to force the rebuilding of the model schema, defaults to False.
raise_errors (bool) – Whether to raise errors, defaults to True.
_parent_namespace_depth (int) – The depth level of the parent namespace, defaults to 2.
_types_namespace (dict[str, Any] | None) – The types namespace, defaults to None.

Return type:

Returns:

Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.

classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)[source]

Validate a pydantic model instance.

Parameters:

obj (Any) – The object to validate.
strict (bool | None) – Whether to enforce types strictly.
from_attributes (bool | None) – Whether to extract data from object attributes.
context (Any | None) – Additional context to pass to the validator.

Raises:

ValidationError – If the object could not be validated.

Return type:

Self

Returns:

The validated model instance.

classmethod model_validate_json(json_data, *, strict=None, context=None)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing

Validate the given JSON data against the Pydantic model.

Parameters:

json_data (str | bytes | bytearray) – The JSON data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

Raises:

ValidationError – If json_data is not a JSON string or the object could not be validated.

classmethod model_validate_strings(obj, *, strict=None, context=None)[source]

Validate the given object with string data against the Pydantic model.

Parameters:

obj (Any) – The object containing string data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod parse_obj(obj)[source]

Return type:: Self

classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod schema(by_alias=True, ref_template='#/$defs/{model}')[source]

Return type:: Dict[str, Any]

classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)[source]

Return type:: str

type: Literal['edit_mode_exit'][source]

classmethod update_forward_refs(**localns)[source]

Return type:: None

classmethod validate(value)[source]

Return type:: Self

class kittycad.models.ok_modeling_cmd_response.OptionEmpty(**data)[source][source]

An empty response, used for any command that does not explicitly have a response defined here.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__abstractmethods__ = frozenset({})[source]

__annotations__ = {'__class_vars__': 'ClassVar[set[str]]', '__private_attributes__': 'ClassVar[Dict[str, ModelPrivateAttr]]', '__pydantic_complete__': 'ClassVar[bool]', '__pydantic_core_schema__': 'ClassVar[CoreSchema]', '__pydantic_custom_init__': 'ClassVar[bool]', '__pydantic_decorators__': 'ClassVar[_decorators.DecoratorInfos]', '__pydantic_extra__': 'dict[str, Any] | None', '__pydantic_fields_set__': 'set[str]', '__pydantic_generic_metadata__': 'ClassVar[_generics.PydanticGenericMetadata]', '__pydantic_parent_namespace__': 'ClassVar[Dict[str, Any] | None]', '__pydantic_post_init__': "ClassVar[None | Literal['model_post_init']]", '__pydantic_private__': 'dict[str, Any] | None', '__pydantic_root_model__': 'ClassVar[bool]', '__pydantic_serializer__': 'ClassVar[SchemaSerializer]', '__pydantic_validator__': 'ClassVar[SchemaValidator | PluggableSchemaValidator]', '__signature__': 'ClassVar[Signature]', 'model_computed_fields': 'ClassVar[Dict[str, ComputedFieldInfo]]', 'model_config': 'ClassVar[ConfigDict]', 'model_fields': 'ClassVar[Dict[str, FieldInfo]]', 'type': typing.Literal['empty']}[source]

classmethod __class_getitem__(typevar_values)[source]

Return type:: type[BaseModel] | PydanticRecursiveRef

__class_vars__: ClassVar[set[str]] = {}[source]: The names of the class variables defined on the model.

__copy__()[source]

Returns a shallow copy of the model.

Return type:: Self

__deepcopy__(memo=None)[source]

Returns a deep copy of the model.

Return type:: Self

__delattr__(item)[source]

Implement delattr(self, name).

Return type:: Any

__dict__[source]

__eq__(other)[source]

Return self==value.

Return type:: bool

property __fields_set__: set[str][source]

classmethod __get_pydantic_core_schema__(source, handler, /)[source]

Hook into generating the model’s CoreSchema.

Parameters:

source (type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.
handler (GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.

Return type:

Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]

Returns:

A pydantic-core CoreSchema.

classmethod __get_pydantic_json_schema__(core_schema, handler, /)[source]

Hook into generating the model’s JSON schema.

Parameters:

core_schema (Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({'type': 'nullable', 'schema': current_schema}), or just call the handler with the original schema.
handler (GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.

Return type:

Returns:

A JSON schema, as a Python object.

__getattr__(item)[source]

Return type:: Any

__getstate__()[source]

Helper for pickle.

Return type:: dict[Any, Any]

__hash__ = None[source]

__init__(**data)[source]

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__iter__()[source]

So dict(model) works.

Return type:: Generator[Tuple[str, Any], None, None]

__module__ = 'kittycad.models.ok_modeling_cmd_response'[source]

__pretty__(fmt, **kwargs)[source]

Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.

Return type:: Generator[Any, None, None]

__private_attributes__: ClassVar[Dict[str, ModelPrivateAttr]] = {}[source]: Metadata about the private attributes of the model.

__pydantic_complete__: ClassVar[bool] = True[source]: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__: ClassVar[CoreSchema] = {'cls': <class 'kittycad.models.ok_modeling_cmd_response.OptionEmpty'>, 'config': {'title': 'OptionEmpty'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.ok_modeling_cmd_response.OptionEmpty'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.ok_modeling_cmd_response.OptionEmpty'>>]}, 'ref': 'kittycad.models.ok_modeling_cmd_response.OptionEmpty:94667212667904', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'type': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': 'empty', 'schema': {'expected': ['empty'], 'type': 'literal'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'OptionEmpty', 'type': 'model-fields'}, 'type': 'model'}[source]: The core schema of the model.

__pydantic_custom_init__: ClassVar[bool] = False[source]: Whether the model has a custom __init__ method.

__pydantic_decorators__: ClassVar[_decorators.DecoratorInfos] = DecoratorInfos(validators={}, field_validators={}, root_validators={}, field_serializers={}, model_serializers={}, model_validators={}, computed_fields={})[source]: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_extra__: dict[str, Any] | None[source]: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to 'allow'.

__pydantic_fields_set__: set[str][source]: The names of fields explicitly set during instantiation.

__pydantic_generic_metadata__: ClassVar[_generics.PydanticGenericMetadata] = {'args': (), 'origin': None, 'parameters': ()}[source]: 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.

classmethod __pydantic_init_subclass__(**kwargs)[source]

This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.

This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.

This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.

Parameters:: **kwargs (Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.
Return type:: None

__pydantic_parent_namespace__: ClassVar[Dict[str, Any] | None] = None[source]: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__: ClassVar[None | Literal['model_post_init']] = None[source]: The name of the post-init method for the model, if defined.

__pydantic_private__: dict[str, Any] | None[source]: Values of private attributes set on the model instance.

__pydantic_root_model__: ClassVar[bool] = False[source]: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__: ClassVar[SchemaSerializer] = SchemaSerializer(serializer=Model( ModelSerializer { class: Py( 0x000056196d953c00, ), serializer: Fields( GeneralFieldsSerializer { fields: { "type": SerField { key_py: Py( 0x00007f903823d958, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f90381a9ec0, ), ), serializer: Literal( LiteralSerializer { expected_int: {}, expected_str: { "empty", }, expected_py: None, name: "literal['empty']", }, ), }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 1, }, ), has_extra: false, root_model: false, name: "OptionEmpty", }, ), definitions=[])[source]: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__: ClassVar[SchemaValidator | PluggableSchemaValidator] = SchemaValidator(title="OptionEmpty", validator=Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "type", lookup_key: Simple { key: "type", py_key: Py( 0x00007f90336047e0, ), path: LookupPath( [ S( "type", Py( 0x00007f90336048d0, ), ), ], ), }, name_py: Py( 0x00007f903823d958, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f90381a9ec0, ), ), on_error: Raise, validator: Literal( LiteralValidator { lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "empty": 0, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f90381a9ec0, ), ], }, expected_repr: "'empty'", name: "literal['empty']", }, ), validate_default: false, copy_default: false, name: "default[literal['empty']]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "OptionEmpty", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d953c00, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "OptionEmpty", }, ), definitions=[], cache_strings=True)[source]: The pydantic-core SchemaValidator used to validate instances of the model.

__repr__()[source]

Return repr(self).

Return type:: str

__repr_args__()[source]

Return type:: Iterable[tuple[str | None, Any]]

__repr_name__()[source]

Name of the instance’s class, used in __repr__.

Return type:: str

__repr_str__(join_str)[source]

Return type:: str

__rich_repr__()[source]

Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.

Return type:: Iterable[Any | tuple[Any] | tuple[str, Any] | tuple[str, Any, Any]]

__setattr__(name, value)[source]

Implement setattr(self, name, value).

Return type:: None

__setstate__(state)[source]

Return type:: None

__signature__: ClassVar[Signature] = <Signature (*, type: Literal['empty'] = 'empty') -> None>[source]: The synthesized __init__ [Signature][inspect.Signature] of the model.

__slots__ = ('__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__')[source]

__str__()[source]

Return str(self).

Return type:: str

_abc_impl = <_abc._abc_data object>[source]

_calculate_keys(*args, **kwargs)[source]

Return type:: Any

_check_frozen(name, value)[source]

Return type:: None

_copy_and_set_values(*args, **kwargs)[source]

Return type:: Any

classmethod _get_value(*args, **kwargs)[source]

Return type:: Any

_iter(*args, **kwargs)[source]

Return type:: Any

classmethod construct(_fields_set=None, **values)[source]

Return type:: Self

copy(*, include=None, exclude=None, update=None, deep=False)[source]

Returns a copy of the model.

!!! warning “Deprecated”: This method is now deprecated; use model_copy instead.

If you need include or exclude, use:

`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `

Parameters:

include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.

Returns:

A copy of the model with included, excluded and updated fields as specified.

dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)[source]

Return type:: Dict[str, Any]

classmethod from_orm(obj)[source]

Return type:: Self

json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)[source]

Return type:: str

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}[source]: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'protected_namespaces': ()}[source]: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod model_construct(_fields_set=None, **values)[source]

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note: model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == 'allow', then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == 'ignore' (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == 'forbid' does not result in an error if extra values are passed, but they will be ignored.

Parameters:

_fields_set (set[str] | None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.
values (Any) – Trusted or pre-validated data dictionary.

Return type:

Self

Returns:

A new instance of the Model class with validated data.

model_copy(*, update=None, deep=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy

Returns a copy of the model.

Parameters:

update (dict[str, Any] | None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.
deep (bool) – Set to True to make a deep copy of the model.

Return type:

Self

Returns:

New model instance.

model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters:

mode (Union[Literal['json', 'python'], str]) – The mode in which to_python 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.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to include in the output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to exclude from the output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to use the field’s alias in the dictionary key if defined.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A dictionary representation of the model.

model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

Generates a JSON representation of the model using Pydantic’s to_json method.

Parameters:

indent (int | None) – Indentation to use in the JSON output. If None is passed, the output will be compact.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to include in the JSON output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to exclude from the JSON output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to serialize using field aliases.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A JSON string representation of the model.

property model_extra: dict[str, Any] | None[source]

Get extra fields set during validation.

Returns:: A dictionary of extra fields, or None if config.extra is not set to "allow".

model_fields: ClassVar[Dict[str, FieldInfo]] = {'type': FieldInfo(annotation=Literal['empty'], required=False, default='empty')}[source]

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

property model_fields_set: set[str][source]

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,: i.e. that were not filled from defaults.

classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')[source]

Generates a JSON schema for a model class.

Parameters:

by_alias (bool) – Whether to use attribute aliases or not.
ref_template (str) – The reference template.
schema_generator (type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modifications
mode (Literal['validation', 'serialization']) – The mode in which to generate the schema.

Return type:

Returns:

The JSON schema for the given model class.

classmethod model_parametrized_name(params)[source]

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

Parameters:: params (tuple[type[Any], ...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.
Return type:: str
Returns:: String representing the new class where params are passed to cls as type variables.
Raises:: TypeError – Raised when trying to generate concrete names for non-generic models.

model_post_init(_BaseModel__context)[source]

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

Return type:: None

classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)[source]

Try to rebuild the pydantic-core schema for the model.

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.

Parameters:

force (bool) – Whether to force the rebuilding of the model schema, defaults to False.
raise_errors (bool) – Whether to raise errors, defaults to True.
_parent_namespace_depth (int) – The depth level of the parent namespace, defaults to 2.
_types_namespace (dict[str, Any] | None) – The types namespace, defaults to None.

Return type:

Returns:

Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.

classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)[source]

Validate a pydantic model instance.

Parameters:

obj (Any) – The object to validate.
strict (bool | None) – Whether to enforce types strictly.
from_attributes (bool | None) – Whether to extract data from object attributes.
context (Any | None) – Additional context to pass to the validator.

Raises:

ValidationError – If the object could not be validated.

Return type:

Self

Returns:

The validated model instance.

classmethod model_validate_json(json_data, *, strict=None, context=None)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing

Validate the given JSON data against the Pydantic model.

Parameters:

json_data (str | bytes | bytearray) – The JSON data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

Raises:

ValidationError – If json_data is not a JSON string or the object could not be validated.

classmethod model_validate_strings(obj, *, strict=None, context=None)[source]

Validate the given object with string data against the Pydantic model.

Parameters:

obj (Any) – The object containing string data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod parse_obj(obj)[source]

Return type:: Self

classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod schema(by_alias=True, ref_template='#/$defs/{model}')[source]

Return type:: Dict[str, Any]

classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)[source]

Return type:: str

type: Literal['empty'][source]

classmethod update_forward_refs(**localns)[source]

Return type:: None

classmethod validate(value)[source]

Return type:: Self

class kittycad.models.ok_modeling_cmd_response.OptionEnableSketchMode(**data)[source][source]

The response to the ‘EnableSketchMode’ endpoint

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__abstractmethods__ = frozenset({})[source]

__annotations__ = {'__class_vars__': 'ClassVar[set[str]]', '__private_attributes__': 'ClassVar[Dict[str, ModelPrivateAttr]]', '__pydantic_complete__': 'ClassVar[bool]', '__pydantic_core_schema__': 'ClassVar[CoreSchema]', '__pydantic_custom_init__': 'ClassVar[bool]', '__pydantic_decorators__': 'ClassVar[_decorators.DecoratorInfos]', '__pydantic_extra__': 'dict[str, Any] | None', '__pydantic_fields_set__': 'set[str]', '__pydantic_generic_metadata__': 'ClassVar[_generics.PydanticGenericMetadata]', '__pydantic_parent_namespace__': 'ClassVar[Dict[str, Any] | None]', '__pydantic_post_init__': "ClassVar[None | Literal['model_post_init']]", '__pydantic_private__': 'dict[str, Any] | None', '__pydantic_root_model__': 'ClassVar[bool]', '__pydantic_serializer__': 'ClassVar[SchemaSerializer]', '__pydantic_validator__': 'ClassVar[SchemaValidator | PluggableSchemaValidator]', '__signature__': 'ClassVar[Signature]', 'data': <class 'kittycad.models.enable_sketch_mode.EnableSketchMode'>, 'model_computed_fields': 'ClassVar[Dict[str, ComputedFieldInfo]]', 'model_config': 'ClassVar[ConfigDict]', 'model_fields': 'ClassVar[Dict[str, FieldInfo]]', 'type': typing.Literal['enable_sketch_mode']}[source]

classmethod __class_getitem__(typevar_values)[source]

Return type:: type[BaseModel] | PydanticRecursiveRef

__class_vars__: ClassVar[set[str]] = {}[source]: The names of the class variables defined on the model.

__copy__()[source]

Returns a shallow copy of the model.

Return type:: Self

__deepcopy__(memo=None)[source]

Returns a deep copy of the model.

Return type:: Self

__delattr__(item)[source]

Implement delattr(self, name).

Return type:: Any

__dict__[source]

__eq__(other)[source]

Return self==value.

Return type:: bool

property __fields_set__: set[str][source]

classmethod __get_pydantic_core_schema__(source, handler, /)[source]

Hook into generating the model’s CoreSchema.

Parameters:

source (type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.
handler (GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.

Return type:

Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]

Returns:

A pydantic-core CoreSchema.

classmethod __get_pydantic_json_schema__(core_schema, handler, /)[source]

Hook into generating the model’s JSON schema.

Parameters:

core_schema (Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({'type': 'nullable', 'schema': current_schema}), or just call the handler with the original schema.
handler (GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.

Return type:

Returns:

A JSON schema, as a Python object.

__getattr__(item)[source]

Return type:: Any

__getstate__()[source]

Helper for pickle.

Return type:: dict[Any, Any]

__hash__ = None[source]

__init__(**data)[source]

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__iter__()[source]

So dict(model) works.

Return type:: Generator[Tuple[str, Any], None, None]

__module__ = 'kittycad.models.ok_modeling_cmd_response'[source]

__pretty__(fmt, **kwargs)[source]

Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.

Return type:: Generator[Any, None, None]

__private_attributes__: ClassVar[Dict[str, ModelPrivateAttr]] = {}[source]: Metadata about the private attributes of the model.

__pydantic_complete__: ClassVar[bool] = True[source]: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__: ClassVar[CoreSchema] = {'cls': <class 'kittycad.models.ok_modeling_cmd_response.OptionEnableSketchMode'>, 'config': {'title': 'OptionEnableSketchMode'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.ok_modeling_cmd_response.OptionEnableSketchMode'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.ok_modeling_cmd_response.OptionEnableSketchMode'>>]}, 'ref': 'kittycad.models.ok_modeling_cmd_response.OptionEnableSketchMode:94667213036576', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'data': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.enable_sketch_mode.EnableSketchMode'>, 'config': {'title': 'EnableSketchMode'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.enable_sketch_mode.EnableSketchMode'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.enable_sketch_mode.EnableSketchMode'>>]}, 'ref': 'kittycad.models.enable_sketch_mode.EnableSketchMode:94667206187488', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {}, 'model_name': 'EnableSketchMode', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}, 'type': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': 'enable_sketch_mode', 'schema': {'expected': ['enable_sketch_mode'], 'type': 'literal'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'OptionEnableSketchMode', 'type': 'model-fields'}, 'type': 'model'}[source]: The core schema of the model.

__pydantic_custom_init__: ClassVar[bool] = False[source]: Whether the model has a custom __init__ method.

__pydantic_decorators__: ClassVar[_decorators.DecoratorInfos] = DecoratorInfos(validators={}, field_validators={}, root_validators={}, field_serializers={}, model_serializers={}, model_validators={}, computed_fields={})[source]: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_extra__: dict[str, Any] | None[source]: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to 'allow'.

__pydantic_fields_set__: set[str][source]: The names of fields explicitly set during instantiation.

__pydantic_generic_metadata__: ClassVar[_generics.PydanticGenericMetadata] = {'args': (), 'origin': None, 'parameters': ()}[source]: 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.

classmethod __pydantic_init_subclass__(**kwargs)[source]

This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.

This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.

This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.

Parameters:: **kwargs (Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.
Return type:: None

__pydantic_parent_namespace__: ClassVar[Dict[str, Any] | None] = None[source]: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__: ClassVar[None | Literal['model_post_init']] = None[source]: The name of the post-init method for the model, if defined.

__pydantic_private__: dict[str, Any] | None[source]: Values of private attributes set on the model instance.

__pydantic_root_model__: ClassVar[bool] = False[source]: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__: ClassVar[SchemaSerializer] = SchemaSerializer(serializer=Model( ModelSerializer { class: Py( 0x000056196d9adc20, ), serializer: Fields( GeneralFieldsSerializer { fields: { "type": SerField { key_py: Py( 0x00007f903823d958, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f9034c761b0, ), ), serializer: Literal( LiteralSerializer { expected_int: {}, expected_str: { "enable_sketch_mode", }, expected_py: None, name: "literal['enable_sketch_mode']", }, ), }, ), ), required: true, }, "data": SerField { key_py: Py( 0x00007f9038238fa0, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196d3259e0, ), serializer: Fields( GeneralFieldsSerializer { fields: {}, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 0, }, ), has_extra: false, root_model: false, name: "EnableSketchMode", }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "OptionEnableSketchMode", }, ), definitions=[])[source]: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__: ClassVar[SchemaValidator | PluggableSchemaValidator] = SchemaValidator(title="OptionEnableSketchMode", validator=Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "data", lookup_key: Simple { key: "data", py_key: Py( 0x00007f90334d54a0, ), path: LookupPath( [ S( "data", Py( 0x00007f90334d4720, ), ), ], ), }, name_py: Py( 0x00007f9038238fa0, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [], model_name: "EnableSketchMode", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d3259e0, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "EnableSketchMode", }, ), frozen: false, }, Field { name: "type", lookup_key: Simple { key: "type", py_key: Py( 0x00007f90334d49f0, ), path: LookupPath( [ S( "type", Py( 0x00007f90334d5860, ), ), ], ), }, name_py: Py( 0x00007f903823d958, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f9034c761b0, ), ), on_error: Raise, validator: Literal( LiteralValidator { lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "enable_sketch_mode": 0, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f9034c761b0, ), ], }, expected_repr: "'enable_sketch_mode'", name: "literal['enable_sketch_mode']", }, ), validate_default: false, copy_default: false, name: "default[literal['enable_sketch_mode']]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "OptionEnableSketchMode", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d9adc20, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "OptionEnableSketchMode", }, ), definitions=[], cache_strings=True)[source]: The pydantic-core SchemaValidator used to validate instances of the model.

__repr__()[source]

Return repr(self).

Return type:: str

__repr_args__()[source]

Return type:: Iterable[tuple[str | None, Any]]

__repr_name__()[source]

Name of the instance’s class, used in __repr__.

Return type:: str

__repr_str__(join_str)[source]

Return type:: str

__rich_repr__()[source]

Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.

Return type:: Iterable[Any | tuple[Any] | tuple[str, Any] | tuple[str, Any, Any]]

__setattr__(name, value)[source]

Implement setattr(self, name, value).

Return type:: None

__setstate__(state)[source]

Return type:: None

__signature__: ClassVar[Signature] = <Signature (*, data: kittycad.models.enable_sketch_mode.EnableSketchMode, type: Literal['enable_sketch_mode'] = 'enable_sketch_mode') -> None>[source]: The synthesized __init__ [Signature][inspect.Signature] of the model.

__slots__ = ('__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__')[source]

__str__()[source]

Return str(self).

Return type:: str

_abc_impl = <_abc._abc_data object>[source]

_calculate_keys(*args, **kwargs)[source]

Return type:: Any

_check_frozen(name, value)[source]

Return type:: None

_copy_and_set_values(*args, **kwargs)[source]

Return type:: Any

classmethod _get_value(*args, **kwargs)[source]

Return type:: Any

_iter(*args, **kwargs)[source]

Return type:: Any

classmethod construct(_fields_set=None, **values)[source]

Return type:: Self

copy(*, include=None, exclude=None, update=None, deep=False)[source]

Returns a copy of the model.

!!! warning “Deprecated”: This method is now deprecated; use model_copy instead.

If you need include or exclude, use:

`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `

Parameters:

include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.

Returns:

A copy of the model with included, excluded and updated fields as specified.

data: EnableSketchMode[source]

dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)[source]

Return type:: Dict[str, Any]

classmethod from_orm(obj)[source]

Return type:: Self

json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)[source]

Return type:: str

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}[source]: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'protected_namespaces': ()}[source]: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod model_construct(_fields_set=None, **values)[source]

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note: model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == 'allow', then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == 'ignore' (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == 'forbid' does not result in an error if extra values are passed, but they will be ignored.

Parameters:

_fields_set (set[str] | None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.
values (Any) – Trusted or pre-validated data dictionary.

Return type:

Self

Returns:

A new instance of the Model class with validated data.

model_copy(*, update=None, deep=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy

Returns a copy of the model.

Parameters:

update (dict[str, Any] | None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.
deep (bool) – Set to True to make a deep copy of the model.

Return type:

Self

Returns:

New model instance.

model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters:

mode (Union[Literal['json', 'python'], str]) – The mode in which to_python 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.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to include in the output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to exclude from the output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to use the field’s alias in the dictionary key if defined.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A dictionary representation of the model.

model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

Generates a JSON representation of the model using Pydantic’s to_json method.

Parameters:

indent (int | None) – Indentation to use in the JSON output. If None is passed, the output will be compact.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to include in the JSON output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to exclude from the JSON output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to serialize using field aliases.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A JSON string representation of the model.

property model_extra: dict[str, Any] | None[source]

Get extra fields set during validation.

Returns:: A dictionary of extra fields, or None if config.extra is not set to "allow".

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=EnableSketchMode, required=True), 'type': FieldInfo(annotation=Literal['enable_sketch_mode'], required=False, default='enable_sketch_mode')}[source]

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

property model_fields_set: set[str][source]

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,: i.e. that were not filled from defaults.

classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')[source]

Generates a JSON schema for a model class.

Parameters:

by_alias (bool) – Whether to use attribute aliases or not.
ref_template (str) – The reference template.
schema_generator (type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modifications
mode (Literal['validation', 'serialization']) – The mode in which to generate the schema.

Return type:

Returns:

The JSON schema for the given model class.

classmethod model_parametrized_name(params)[source]

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

Parameters:: params (tuple[type[Any], ...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.
Return type:: str
Returns:: String representing the new class where params are passed to cls as type variables.
Raises:: TypeError – Raised when trying to generate concrete names for non-generic models.

model_post_init(_BaseModel__context)[source]

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

Return type:: None

classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)[source]

Try to rebuild the pydantic-core schema for the model.

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.

Parameters:

force (bool) – Whether to force the rebuilding of the model schema, defaults to False.
raise_errors (bool) – Whether to raise errors, defaults to True.
_parent_namespace_depth (int) – The depth level of the parent namespace, defaults to 2.
_types_namespace (dict[str, Any] | None) – The types namespace, defaults to None.

Return type:

Returns:

Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.

classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)[source]

Validate a pydantic model instance.

Parameters:

obj (Any) – The object to validate.
strict (bool | None) – Whether to enforce types strictly.
from_attributes (bool | None) – Whether to extract data from object attributes.
context (Any | None) – Additional context to pass to the validator.

Raises:

ValidationError – If the object could not be validated.

Return type:

Self

Returns:

The validated model instance.

classmethod model_validate_json(json_data, *, strict=None, context=None)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing

Validate the given JSON data against the Pydantic model.

Parameters:

json_data (str | bytes | bytearray) – The JSON data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

Raises:

ValidationError – If json_data is not a JSON string or the object could not be validated.

classmethod model_validate_strings(obj, *, strict=None, context=None)[source]

Validate the given object with string data against the Pydantic model.

Parameters:

obj (Any) – The object containing string data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod parse_obj(obj)[source]

Return type:: Self

classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod schema(by_alias=True, ref_template='#/$defs/{model}')[source]

Return type:: Dict[str, Any]

classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)[source]

Return type:: str

type: Literal['enable_sketch_mode'][source]

classmethod update_forward_refs(**localns)[source]

Return type:: None

classmethod validate(value)[source]

Return type:: Self

class kittycad.models.ok_modeling_cmd_response.OptionEntityCircularPattern(**data)[source][source]

The response to the ‘EntityCircularPattern’ endpoint

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__abstractmethods__ = frozenset({})[source]

__annotations__ = {'__class_vars__': 'ClassVar[set[str]]', '__private_attributes__': 'ClassVar[Dict[str, ModelPrivateAttr]]', '__pydantic_complete__': 'ClassVar[bool]', '__pydantic_core_schema__': 'ClassVar[CoreSchema]', '__pydantic_custom_init__': 'ClassVar[bool]', '__pydantic_decorators__': 'ClassVar[_decorators.DecoratorInfos]', '__pydantic_extra__': 'dict[str, Any] | None', '__pydantic_fields_set__': 'set[str]', '__pydantic_generic_metadata__': 'ClassVar[_generics.PydanticGenericMetadata]', '__pydantic_parent_namespace__': 'ClassVar[Dict[str, Any] | None]', '__pydantic_post_init__': "ClassVar[None | Literal['model_post_init']]", '__pydantic_private__': 'dict[str, Any] | None', '__pydantic_root_model__': 'ClassVar[bool]', '__pydantic_serializer__': 'ClassVar[SchemaSerializer]', '__pydantic_validator__': 'ClassVar[SchemaValidator | PluggableSchemaValidator]', '__signature__': 'ClassVar[Signature]', 'data': <class 'kittycad.models.entity_circular_pattern.EntityCircularPattern'>, 'model_computed_fields': 'ClassVar[Dict[str, ComputedFieldInfo]]', 'model_config': 'ClassVar[ConfigDict]', 'model_fields': 'ClassVar[Dict[str, FieldInfo]]', 'type': typing.Literal['entity_circular_pattern']}[source]

classmethod __class_getitem__(typevar_values)[source]

Return type:: type[BaseModel] | PydanticRecursiveRef

__class_vars__: ClassVar[set[str]] = {}[source]: The names of the class variables defined on the model.

__copy__()[source]

Returns a shallow copy of the model.

Return type:: Self

__deepcopy__(memo=None)[source]

Returns a deep copy of the model.

Return type:: Self

__delattr__(item)[source]

Implement delattr(self, name).

Return type:: Any

__dict__[source]

__eq__(other)[source]

Return self==value.

Return type:: bool

property __fields_set__: set[str][source]

classmethod __get_pydantic_core_schema__(source, handler, /)[source]

Hook into generating the model’s CoreSchema.

Parameters:

source (type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.
handler (GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.

Return type:

Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]

Returns:

A pydantic-core CoreSchema.

classmethod __get_pydantic_json_schema__(core_schema, handler, /)[source]

Hook into generating the model’s JSON schema.

Parameters:

core_schema (Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({'type': 'nullable', 'schema': current_schema}), or just call the handler with the original schema.
handler (GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.

Return type:

Returns:

A JSON schema, as a Python object.

__getattr__(item)[source]

Return type:: Any

__getstate__()[source]

Helper for pickle.

Return type:: dict[Any, Any]

__hash__ = None[source]

__init__(**data)[source]

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__iter__()[source]

So dict(model) works.

Return type:: Generator[Tuple[str, Any], None, None]

__module__ = 'kittycad.models.ok_modeling_cmd_response'[source]

__pretty__(fmt, **kwargs)[source]

Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.

Return type:: Generator[Any, None, None]

__private_attributes__: ClassVar[Dict[str, ModelPrivateAttr]] = {}[source]: Metadata about the private attributes of the model.

__pydantic_complete__: ClassVar[bool] = True[source]: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__: ClassVar[CoreSchema] = {'cls': <class 'kittycad.models.ok_modeling_cmd_response.OptionEntityCircularPattern'>, 'config': {'title': 'OptionEntityCircularPattern'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.ok_modeling_cmd_response.OptionEntityCircularPattern'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.ok_modeling_cmd_response.OptionEntityCircularPattern'>>]}, 'ref': 'kittycad.models.ok_modeling_cmd_response.OptionEntityCircularPattern:94667214077920', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'data': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.entity_circular_pattern.EntityCircularPattern'>, 'config': {'title': 'EntityCircularPattern'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.entity_circular_pattern.EntityCircularPattern'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.entity_circular_pattern.EntityCircularPattern'>>]}, 'ref': 'kittycad.models.entity_circular_pattern.EntityCircularPattern:94667206192304', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'entity_ids': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'items_schema': {'type': 'str'}, 'type': 'list'}, 'type': 'model-field'}}, 'model_name': 'EntityCircularPattern', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}, 'type': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': 'entity_circular_pattern', 'schema': {'expected': ['entity_circular_pattern'], 'type': 'literal'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'OptionEntityCircularPattern', 'type': 'model-fields'}, 'type': 'model'}[source]: The core schema of the model.

__pydantic_custom_init__: ClassVar[bool] = False[source]: Whether the model has a custom __init__ method.

__pydantic_decorators__: ClassVar[_decorators.DecoratorInfos] = DecoratorInfos(validators={}, field_validators={}, root_validators={}, field_serializers={}, model_serializers={}, model_validators={}, computed_fields={})[source]: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_extra__: dict[str, Any] | None[source]: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to 'allow'.

__pydantic_fields_set__: set[str][source]: The names of fields explicitly set during instantiation.

__pydantic_generic_metadata__: ClassVar[_generics.PydanticGenericMetadata] = {'args': (), 'origin': None, 'parameters': ()}[source]: 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.

classmethod __pydantic_init_subclass__(**kwargs)[source]

This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.

This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.

This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.

Parameters:: **kwargs (Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.
Return type:: None

__pydantic_parent_namespace__: ClassVar[Dict[str, Any] | None] = None[source]: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__: ClassVar[None | Literal['model_post_init']] = None[source]: The name of the post-init method for the model, if defined.

__pydantic_private__: dict[str, Any] | None[source]: Values of private attributes set on the model instance.

__pydantic_root_model__: ClassVar[bool] = False[source]: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__: ClassVar[SchemaSerializer] = SchemaSerializer(serializer=Model( ModelSerializer { class: Py( 0x000056196daabfe0, ), serializer: Fields( GeneralFieldsSerializer { fields: { "data": SerField { key_py: Py( 0x00007f9038238fa0, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196d326cb0, ), serializer: Fields( GeneralFieldsSerializer { fields: { "entity_ids": SerField { key_py: Py( 0x00007f9033b07170, ), alias: None, alias_py: None, serializer: Some( List( ListSerializer { item_serializer: Str( StrSerializer, ), filter: SchemaFilter { include: None, exclude: None, }, name: "list[str]", }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 1, }, ), has_extra: false, root_model: false, name: "EntityCircularPattern", }, ), ), required: true, }, "type": SerField { key_py: Py( 0x00007f903823d958, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f9034c770f0, ), ), serializer: Literal( LiteralSerializer { expected_int: {}, expected_str: { "entity_circular_pattern", }, expected_py: None, name: "literal['entity_circular_pattern']", }, ), }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "OptionEntityCircularPattern", }, ), definitions=[])[source]: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__: ClassVar[SchemaValidator | PluggableSchemaValidator] = SchemaValidator(title="OptionEntityCircularPattern", validator=Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "data", lookup_key: Simple { key: "data", py_key: Py( 0x00007f90333abcf0, ), path: LookupPath( [ S( "data", Py( 0x00007f90333abd20, ), ), ], ), }, name_py: Py( 0x00007f9038238fa0, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "entity_ids", lookup_key: Simple { key: "entity_ids", py_key: Py( 0x00007f90333e2af0, ), path: LookupPath( [ S( "entity_ids", Py( 0x00007f90333e2ab0, ), ), ], ), }, name_py: Py( 0x00007f9033b07170, ), validator: List( ListValidator { strict: false, item_validator: Some( Str( StrValidator { strict: false, coerce_numbers_to_str: false, }, ), ), min_length: None, max_length: None, name: OnceLock( <uninit>, ), fail_fast: false, }, ), frozen: false, }, ], model_name: "EntityCircularPattern", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d326cb0, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "EntityCircularPattern", }, ), frozen: false, }, Field { name: "type", lookup_key: Simple { key: "type", py_key: Py( 0x00007f90333abd50, ), path: LookupPath( [ S( "type", Py( 0x00007f90333abd80, ), ), ], ), }, name_py: Py( 0x00007f903823d958, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f9034c770f0, ), ), on_error: Raise, validator: Literal( LiteralValidator { lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "entity_circular_pattern": 0, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f9034c770f0, ), ], }, expected_repr: "'entity_circular_pattern'", name: "literal['entity_circular_pattern']", }, ), validate_default: false, copy_default: false, name: "default[literal['entity_circular_pattern']]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "OptionEntityCircularPattern", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196daabfe0, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "OptionEntityCircularPattern", }, ), definitions=[], cache_strings=True)[source]: The pydantic-core SchemaValidator used to validate instances of the model.

__repr__()[source]

Return repr(self).

Return type:: str

__repr_args__()[source]

Return type:: Iterable[tuple[str | None, Any]]

__repr_name__()[source]

Name of the instance’s class, used in __repr__.

Return type:: str

__repr_str__(join_str)[source]

Return type:: str

__rich_repr__()[source]

Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.

Return type:: Iterable[Any | tuple[Any] | tuple[str, Any] | tuple[str, Any, Any]]

__setattr__(name, value)[source]

Implement setattr(self, name, value).

Return type:: None

__setstate__(state)[source]

Return type:: None

__signature__: ClassVar[Signature] = <Signature (*, data: kittycad.models.entity_circular_pattern.EntityCircularPattern, type: Literal['entity_circular_pattern'] = 'entity_circular_pattern') -> None>[source]: The synthesized __init__ [Signature][inspect.Signature] of the model.

__slots__ = ('__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__')[source]

__str__()[source]

Return str(self).

Return type:: str

_abc_impl = <_abc._abc_data object>[source]

_calculate_keys(*args, **kwargs)[source]

Return type:: Any

_check_frozen(name, value)[source]

Return type:: None

_copy_and_set_values(*args, **kwargs)[source]

Return type:: Any

classmethod _get_value(*args, **kwargs)[source]

Return type:: Any

_iter(*args, **kwargs)[source]

Return type:: Any

classmethod construct(_fields_set=None, **values)[source]

Return type:: Self

copy(*, include=None, exclude=None, update=None, deep=False)[source]

Returns a copy of the model.

!!! warning “Deprecated”: This method is now deprecated; use model_copy instead.

If you need include or exclude, use:

`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `

Parameters:

include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.

Returns:

A copy of the model with included, excluded and updated fields as specified.

data: EntityCircularPattern[source]

dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)[source]

Return type:: Dict[str, Any]

classmethod from_orm(obj)[source]

Return type:: Self

json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)[source]

Return type:: str

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}[source]: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'protected_namespaces': ()}[source]: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod model_construct(_fields_set=None, **values)[source]

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note: model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == 'allow', then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == 'ignore' (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == 'forbid' does not result in an error if extra values are passed, but they will be ignored.

Parameters:

_fields_set (set[str] | None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.
values (Any) – Trusted or pre-validated data dictionary.

Return type:

Self

Returns:

A new instance of the Model class with validated data.

model_copy(*, update=None, deep=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy

Returns a copy of the model.

Parameters:

update (dict[str, Any] | None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.
deep (bool) – Set to True to make a deep copy of the model.

Return type:

Self

Returns:

New model instance.

model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters:

mode (Union[Literal['json', 'python'], str]) – The mode in which to_python 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.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to include in the output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to exclude from the output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to use the field’s alias in the dictionary key if defined.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A dictionary representation of the model.

model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

Generates a JSON representation of the model using Pydantic’s to_json method.

Parameters:

indent (int | None) – Indentation to use in the JSON output. If None is passed, the output will be compact.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to include in the JSON output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to exclude from the JSON output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to serialize using field aliases.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A JSON string representation of the model.

property model_extra: dict[str, Any] | None[source]

Get extra fields set during validation.

Returns:: A dictionary of extra fields, or None if config.extra is not set to "allow".

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=EntityCircularPattern, required=True), 'type': FieldInfo(annotation=Literal['entity_circular_pattern'], required=False, default='entity_circular_pattern')}[source]

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

property model_fields_set: set[str][source]

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,: i.e. that were not filled from defaults.

classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')[source]

Generates a JSON schema for a model class.

Parameters:

by_alias (bool) – Whether to use attribute aliases or not.
ref_template (str) – The reference template.
schema_generator (type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modifications
mode (Literal['validation', 'serialization']) – The mode in which to generate the schema.

Return type:

Returns:

The JSON schema for the given model class.

classmethod model_parametrized_name(params)[source]

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

Parameters:: params (tuple[type[Any], ...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.
Return type:: str
Returns:: String representing the new class where params are passed to cls as type variables.
Raises:: TypeError – Raised when trying to generate concrete names for non-generic models.

model_post_init(_BaseModel__context)[source]

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

Return type:: None

classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)[source]

Try to rebuild the pydantic-core schema for the model.

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.

Parameters:

force (bool) – Whether to force the rebuilding of the model schema, defaults to False.
raise_errors (bool) – Whether to raise errors, defaults to True.
_parent_namespace_depth (int) – The depth level of the parent namespace, defaults to 2.
_types_namespace (dict[str, Any] | None) – The types namespace, defaults to None.

Return type:

Returns:

Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.

classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)[source]

Validate a pydantic model instance.

Parameters:

obj (Any) – The object to validate.
strict (bool | None) – Whether to enforce types strictly.
from_attributes (bool | None) – Whether to extract data from object attributes.
context (Any | None) – Additional context to pass to the validator.

Raises:

ValidationError – If the object could not be validated.

Return type:

Self

Returns:

The validated model instance.

classmethod model_validate_json(json_data, *, strict=None, context=None)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing

Validate the given JSON data against the Pydantic model.

Parameters:

json_data (str | bytes | bytearray) – The JSON data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

Raises:

ValidationError – If json_data is not a JSON string or the object could not be validated.

classmethod model_validate_strings(obj, *, strict=None, context=None)[source]

Validate the given object with string data against the Pydantic model.

Parameters:

obj (Any) – The object containing string data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod parse_obj(obj)[source]

Return type:: Self

classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod schema(by_alias=True, ref_template='#/$defs/{model}')[source]

Return type:: Dict[str, Any]

classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)[source]

Return type:: str

type: Literal['entity_circular_pattern'][source]

classmethod update_forward_refs(**localns)[source]

Return type:: None

classmethod validate(value)[source]

Return type:: Self

class kittycad.models.ok_modeling_cmd_response.OptionEntityFade(**data)[source][source]

The response to the ‘EntityFade’ endpoint

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__abstractmethods__ = frozenset({})[source]

__annotations__ = {'__class_vars__': 'ClassVar[set[str]]', '__private_attributes__': 'ClassVar[Dict[str, ModelPrivateAttr]]', '__pydantic_complete__': 'ClassVar[bool]', '__pydantic_core_schema__': 'ClassVar[CoreSchema]', '__pydantic_custom_init__': 'ClassVar[bool]', '__pydantic_decorators__': 'ClassVar[_decorators.DecoratorInfos]', '__pydantic_extra__': 'dict[str, Any] | None', '__pydantic_fields_set__': 'set[str]', '__pydantic_generic_metadata__': 'ClassVar[_generics.PydanticGenericMetadata]', '__pydantic_parent_namespace__': 'ClassVar[Dict[str, Any] | None]', '__pydantic_post_init__': "ClassVar[None | Literal['model_post_init']]", '__pydantic_private__': 'dict[str, Any] | None', '__pydantic_root_model__': 'ClassVar[bool]', '__pydantic_serializer__': 'ClassVar[SchemaSerializer]', '__pydantic_validator__': 'ClassVar[SchemaValidator | PluggableSchemaValidator]', '__signature__': 'ClassVar[Signature]', 'data': <class 'kittycad.models.entity_fade.EntityFade'>, 'model_computed_fields': 'ClassVar[Dict[str, ComputedFieldInfo]]', 'model_config': 'ClassVar[ConfigDict]', 'model_fields': 'ClassVar[Dict[str, FieldInfo]]', 'type': typing.Literal['entity_fade']}[source]

classmethod __class_getitem__(typevar_values)[source]

Return type:: type[BaseModel] | PydanticRecursiveRef

__class_vars__: ClassVar[set[str]] = {}[source]: The names of the class variables defined on the model.

__copy__()[source]

Returns a shallow copy of the model.

Return type:: Self

__deepcopy__(memo=None)[source]

Returns a deep copy of the model.

Return type:: Self

__delattr__(item)[source]

Implement delattr(self, name).

Return type:: Any

__dict__[source]

__eq__(other)[source]

Return self==value.

Return type:: bool

property __fields_set__: set[str][source]

classmethod __get_pydantic_core_schema__(source, handler, /)[source]

Hook into generating the model’s CoreSchema.

Parameters:

source (type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.
handler (GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.

Return type:

Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]

Returns:

A pydantic-core CoreSchema.

classmethod __get_pydantic_json_schema__(core_schema, handler, /)[source]

Hook into generating the model’s JSON schema.

Parameters:

core_schema (Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({'type': 'nullable', 'schema': current_schema}), or just call the handler with the original schema.
handler (GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.

Return type:

Returns:

A JSON schema, as a Python object.

__getattr__(item)[source]

Return type:: Any

__getstate__()[source]

Helper for pickle.

Return type:: dict[Any, Any]

__hash__ = None[source]

__init__(**data)[source]

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__iter__()[source]

So dict(model) works.

Return type:: Generator[Tuple[str, Any], None, None]

__module__ = 'kittycad.models.ok_modeling_cmd_response'[source]

__pretty__(fmt, **kwargs)[source]

Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.

Return type:: Generator[Any, None, None]

__private_attributes__: ClassVar[Dict[str, ModelPrivateAttr]] = {}[source]: Metadata about the private attributes of the model.

__pydantic_complete__: ClassVar[bool] = True[source]: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__: ClassVar[CoreSchema] = {'cls': <class 'kittycad.models.ok_modeling_cmd_response.OptionEntityFade'>, 'config': {'title': 'OptionEntityFade'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.ok_modeling_cmd_response.OptionEntityFade'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.ok_modeling_cmd_response.OptionEntityFade'>>]}, 'ref': 'kittycad.models.ok_modeling_cmd_response.OptionEntityFade:94667212971376', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'data': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.entity_fade.EntityFade'>, 'config': {'title': 'EntityFade'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.entity_fade.EntityFade'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.entity_fade.EntityFade'>>]}, 'ref': 'kittycad.models.entity_fade.EntityFade:94667206206272', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {}, 'model_name': 'EntityFade', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}, 'type': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': 'entity_fade', 'schema': {'expected': ['entity_fade'], 'type': 'literal'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'OptionEntityFade', 'type': 'model-fields'}, 'type': 'model'}[source]: The core schema of the model.

__pydantic_custom_init__: ClassVar[bool] = False[source]: Whether the model has a custom __init__ method.

__pydantic_decorators__: ClassVar[_decorators.DecoratorInfos] = DecoratorInfos(validators={}, field_validators={}, root_validators={}, field_serializers={}, model_serializers={}, model_validators={}, computed_fields={})[source]: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_extra__: dict[str, Any] | None[source]: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to 'allow'.

__pydantic_fields_set__: set[str][source]: The names of fields explicitly set during instantiation.

__pydantic_generic_metadata__: ClassVar[_generics.PydanticGenericMetadata] = {'args': (), 'origin': None, 'parameters': ()}[source]: 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.

classmethod __pydantic_init_subclass__(**kwargs)[source]

This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.

This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.

This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.

Parameters:: **kwargs (Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.
Return type:: None

__pydantic_parent_namespace__: ClassVar[Dict[str, Any] | None] = None[source]: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__: ClassVar[None | Literal['model_post_init']] = None[source]: The name of the post-init method for the model, if defined.

__pydantic_private__: dict[str, Any] | None[source]: Values of private attributes set on the model instance.

__pydantic_root_model__: ClassVar[bool] = False[source]: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__: ClassVar[SchemaSerializer] = SchemaSerializer(serializer=Model( ModelSerializer { class: Py( 0x000056196d99dd70, ), serializer: Fields( GeneralFieldsSerializer { fields: { "data": SerField { key_py: Py( 0x00007f9038238fa0, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196d32a340, ), serializer: Fields( GeneralFieldsSerializer { fields: {}, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 0, }, ), has_extra: false, root_model: false, name: "EntityFade", }, ), ), required: true, }, "type": SerField { key_py: Py( 0x00007f903823d958, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f9034c77070, ), ), serializer: Literal( LiteralSerializer { expected_int: {}, expected_str: { "entity_fade", }, expected_py: None, name: "literal['entity_fade']", }, ), }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "OptionEntityFade", }, ), definitions=[])[source]: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__: ClassVar[SchemaValidator | PluggableSchemaValidator] = SchemaValidator(title="OptionEntityFade", validator=Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "data", lookup_key: Simple { key: "data", py_key: Py( 0x00007f90334d5ce0, ), path: LookupPath( [ S( "data", Py( 0x00007f90334d5cb0, ), ), ], ), }, name_py: Py( 0x00007f9038238fa0, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [], model_name: "EntityFade", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d32a340, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "EntityFade", }, ), frozen: false, }, Field { name: "type", lookup_key: Simple { key: "type", py_key: Py( 0x00007f90334d5e00, ), path: LookupPath( [ S( "type", Py( 0x00007f90334d5dd0, ), ), ], ), }, name_py: Py( 0x00007f903823d958, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f9034c77070, ), ), on_error: Raise, validator: Literal( LiteralValidator { lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "entity_fade": 0, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f9034c77070, ), ], }, expected_repr: "'entity_fade'", name: "literal['entity_fade']", }, ), validate_default: false, copy_default: false, name: "default[literal['entity_fade']]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "OptionEntityFade", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d99dd70, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "OptionEntityFade", }, ), definitions=[], cache_strings=True)[source]: The pydantic-core SchemaValidator used to validate instances of the model.

__repr__()[source]

Return repr(self).

Return type:: str

__repr_args__()[source]

Return type:: Iterable[tuple[str | None, Any]]

__repr_name__()[source]

Name of the instance’s class, used in __repr__.

Return type:: str

__repr_str__(join_str)[source]

Return type:: str

__rich_repr__()[source]

Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.

Return type:: Iterable[Any | tuple[Any] | tuple[str, Any] | tuple[str, Any, Any]]

__setattr__(name, value)[source]

Implement setattr(self, name, value).

Return type:: None

__setstate__(state)[source]

Return type:: None

__signature__: ClassVar[Signature] = <Signature (*, data: kittycad.models.entity_fade.EntityFade, type: Literal['entity_fade'] = 'entity_fade') -> None>[source]: The synthesized __init__ [Signature][inspect.Signature] of the model.

__slots__ = ('__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__')[source]

__str__()[source]

Return str(self).

Return type:: str

_abc_impl = <_abc._abc_data object>[source]

_calculate_keys(*args, **kwargs)[source]

Return type:: Any

_check_frozen(name, value)[source]

Return type:: None

_copy_and_set_values(*args, **kwargs)[source]

Return type:: Any

classmethod _get_value(*args, **kwargs)[source]

Return type:: Any

_iter(*args, **kwargs)[source]

Return type:: Any

classmethod construct(_fields_set=None, **values)[source]

Return type:: Self

copy(*, include=None, exclude=None, update=None, deep=False)[source]

Returns a copy of the model.

!!! warning “Deprecated”: This method is now deprecated; use model_copy instead.

If you need include or exclude, use:

`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `

Parameters:

include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.

Returns:

A copy of the model with included, excluded and updated fields as specified.

data: EntityFade[source]

dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)[source]

Return type:: Dict[str, Any]

classmethod from_orm(obj)[source]

Return type:: Self

json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)[source]

Return type:: str

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}[source]: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'protected_namespaces': ()}[source]: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod model_construct(_fields_set=None, **values)[source]

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note: model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == 'allow', then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == 'ignore' (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == 'forbid' does not result in an error if extra values are passed, but they will be ignored.

Parameters:

_fields_set (set[str] | None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.
values (Any) – Trusted or pre-validated data dictionary.

Return type:

Self

Returns:

A new instance of the Model class with validated data.

model_copy(*, update=None, deep=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy

Returns a copy of the model.

Parameters:

update (dict[str, Any] | None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.
deep (bool) – Set to True to make a deep copy of the model.

Return type:

Self

Returns:

New model instance.

model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters:

mode (Union[Literal['json', 'python'], str]) – The mode in which to_python 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.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to include in the output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to exclude from the output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to use the field’s alias in the dictionary key if defined.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A dictionary representation of the model.

model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

Generates a JSON representation of the model using Pydantic’s to_json method.

Parameters:

indent (int | None) – Indentation to use in the JSON output. If None is passed, the output will be compact.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to include in the JSON output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to exclude from the JSON output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to serialize using field aliases.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A JSON string representation of the model.

property model_extra: dict[str, Any] | None[source]

Get extra fields set during validation.

Returns:: A dictionary of extra fields, or None if config.extra is not set to "allow".

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=EntityFade, required=True), 'type': FieldInfo(annotation=Literal['entity_fade'], required=False, default='entity_fade')}[source]

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

property model_fields_set: set[str][source]

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,: i.e. that were not filled from defaults.

classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')[source]

Generates a JSON schema for a model class.

Parameters:

by_alias (bool) – Whether to use attribute aliases or not.
ref_template (str) – The reference template.
schema_generator (type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modifications
mode (Literal['validation', 'serialization']) – The mode in which to generate the schema.

Return type:

Returns:

The JSON schema for the given model class.

classmethod model_parametrized_name(params)[source]

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

Parameters:: params (tuple[type[Any], ...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.
Return type:: str
Returns:: String representing the new class where params are passed to cls as type variables.
Raises:: TypeError – Raised when trying to generate concrete names for non-generic models.

model_post_init(_BaseModel__context)[source]

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

Return type:: None

classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)[source]

Try to rebuild the pydantic-core schema for the model.

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.

Parameters:

force (bool) – Whether to force the rebuilding of the model schema, defaults to False.
raise_errors (bool) – Whether to raise errors, defaults to True.
_parent_namespace_depth (int) – The depth level of the parent namespace, defaults to 2.
_types_namespace (dict[str, Any] | None) – The types namespace, defaults to None.

Return type:

Returns:

Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.

classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)[source]

Validate a pydantic model instance.

Parameters:

obj (Any) – The object to validate.
strict (bool | None) – Whether to enforce types strictly.
from_attributes (bool | None) – Whether to extract data from object attributes.
context (Any | None) – Additional context to pass to the validator.

Raises:

ValidationError – If the object could not be validated.

Return type:

Self

Returns:

The validated model instance.

classmethod model_validate_json(json_data, *, strict=None, context=None)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing

Validate the given JSON data against the Pydantic model.

Parameters:

json_data (str | bytes | bytearray) – The JSON data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

Raises:

ValidationError – If json_data is not a JSON string or the object could not be validated.

classmethod model_validate_strings(obj, *, strict=None, context=None)[source]

Validate the given object with string data against the Pydantic model.

Parameters:

obj (Any) – The object containing string data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod parse_obj(obj)[source]

Return type:: Self

classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod schema(by_alias=True, ref_template='#/$defs/{model}')[source]

Return type:: Dict[str, Any]

classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)[source]

Return type:: str

type: Literal['entity_fade'][source]

classmethod update_forward_refs(**localns)[source]

Return type:: None

classmethod validate(value)[source]

Return type:: Self

class kittycad.models.ok_modeling_cmd_response.OptionEntityGetAllChildUuids(**data)[source][source]

The response to the ‘EntityGetAllChildUuids’ endpoint

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__abstractmethods__ = frozenset({})[source]

__annotations__ = {'__class_vars__': 'ClassVar[set[str]]', '__private_attributes__': 'ClassVar[Dict[str, ModelPrivateAttr]]', '__pydantic_complete__': 'ClassVar[bool]', '__pydantic_core_schema__': 'ClassVar[CoreSchema]', '__pydantic_custom_init__': 'ClassVar[bool]', '__pydantic_decorators__': 'ClassVar[_decorators.DecoratorInfos]', '__pydantic_extra__': 'dict[str, Any] | None', '__pydantic_fields_set__': 'set[str]', '__pydantic_generic_metadata__': 'ClassVar[_generics.PydanticGenericMetadata]', '__pydantic_parent_namespace__': 'ClassVar[Dict[str, Any] | None]', '__pydantic_post_init__': "ClassVar[None | Literal['model_post_init']]", '__pydantic_private__': 'dict[str, Any] | None', '__pydantic_root_model__': 'ClassVar[bool]', '__pydantic_serializer__': 'ClassVar[SchemaSerializer]', '__pydantic_validator__': 'ClassVar[SchemaValidator | PluggableSchemaValidator]', '__signature__': 'ClassVar[Signature]', 'data': <class 'kittycad.models.entity_get_all_child_uuids.EntityGetAllChildUuids'>, 'model_computed_fields': 'ClassVar[Dict[str, ComputedFieldInfo]]', 'model_config': 'ClassVar[ConfigDict]', 'model_fields': 'ClassVar[Dict[str, FieldInfo]]', 'type': typing.Literal['entity_get_all_child_uuids']}[source]

classmethod __class_getitem__(typevar_values)[source]

Return type:: type[BaseModel] | PydanticRecursiveRef

__class_vars__: ClassVar[set[str]] = {}[source]: The names of the class variables defined on the model.

__copy__()[source]

Returns a shallow copy of the model.

Return type:: Self

__deepcopy__(memo=None)[source]

Returns a deep copy of the model.

Return type:: Self

__delattr__(item)[source]

Implement delattr(self, name).

Return type:: Any

__dict__[source]

__eq__(other)[source]

Return self==value.

Return type:: bool

property __fields_set__: set[str][source]

classmethod __get_pydantic_core_schema__(source, handler, /)[source]

Hook into generating the model’s CoreSchema.

Parameters:

source (type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.
handler (GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.

Return type:

Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]

Returns:

A pydantic-core CoreSchema.

classmethod __get_pydantic_json_schema__(core_schema, handler, /)[source]

Hook into generating the model’s JSON schema.

Parameters:

core_schema (Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({'type': 'nullable', 'schema': current_schema}), or just call the handler with the original schema.
handler (GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.

Return type:

Returns:

A JSON schema, as a Python object.

__getattr__(item)[source]

Return type:: Any

__getstate__()[source]

Helper for pickle.

Return type:: dict[Any, Any]

__hash__ = None[source]

__init__(**data)[source]

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__iter__()[source]

So dict(model) works.

Return type:: Generator[Tuple[str, Any], None, None]

__module__ = 'kittycad.models.ok_modeling_cmd_response'[source]

__pretty__(fmt, **kwargs)[source]

Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.

Return type:: Generator[Any, None, None]

__private_attributes__: ClassVar[Dict[str, ModelPrivateAttr]] = {}[source]: Metadata about the private attributes of the model.

__pydantic_complete__: ClassVar[bool] = True[source]: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__: ClassVar[CoreSchema] = {'cls': <class 'kittycad.models.ok_modeling_cmd_response.OptionEntityGetAllChildUuids'>, 'config': {'title': 'OptionEntityGetAllChildUuids'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.ok_modeling_cmd_response.OptionEntityGetAllChildUuids'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.ok_modeling_cmd_response.OptionEntityGetAllChildUuids'>>]}, 'ref': 'kittycad.models.ok_modeling_cmd_response.OptionEntityGetAllChildUuids:94667213283024', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'data': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.entity_get_all_child_uuids.EntityGetAllChildUuids'>, 'config': {'title': 'EntityGetAllChildUuids'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.entity_get_all_child_uuids.EntityGetAllChildUuids'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.entity_get_all_child_uuids.EntityGetAllChildUuids'>>]}, 'ref': 'kittycad.models.entity_get_all_child_uuids.EntityGetAllChildUuids:94667206209520', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'entity_ids': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'items_schema': {'type': 'str'}, 'type': 'list'}, 'type': 'model-field'}}, 'model_name': 'EntityGetAllChildUuids', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}, 'type': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': 'entity_get_all_child_uuids', 'schema': {'expected': ['entity_get_all_child_uuids'], 'type': 'literal'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'OptionEntityGetAllChildUuids', 'type': 'model-fields'}, 'type': 'model'}[source]: The core schema of the model.

__pydantic_custom_init__: ClassVar[bool] = False[source]: Whether the model has a custom __init__ method.

__pydantic_decorators__: ClassVar[_decorators.DecoratorInfos] = DecoratorInfos(validators={}, field_validators={}, root_validators={}, field_serializers={}, model_serializers={}, model_validators={}, computed_fields={})[source]: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_extra__: dict[str, Any] | None[source]: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to 'allow'.

__pydantic_fields_set__: set[str][source]: The names of fields explicitly set during instantiation.

__pydantic_generic_metadata__: ClassVar[_generics.PydanticGenericMetadata] = {'args': (), 'origin': None, 'parameters': ()}[source]: 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.

classmethod __pydantic_init_subclass__(**kwargs)[source]

This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.

This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.

This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.

Parameters:: **kwargs (Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.
Return type:: None

__pydantic_parent_namespace__: ClassVar[Dict[str, Any] | None] = None[source]: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__: ClassVar[None | Literal['model_post_init']] = None[source]: The name of the post-init method for the model, if defined.

__pydantic_private__: dict[str, Any] | None[source]: Values of private attributes set on the model instance.

__pydantic_root_model__: ClassVar[bool] = False[source]: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__: ClassVar[SchemaSerializer] = SchemaSerializer(serializer=Model( ModelSerializer { class: Py( 0x000056196d9e9ed0, ), serializer: Fields( GeneralFieldsSerializer { fields: { "data": SerField { key_py: Py( 0x00007f9038238fa0, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196d32aff0, ), serializer: Fields( GeneralFieldsSerializer { fields: { "entity_ids": SerField { key_py: Py( 0x00007f9033b07170, ), alias: None, alias_py: None, serializer: Some( List( ListSerializer { item_serializer: Str( StrSerializer, ), filter: SchemaFilter { include: None, exclude: None, }, name: "list[str]", }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 1, }, ), has_extra: false, root_model: false, name: "EntityGetAllChildUuids", }, ), ), required: true, }, "type": SerField { key_py: Py( 0x00007f903823d958, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f9034696bf0, ), ), serializer: Literal( LiteralSerializer { expected_int: {}, expected_str: { "entity_get_all_child_uuids", }, expected_py: None, name: "literal['entity_get_all_child_uuids']", }, ), }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "OptionEntityGetAllChildUuids", }, ), definitions=[])[source]: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__: ClassVar[SchemaValidator | PluggableSchemaValidator] = SchemaValidator(title="OptionEntityGetAllChildUuids", validator=Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "data", lookup_key: Simple { key: "data", py_key: Py( 0x00007f9033611890, ), path: LookupPath( [ S( "data", Py( 0x00007f9033607f60, ), ), ], ), }, name_py: Py( 0x00007f9038238fa0, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "entity_ids", lookup_key: Simple { key: "entity_ids", py_key: Py( 0x00007f90333377f0, ), path: LookupPath( [ S( "entity_ids", Py( 0x00007f90334bc070, ), ), ], ), }, name_py: Py( 0x00007f9033b07170, ), validator: List( ListValidator { strict: false, item_validator: Some( Str( StrValidator { strict: false, coerce_numbers_to_str: false, }, ), ), min_length: None, max_length: None, name: OnceLock( <uninit>, ), fail_fast: false, }, ), frozen: false, }, ], model_name: "EntityGetAllChildUuids", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d32aff0, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "EntityGetAllChildUuids", }, ), frozen: false, }, Field { name: "type", lookup_key: Simple { key: "type", py_key: Py( 0x00007f9033607ea0, ), path: LookupPath( [ S( "type", Py( 0x00007f9033606490, ), ), ], ), }, name_py: Py( 0x00007f903823d958, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f9034696bf0, ), ), on_error: Raise, validator: Literal( LiteralValidator { lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "entity_get_all_child_uuids": 0, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f9034696bf0, ), ], }, expected_repr: "'entity_get_all_child_uuids'", name: "literal['entity_get_all_child_uuids']", }, ), validate_default: false, copy_default: false, name: "default[literal['entity_get_all_child_uuids']]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "OptionEntityGetAllChildUuids", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d9e9ed0, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "OptionEntityGetAllChildUuids", }, ), definitions=[], cache_strings=True)[source]: The pydantic-core SchemaValidator used to validate instances of the model.

__repr__()[source]

Return repr(self).

Return type:: str

__repr_args__()[source]

Return type:: Iterable[tuple[str | None, Any]]

__repr_name__()[source]

Name of the instance’s class, used in __repr__.

Return type:: str

__repr_str__(join_str)[source]

Return type:: str

__rich_repr__()[source]

Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.

Return type:: Iterable[Any | tuple[Any] | tuple[str, Any] | tuple[str, Any, Any]]

__setattr__(name, value)[source]

Implement setattr(self, name, value).

Return type:: None

__setstate__(state)[source]

Return type:: None

__signature__: ClassVar[Signature] = <Signature (*, data: kittycad.models.entity_get_all_child_uuids.EntityGetAllChildUuids, type: Literal['entity_get_all_child_uuids'] = 'entity_get_all_child_uuids') -> None>[source]: The synthesized __init__ [Signature][inspect.Signature] of the model.

__slots__ = ('__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__')[source]

__str__()[source]

Return str(self).

Return type:: str

_abc_impl = <_abc._abc_data object>[source]

_calculate_keys(*args, **kwargs)[source]

Return type:: Any

_check_frozen(name, value)[source]

Return type:: None

_copy_and_set_values(*args, **kwargs)[source]

Return type:: Any

classmethod _get_value(*args, **kwargs)[source]

Return type:: Any

_iter(*args, **kwargs)[source]

Return type:: Any

classmethod construct(_fields_set=None, **values)[source]

Return type:: Self

copy(*, include=None, exclude=None, update=None, deep=False)[source]

Returns a copy of the model.

!!! warning “Deprecated”: This method is now deprecated; use model_copy instead.

If you need include or exclude, use:

`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `

Parameters:

include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.

Returns:

A copy of the model with included, excluded and updated fields as specified.

data: EntityGetAllChildUuids[source]

dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)[source]

Return type:: Dict[str, Any]

classmethod from_orm(obj)[source]

Return type:: Self

json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)[source]

Return type:: str

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}[source]: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'protected_namespaces': ()}[source]: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod model_construct(_fields_set=None, **values)[source]

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note: model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == 'allow', then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == 'ignore' (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == 'forbid' does not result in an error if extra values are passed, but they will be ignored.

Parameters:

_fields_set (set[str] | None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.
values (Any) – Trusted or pre-validated data dictionary.

Return type:

Self

Returns:

A new instance of the Model class with validated data.

model_copy(*, update=None, deep=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy

Returns a copy of the model.

Parameters:

update (dict[str, Any] | None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.
deep (bool) – Set to True to make a deep copy of the model.

Return type:

Self

Returns:

New model instance.

model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters:

mode (Union[Literal['json', 'python'], str]) – The mode in which to_python 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.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to include in the output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to exclude from the output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to use the field’s alias in the dictionary key if defined.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A dictionary representation of the model.

model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

Generates a JSON representation of the model using Pydantic’s to_json method.

Parameters:

indent (int | None) – Indentation to use in the JSON output. If None is passed, the output will be compact.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to include in the JSON output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to exclude from the JSON output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to serialize using field aliases.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A JSON string representation of the model.

property model_extra: dict[str, Any] | None[source]

Get extra fields set during validation.

Returns:: A dictionary of extra fields, or None if config.extra is not set to "allow".

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=EntityGetAllChildUuids, required=True), 'type': FieldInfo(annotation=Literal['entity_get_all_child_uuids'], required=False, default='entity_get_all_child_uuids')}[source]

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

property model_fields_set: set[str][source]

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,: i.e. that were not filled from defaults.

classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')[source]

Generates a JSON schema for a model class.

Parameters:

by_alias (bool) – Whether to use attribute aliases or not.
ref_template (str) – The reference template.
schema_generator (type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modifications
mode (Literal['validation', 'serialization']) – The mode in which to generate the schema.

Return type:

Returns:

The JSON schema for the given model class.

classmethod model_parametrized_name(params)[source]

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

Parameters:: params (tuple[type[Any], ...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.
Return type:: str
Returns:: String representing the new class where params are passed to cls as type variables.
Raises:: TypeError – Raised when trying to generate concrete names for non-generic models.

model_post_init(_BaseModel__context)[source]

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

Return type:: None

classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)[source]

Try to rebuild the pydantic-core schema for the model.

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.

Parameters:

force (bool) – Whether to force the rebuilding of the model schema, defaults to False.
raise_errors (bool) – Whether to raise errors, defaults to True.
_parent_namespace_depth (int) – The depth level of the parent namespace, defaults to 2.
_types_namespace (dict[str, Any] | None) – The types namespace, defaults to None.

Return type:

Returns:

Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.

classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)[source]

Validate a pydantic model instance.

Parameters:

obj (Any) – The object to validate.
strict (bool | None) – Whether to enforce types strictly.
from_attributes (bool | None) – Whether to extract data from object attributes.
context (Any | None) – Additional context to pass to the validator.

Raises:

ValidationError – If the object could not be validated.

Return type:

Self

Returns:

The validated model instance.

classmethod model_validate_json(json_data, *, strict=None, context=None)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing

Validate the given JSON data against the Pydantic model.

Parameters:

json_data (str | bytes | bytearray) – The JSON data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

Raises:

ValidationError – If json_data is not a JSON string or the object could not be validated.

classmethod model_validate_strings(obj, *, strict=None, context=None)[source]

Validate the given object with string data against the Pydantic model.

Parameters:

obj (Any) – The object containing string data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod parse_obj(obj)[source]

Return type:: Self

classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod schema(by_alias=True, ref_template='#/$defs/{model}')[source]

Return type:: Dict[str, Any]

classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)[source]

Return type:: str

type: Literal['entity_get_all_child_uuids'][source]

classmethod update_forward_refs(**localns)[source]

Return type:: None

classmethod validate(value)[source]

Return type:: Self

class kittycad.models.ok_modeling_cmd_response.OptionEntityGetChildUuid(**data)[source][source]

The response to the ‘EntityGetChildUuid’ endpoint

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__abstractmethods__ = frozenset({})[source]

__annotations__ = {'__class_vars__': 'ClassVar[set[str]]', '__private_attributes__': 'ClassVar[Dict[str, ModelPrivateAttr]]', '__pydantic_complete__': 'ClassVar[bool]', '__pydantic_core_schema__': 'ClassVar[CoreSchema]', '__pydantic_custom_init__': 'ClassVar[bool]', '__pydantic_decorators__': 'ClassVar[_decorators.DecoratorInfos]', '__pydantic_extra__': 'dict[str, Any] | None', '__pydantic_fields_set__': 'set[str]', '__pydantic_generic_metadata__': 'ClassVar[_generics.PydanticGenericMetadata]', '__pydantic_parent_namespace__': 'ClassVar[Dict[str, Any] | None]', '__pydantic_post_init__': "ClassVar[None | Literal['model_post_init']]", '__pydantic_private__': 'dict[str, Any] | None', '__pydantic_root_model__': 'ClassVar[bool]', '__pydantic_serializer__': 'ClassVar[SchemaSerializer]', '__pydantic_validator__': 'ClassVar[SchemaValidator | PluggableSchemaValidator]', '__signature__': 'ClassVar[Signature]', 'data': <class 'kittycad.models.entity_get_child_uuid.EntityGetChildUuid'>, 'model_computed_fields': 'ClassVar[Dict[str, ComputedFieldInfo]]', 'model_config': 'ClassVar[ConfigDict]', 'model_fields': 'ClassVar[Dict[str, FieldInfo]]', 'type': typing.Literal['entity_get_child_uuid']}[source]

classmethod __class_getitem__(typevar_values)[source]

Return type:: type[BaseModel] | PydanticRecursiveRef

__class_vars__: ClassVar[set[str]] = {}[source]: The names of the class variables defined on the model.

__copy__()[source]

Returns a shallow copy of the model.

Return type:: Self

__deepcopy__(memo=None)[source]

Returns a deep copy of the model.

Return type:: Self

__delattr__(item)[source]

Implement delattr(self, name).

Return type:: Any

__dict__[source]

__eq__(other)[source]

Return self==value.

Return type:: bool

property __fields_set__: set[str][source]

classmethod __get_pydantic_core_schema__(source, handler, /)[source]

Hook into generating the model’s CoreSchema.

Parameters:

source (type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.
handler (GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.

Return type:

Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]

Returns:

A pydantic-core CoreSchema.

classmethod __get_pydantic_json_schema__(core_schema, handler, /)[source]

Hook into generating the model’s JSON schema.

Parameters:

core_schema (Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({'type': 'nullable', 'schema': current_schema}), or just call the handler with the original schema.
handler (GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.

Return type:

Returns:

A JSON schema, as a Python object.

__getattr__(item)[source]

Return type:: Any

__getstate__()[source]

Helper for pickle.

Return type:: dict[Any, Any]

__hash__ = None[source]

__init__(**data)[source]

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__iter__()[source]

So dict(model) works.

Return type:: Generator[Tuple[str, Any], None, None]

__module__ = 'kittycad.models.ok_modeling_cmd_response'[source]

__pretty__(fmt, **kwargs)[source]

Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.

Return type:: Generator[Any, None, None]

__private_attributes__: ClassVar[Dict[str, ModelPrivateAttr]] = {}[source]: Metadata about the private attributes of the model.

__pydantic_complete__: ClassVar[bool] = True[source]: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__: ClassVar[CoreSchema] = {'cls': <class 'kittycad.models.ok_modeling_cmd_response.OptionEntityGetChildUuid'>, 'config': {'title': 'OptionEntityGetChildUuid'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.ok_modeling_cmd_response.OptionEntityGetChildUuid'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.ok_modeling_cmd_response.OptionEntityGetChildUuid'>>]}, 'ref': 'kittycad.models.ok_modeling_cmd_response.OptionEntityGetChildUuid:94667213245968', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'data': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.entity_get_child_uuid.EntityGetChildUuid'>, 'config': {'title': 'EntityGetChildUuid'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.entity_get_child_uuid.EntityGetChildUuid'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.entity_get_child_uuid.EntityGetChildUuid'>>]}, 'ref': 'kittycad.models.entity_get_child_uuid.EntityGetChildUuid:94667206198928', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'entity_id': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'type': 'str'}, 'type': 'model-field'}}, 'model_name': 'EntityGetChildUuid', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}, 'type': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': 'entity_get_child_uuid', 'schema': {'expected': ['entity_get_child_uuid'], 'type': 'literal'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'OptionEntityGetChildUuid', 'type': 'model-fields'}, 'type': 'model'}[source]: The core schema of the model.

__pydantic_custom_init__: ClassVar[bool] = False[source]: Whether the model has a custom __init__ method.

__pydantic_decorators__: ClassVar[_decorators.DecoratorInfos] = DecoratorInfos(validators={}, field_validators={}, root_validators={}, field_serializers={}, model_serializers={}, model_validators={}, computed_fields={})[source]: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_extra__: dict[str, Any] | None[source]: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to 'allow'.

__pydantic_fields_set__: set[str][source]: The names of fields explicitly set during instantiation.

__pydantic_generic_metadata__: ClassVar[_generics.PydanticGenericMetadata] = {'args': (), 'origin': None, 'parameters': ()}[source]: 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.

classmethod __pydantic_init_subclass__(**kwargs)[source]

This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.

This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.

This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.

Parameters:: **kwargs (Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.
Return type:: None

__pydantic_parent_namespace__: ClassVar[Dict[str, Any] | None] = None[source]: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__: ClassVar[None | Literal['model_post_init']] = None[source]: The name of the post-init method for the model, if defined.

__pydantic_private__: dict[str, Any] | None[source]: Values of private attributes set on the model instance.

__pydantic_root_model__: ClassVar[bool] = False[source]: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__: ClassVar[SchemaSerializer] = SchemaSerializer(serializer=Model( ModelSerializer { class: Py( 0x000056196d9e0e10, ), serializer: Fields( GeneralFieldsSerializer { fields: { "type": SerField { key_py: Py( 0x00007f903823d958, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f9034c76d30, ), ), serializer: Literal( LiteralSerializer { expected_int: {}, expected_str: { "entity_get_child_uuid", }, expected_py: None, name: "literal['entity_get_child_uuid']", }, ), }, ), ), required: true, }, "data": SerField { key_py: Py( 0x00007f9038238fa0, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196d328690, ), serializer: Fields( GeneralFieldsSerializer { fields: { "entity_id": SerField { key_py: Py( 0x00007f9033b11430, ), alias: None, alias_py: None, serializer: Some( Str( StrSerializer, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 1, }, ), has_extra: false, root_model: false, name: "EntityGetChildUuid", }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "OptionEntityGetChildUuid", }, ), definitions=[])[source]: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__: ClassVar[SchemaValidator | PluggableSchemaValidator] = SchemaValidator(title="OptionEntityGetChildUuid", validator=Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "data", lookup_key: Simple { key: "data", py_key: Py( 0x00007f90335224c0, ), path: LookupPath( [ S( "data", Py( 0x00007f90335224f0, ), ), ], ), }, name_py: Py( 0x00007f9038238fa0, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "entity_id", lookup_key: Simple { key: "entity_id", py_key: Py( 0x00007f9033343970, ), path: LookupPath( [ S( "entity_id", Py( 0x00007f9033343930, ), ), ], ), }, name_py: Py( 0x00007f9033b11430, ), validator: Str( StrValidator { strict: false, coerce_numbers_to_str: false, }, ), frozen: false, }, ], model_name: "EntityGetChildUuid", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d328690, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "EntityGetChildUuid", }, ), frozen: false, }, Field { name: "type", lookup_key: Simple { key: "type", py_key: Py( 0x00007f9033522520, ), path: LookupPath( [ S( "type", Py( 0x00007f9033522550, ), ), ], ), }, name_py: Py( 0x00007f903823d958, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f9034c76d30, ), ), on_error: Raise, validator: Literal( LiteralValidator { lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "entity_get_child_uuid": 0, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f9034c76d30, ), ], }, expected_repr: "'entity_get_child_uuid'", name: "literal['entity_get_child_uuid']", }, ), validate_default: false, copy_default: false, name: "default[literal['entity_get_child_uuid']]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "OptionEntityGetChildUuid", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d9e0e10, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "OptionEntityGetChildUuid", }, ), definitions=[], cache_strings=True)[source]: The pydantic-core SchemaValidator used to validate instances of the model.

__repr__()[source]

Return repr(self).

Return type:: str

__repr_args__()[source]

Return type:: Iterable[tuple[str | None, Any]]

__repr_name__()[source]

Name of the instance’s class, used in __repr__.

Return type:: str

__repr_str__(join_str)[source]

Return type:: str

__rich_repr__()[source]

Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.

Return type:: Iterable[Any | tuple[Any] | tuple[str, Any] | tuple[str, Any, Any]]

__setattr__(name, value)[source]

Implement setattr(self, name, value).

Return type:: None

__setstate__(state)[source]

Return type:: None

__signature__: ClassVar[Signature] = <Signature (*, data: kittycad.models.entity_get_child_uuid.EntityGetChildUuid, type: Literal['entity_get_child_uuid'] = 'entity_get_child_uuid') -> None>[source]: The synthesized __init__ [Signature][inspect.Signature] of the model.

__slots__ = ('__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__')[source]

__str__()[source]

Return str(self).

Return type:: str

_abc_impl = <_abc._abc_data object>[source]

_calculate_keys(*args, **kwargs)[source]

Return type:: Any

_check_frozen(name, value)[source]

Return type:: None

_copy_and_set_values(*args, **kwargs)[source]

Return type:: Any

classmethod _get_value(*args, **kwargs)[source]

Return type:: Any

_iter(*args, **kwargs)[source]

Return type:: Any

classmethod construct(_fields_set=None, **values)[source]

Return type:: Self

copy(*, include=None, exclude=None, update=None, deep=False)[source]

Returns a copy of the model.

!!! warning “Deprecated”: This method is now deprecated; use model_copy instead.

If you need include or exclude, use:

`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `

Parameters:

include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.

Returns:

A copy of the model with included, excluded and updated fields as specified.

data: EntityGetChildUuid[source]

dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)[source]

Return type:: Dict[str, Any]

classmethod from_orm(obj)[source]

Return type:: Self

json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)[source]

Return type:: str

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}[source]: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'protected_namespaces': ()}[source]: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod model_construct(_fields_set=None, **values)[source]

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note: model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == 'allow', then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == 'ignore' (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == 'forbid' does not result in an error if extra values are passed, but they will be ignored.

Parameters:

_fields_set (set[str] | None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.
values (Any) – Trusted or pre-validated data dictionary.

Return type:

Self

Returns:

A new instance of the Model class with validated data.

model_copy(*, update=None, deep=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy

Returns a copy of the model.

Parameters:

update (dict[str, Any] | None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.
deep (bool) – Set to True to make a deep copy of the model.

Return type:

Self

Returns:

New model instance.

model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters:

mode (Union[Literal['json', 'python'], str]) – The mode in which to_python 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.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to include in the output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to exclude from the output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to use the field’s alias in the dictionary key if defined.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A dictionary representation of the model.

model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

Generates a JSON representation of the model using Pydantic’s to_json method.

Parameters:

indent (int | None) – Indentation to use in the JSON output. If None is passed, the output will be compact.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to include in the JSON output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to exclude from the JSON output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to serialize using field aliases.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A JSON string representation of the model.

property model_extra: dict[str, Any] | None[source]

Get extra fields set during validation.

Returns:: A dictionary of extra fields, or None if config.extra is not set to "allow".

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=EntityGetChildUuid, required=True), 'type': FieldInfo(annotation=Literal['entity_get_child_uuid'], required=False, default='entity_get_child_uuid')}[source]

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

property model_fields_set: set[str][source]

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,: i.e. that were not filled from defaults.

classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')[source]

Generates a JSON schema for a model class.

Parameters:

by_alias (bool) – Whether to use attribute aliases or not.
ref_template (str) – The reference template.
schema_generator (type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modifications
mode (Literal['validation', 'serialization']) – The mode in which to generate the schema.

Return type:

Returns:

The JSON schema for the given model class.

classmethod model_parametrized_name(params)[source]

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

Parameters:: params (tuple[type[Any], ...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.
Return type:: str
Returns:: String representing the new class where params are passed to cls as type variables.
Raises:: TypeError – Raised when trying to generate concrete names for non-generic models.

model_post_init(_BaseModel__context)[source]

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

Return type:: None

classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)[source]

Try to rebuild the pydantic-core schema for the model.

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.

Parameters:

force (bool) – Whether to force the rebuilding of the model schema, defaults to False.
raise_errors (bool) – Whether to raise errors, defaults to True.
_parent_namespace_depth (int) – The depth level of the parent namespace, defaults to 2.
_types_namespace (dict[str, Any] | None) – The types namespace, defaults to None.

Return type:

Returns:

Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.

classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)[source]

Validate a pydantic model instance.

Parameters:

obj (Any) – The object to validate.
strict (bool | None) – Whether to enforce types strictly.
from_attributes (bool | None) – Whether to extract data from object attributes.
context (Any | None) – Additional context to pass to the validator.

Raises:

ValidationError – If the object could not be validated.

Return type:

Self

Returns:

The validated model instance.

classmethod model_validate_json(json_data, *, strict=None, context=None)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing

Validate the given JSON data against the Pydantic model.

Parameters:

json_data (str | bytes | bytearray) – The JSON data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

Raises:

ValidationError – If json_data is not a JSON string or the object could not be validated.

classmethod model_validate_strings(obj, *, strict=None, context=None)[source]

Validate the given object with string data against the Pydantic model.

Parameters:

obj (Any) – The object containing string data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod parse_obj(obj)[source]

Return type:: Self

classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod schema(by_alias=True, ref_template='#/$defs/{model}')[source]

Return type:: Dict[str, Any]

classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)[source]

Return type:: str

type: Literal['entity_get_child_uuid'][source]

classmethod update_forward_refs(**localns)[source]

Return type:: None

classmethod validate(value)[source]

Return type:: Self

class kittycad.models.ok_modeling_cmd_response.OptionEntityGetDistance(**data)[source][source]

The response to the ‘EntityGetDistance’ endpoint

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__abstractmethods__ = frozenset({})[source]

__annotations__ = {'__class_vars__': 'ClassVar[set[str]]', '__private_attributes__': 'ClassVar[Dict[str, ModelPrivateAttr]]', '__pydantic_complete__': 'ClassVar[bool]', '__pydantic_core_schema__': 'ClassVar[CoreSchema]', '__pydantic_custom_init__': 'ClassVar[bool]', '__pydantic_decorators__': 'ClassVar[_decorators.DecoratorInfos]', '__pydantic_extra__': 'dict[str, Any] | None', '__pydantic_fields_set__': 'set[str]', '__pydantic_generic_metadata__': 'ClassVar[_generics.PydanticGenericMetadata]', '__pydantic_parent_namespace__': 'ClassVar[Dict[str, Any] | None]', '__pydantic_post_init__': "ClassVar[None | Literal['model_post_init']]", '__pydantic_private__': 'dict[str, Any] | None', '__pydantic_root_model__': 'ClassVar[bool]', '__pydantic_serializer__': 'ClassVar[SchemaSerializer]', '__pydantic_validator__': 'ClassVar[SchemaValidator | PluggableSchemaValidator]', '__signature__': 'ClassVar[Signature]', 'data': <class 'kittycad.models.entity_get_distance.EntityGetDistance'>, 'model_computed_fields': 'ClassVar[Dict[str, ComputedFieldInfo]]', 'model_config': 'ClassVar[ConfigDict]', 'model_fields': 'ClassVar[Dict[str, FieldInfo]]', 'type': typing.Literal['entity_get_distance']}[source]

classmethod __class_getitem__(typevar_values)[source]

Return type:: type[BaseModel] | PydanticRecursiveRef

__class_vars__: ClassVar[set[str]] = {}[source]: The names of the class variables defined on the model.

__copy__()[source]

Returns a shallow copy of the model.

Return type:: Self

__deepcopy__(memo=None)[source]

Returns a deep copy of the model.

Return type:: Self

__delattr__(item)[source]

Implement delattr(self, name).

Return type:: Any

__dict__[source]

__eq__(other)[source]

Return self==value.

Return type:: bool

property __fields_set__: set[str][source]

classmethod __get_pydantic_core_schema__(source, handler, /)[source]

Hook into generating the model’s CoreSchema.

Parameters:

source (type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.
handler (GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.

Return type:

Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]

Returns:

A pydantic-core CoreSchema.

classmethod __get_pydantic_json_schema__(core_schema, handler, /)[source]

Hook into generating the model’s JSON schema.

Parameters:

core_schema (Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({'type': 'nullable', 'schema': current_schema}), or just call the handler with the original schema.
handler (GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.

Return type:

Returns:

A JSON schema, as a Python object.

__getattr__(item)[source]

Return type:: Any

__getstate__()[source]

Helper for pickle.

Return type:: dict[Any, Any]

__hash__ = None[source]

__init__(**data)[source]

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__iter__()[source]

So dict(model) works.

Return type:: Generator[Tuple[str, Any], None, None]

__module__ = 'kittycad.models.ok_modeling_cmd_response'[source]

__pretty__(fmt, **kwargs)[source]

Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.

Return type:: Generator[Any, None, None]

__private_attributes__: ClassVar[Dict[str, ModelPrivateAttr]] = {}[source]: Metadata about the private attributes of the model.

__pydantic_complete__: ClassVar[bool] = True[source]: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__: ClassVar[CoreSchema] = {'cls': <class 'kittycad.models.ok_modeling_cmd_response.OptionEntityGetDistance'>, 'config': {'title': 'OptionEntityGetDistance'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.ok_modeling_cmd_response.OptionEntityGetDistance'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.ok_modeling_cmd_response.OptionEntityGetDistance'>>]}, 'ref': 'kittycad.models.ok_modeling_cmd_response.OptionEntityGetDistance:94667214029328', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'data': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.entity_get_distance.EntityGetDistance'>, 'config': {'title': 'EntityGetDistance'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.entity_get_distance.EntityGetDistance'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.entity_get_distance.EntityGetDistance'>>]}, 'ref': 'kittycad.models.entity_get_distance.EntityGetDistance:94667206203280', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'max_distance': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'function': {'function': <class 'kittycad.models.length_unit.LengthUnit'>, 'type': 'no-info'}, 'schema': {'type': 'float'}, 'type': 'function-after'}, 'type': 'model-field'}, 'min_distance': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'function': {'function': <class 'kittycad.models.length_unit.LengthUnit'>, 'type': 'no-info'}, 'schema': {'type': 'float'}, 'type': 'function-after'}, 'type': 'model-field'}}, 'model_name': 'EntityGetDistance', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}, 'type': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': 'entity_get_distance', 'schema': {'expected': ['entity_get_distance'], 'type': 'literal'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'OptionEntityGetDistance', 'type': 'model-fields'}, 'type': 'model'}[source]: The core schema of the model.

__pydantic_custom_init__: ClassVar[bool] = False[source]: Whether the model has a custom __init__ method.

__pydantic_decorators__: ClassVar[_decorators.DecoratorInfos] = DecoratorInfos(validators={}, field_validators={}, root_validators={}, field_serializers={}, model_serializers={}, model_validators={}, computed_fields={})[source]: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_extra__: dict[str, Any] | None[source]: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to 'allow'.

__pydantic_fields_set__: set[str][source]: The names of fields explicitly set during instantiation.

__pydantic_generic_metadata__: ClassVar[_generics.PydanticGenericMetadata] = {'args': (), 'origin': None, 'parameters': ()}[source]: 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.

classmethod __pydantic_init_subclass__(**kwargs)[source]

This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.

This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.

This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.

Parameters:: **kwargs (Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.
Return type:: None

__pydantic_parent_namespace__: ClassVar[Dict[str, Any] | None] = None[source]: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__: ClassVar[None | Literal['model_post_init']] = None[source]: The name of the post-init method for the model, if defined.

__pydantic_private__: dict[str, Any] | None[source]: Values of private attributes set on the model instance.

__pydantic_root_model__: ClassVar[bool] = False[source]: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__: ClassVar[SchemaSerializer] = SchemaSerializer(serializer=Model( ModelSerializer { class: Py( 0x000056196daa0210, ), serializer: Fields( GeneralFieldsSerializer { fields: { "type": SerField { key_py: Py( 0x00007f903823d958, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f90347d6530, ), ), serializer: Literal( LiteralSerializer { expected_int: {}, expected_str: { "entity_get_distance", }, expected_py: None, name: "literal['entity_get_distance']", }, ), }, ), ), required: true, }, "data": SerField { key_py: Py( 0x00007f9038238fa0, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196d329790, ), serializer: Fields( GeneralFieldsSerializer { fields: { "max_distance": SerField { key_py: Py( 0x00007f90371dddb0, ), alias: None, alias_py: None, serializer: Some( Float( FloatSerializer { inf_nan_mode: Null, }, ), ), required: true, }, "min_distance": SerField { key_py: Py( 0x00007f9033b12130, ), alias: None, alias_py: None, serializer: Some( Float( FloatSerializer { inf_nan_mode: Null, }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "EntityGetDistance", }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "OptionEntityGetDistance", }, ), definitions=[])[source]: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__: ClassVar[SchemaValidator | PluggableSchemaValidator] = SchemaValidator(title="OptionEntityGetDistance", validator=Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "data", lookup_key: Simple { key: "data", py_key: Py( 0x00007f90333a9c80, ), path: LookupPath( [ S( "data", Py( 0x00007f90333aaee0, ), ), ], ), }, name_py: Py( 0x00007f9038238fa0, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "max_distance", lookup_key: Simple { key: "max_distance", py_key: Py( 0x00007f90333d6db0, ), path: LookupPath( [ S( "max_distance", Py( 0x00007f90333d6d70, ), ), ], ), }, name_py: Py( 0x00007f90371dddb0, ), validator: FunctionAfter( FunctionAfterValidator { validator: Float( FloatValidator { strict: false, allow_inf_nan: true, }, ), func: Py( 0x000056196d329300, ), config: Py( 0x00007f90333d6b40, ), name: "function-after[LengthUnit(), float]", field_name: None, info_arg: false, }, ), frozen: false, }, Field { name: "min_distance", lookup_key: Simple { key: "min_distance", py_key: Py( 0x00007f90333d6e30, ), path: LookupPath( [ S( "min_distance", Py( 0x00007f90333d6df0, ), ), ], ), }, name_py: Py( 0x00007f9033b12130, ), validator: FunctionAfter( FunctionAfterValidator { validator: Float( FloatValidator { strict: false, allow_inf_nan: true, }, ), func: Py( 0x000056196d329300, ), config: Py( 0x00007f90333d6b40, ), name: "function-after[LengthUnit(), float]", field_name: None, info_arg: false, }, ), frozen: false, }, ], model_name: "EntityGetDistance", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d329790, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "EntityGetDistance", }, ), frozen: false, }, Field { name: "type", lookup_key: Simple { key: "type", py_key: Py( 0x00007f90333aad90, ), path: LookupPath( [ S( "type", Py( 0x00007f90333aad60, ), ), ], ), }, name_py: Py( 0x00007f903823d958, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f90347d6530, ), ), on_error: Raise, validator: Literal( LiteralValidator { lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "entity_get_distance": 0, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f90347d6530, ), ], }, expected_repr: "'entity_get_distance'", name: "literal['entity_get_distance']", }, ), validate_default: false, copy_default: false, name: "default[literal['entity_get_distance']]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "OptionEntityGetDistance", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196daa0210, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "OptionEntityGetDistance", }, ), definitions=[], cache_strings=True)[source]: The pydantic-core SchemaValidator used to validate instances of the model.

__repr__()[source]

Return repr(self).

Return type:: str

__repr_args__()[source]

Return type:: Iterable[tuple[str | None, Any]]

__repr_name__()[source]

Name of the instance’s class, used in __repr__.

Return type:: str

__repr_str__(join_str)[source]

Return type:: str

__rich_repr__()[source]

Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.

Return type:: Iterable[Any | tuple[Any] | tuple[str, Any] | tuple[str, Any, Any]]

__setattr__(name, value)[source]

Implement setattr(self, name, value).

Return type:: None

__setstate__(state)[source]

Return type:: None

__signature__: ClassVar[Signature] = <Signature (*, data: kittycad.models.entity_get_distance.EntityGetDistance, type: Literal['entity_get_distance'] = 'entity_get_distance') -> None>[source]: The synthesized __init__ [Signature][inspect.Signature] of the model.

__slots__ = ('__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__')[source]

__str__()[source]

Return str(self).

Return type:: str

_abc_impl = <_abc._abc_data object>[source]

_calculate_keys(*args, **kwargs)[source]

Return type:: Any

_check_frozen(name, value)[source]

Return type:: None

_copy_and_set_values(*args, **kwargs)[source]

Return type:: Any

classmethod _get_value(*args, **kwargs)[source]

Return type:: Any

_iter(*args, **kwargs)[source]

Return type:: Any

classmethod construct(_fields_set=None, **values)[source]

Return type:: Self

copy(*, include=None, exclude=None, update=None, deep=False)[source]

Returns a copy of the model.

!!! warning “Deprecated”: This method is now deprecated; use model_copy instead.

If you need include or exclude, use:

`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `

Parameters:

include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.

Returns:

A copy of the model with included, excluded and updated fields as specified.

data: EntityGetDistance[source]

dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)[source]

Return type:: Dict[str, Any]

classmethod from_orm(obj)[source]

Return type:: Self

json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)[source]

Return type:: str

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}[source]: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'protected_namespaces': ()}[source]: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod model_construct(_fields_set=None, **values)[source]

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note: model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == 'allow', then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == 'ignore' (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == 'forbid' does not result in an error if extra values are passed, but they will be ignored.

Parameters:

_fields_set (set[str] | None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.
values (Any) – Trusted or pre-validated data dictionary.

Return type:

Self

Returns:

A new instance of the Model class with validated data.

model_copy(*, update=None, deep=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy

Returns a copy of the model.

Parameters:

update (dict[str, Any] | None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.
deep (bool) – Set to True to make a deep copy of the model.

Return type:

Self

Returns:

New model instance.

model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters:

mode (Union[Literal['json', 'python'], str]) – The mode in which to_python 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.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to include in the output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to exclude from the output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to use the field’s alias in the dictionary key if defined.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A dictionary representation of the model.

model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

Generates a JSON representation of the model using Pydantic’s to_json method.

Parameters:

indent (int | None) – Indentation to use in the JSON output. If None is passed, the output will be compact.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to include in the JSON output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to exclude from the JSON output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to serialize using field aliases.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A JSON string representation of the model.

property model_extra: dict[str, Any] | None[source]

Get extra fields set during validation.

Returns:: A dictionary of extra fields, or None if config.extra is not set to "allow".

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=EntityGetDistance, required=True), 'type': FieldInfo(annotation=Literal['entity_get_distance'], required=False, default='entity_get_distance')}[source]

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

property model_fields_set: set[str][source]

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,: i.e. that were not filled from defaults.

classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')[source]

Generates a JSON schema for a model class.

Parameters:

by_alias (bool) – Whether to use attribute aliases or not.
ref_template (str) – The reference template.
schema_generator (type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modifications
mode (Literal['validation', 'serialization']) – The mode in which to generate the schema.

Return type:

Returns:

The JSON schema for the given model class.

classmethod model_parametrized_name(params)[source]

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

Parameters:: params (tuple[type[Any], ...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.
Return type:: str
Returns:: String representing the new class where params are passed to cls as type variables.
Raises:: TypeError – Raised when trying to generate concrete names for non-generic models.

model_post_init(_BaseModel__context)[source]

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

Return type:: None

classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)[source]

Try to rebuild the pydantic-core schema for the model.

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.

Parameters:

force (bool) – Whether to force the rebuilding of the model schema, defaults to False.
raise_errors (bool) – Whether to raise errors, defaults to True.
_parent_namespace_depth (int) – The depth level of the parent namespace, defaults to 2.
_types_namespace (dict[str, Any] | None) – The types namespace, defaults to None.

Return type:

Returns:

Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.

classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)[source]

Validate a pydantic model instance.

Parameters:

obj (Any) – The object to validate.
strict (bool | None) – Whether to enforce types strictly.
from_attributes (bool | None) – Whether to extract data from object attributes.
context (Any | None) – Additional context to pass to the validator.

Raises:

ValidationError – If the object could not be validated.

Return type:

Self

Returns:

The validated model instance.

classmethod model_validate_json(json_data, *, strict=None, context=None)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing

Validate the given JSON data against the Pydantic model.

Parameters:

json_data (str | bytes | bytearray) – The JSON data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

Raises:

ValidationError – If json_data is not a JSON string or the object could not be validated.

classmethod model_validate_strings(obj, *, strict=None, context=None)[source]

Validate the given object with string data against the Pydantic model.

Parameters:

obj (Any) – The object containing string data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod parse_obj(obj)[source]

Return type:: Self

classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod schema(by_alias=True, ref_template='#/$defs/{model}')[source]

Return type:: Dict[str, Any]

classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)[source]

Return type:: str

type: Literal['entity_get_distance'][source]

classmethod update_forward_refs(**localns)[source]

Return type:: None

classmethod validate(value)[source]

Return type:: Self

class kittycad.models.ok_modeling_cmd_response.OptionEntityGetNumChildren(**data)[source][source]

The response to the ‘EntityGetNumChildren’ endpoint

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__abstractmethods__ = frozenset({})[source]

__annotations__ = {'__class_vars__': 'ClassVar[set[str]]', '__private_attributes__': 'ClassVar[Dict[str, ModelPrivateAttr]]', '__pydantic_complete__': 'ClassVar[bool]', '__pydantic_core_schema__': 'ClassVar[CoreSchema]', '__pydantic_custom_init__': 'ClassVar[bool]', '__pydantic_decorators__': 'ClassVar[_decorators.DecoratorInfos]', '__pydantic_extra__': 'dict[str, Any] | None', '__pydantic_fields_set__': 'set[str]', '__pydantic_generic_metadata__': 'ClassVar[_generics.PydanticGenericMetadata]', '__pydantic_parent_namespace__': 'ClassVar[Dict[str, Any] | None]', '__pydantic_post_init__': "ClassVar[None | Literal['model_post_init']]", '__pydantic_private__': 'dict[str, Any] | None', '__pydantic_root_model__': 'ClassVar[bool]', '__pydantic_serializer__': 'ClassVar[SchemaSerializer]', '__pydantic_validator__': 'ClassVar[SchemaValidator | PluggableSchemaValidator]', '__signature__': 'ClassVar[Signature]', 'data': <class 'kittycad.models.entity_get_num_children.EntityGetNumChildren'>, 'model_computed_fields': 'ClassVar[Dict[str, ComputedFieldInfo]]', 'model_config': 'ClassVar[ConfigDict]', 'model_fields': 'ClassVar[Dict[str, FieldInfo]]', 'type': typing.Literal['entity_get_num_children']}[source]

classmethod __class_getitem__(typevar_values)[source]

Return type:: type[BaseModel] | PydanticRecursiveRef

__class_vars__: ClassVar[set[str]] = {}[source]: The names of the class variables defined on the model.

__copy__()[source]

Returns a shallow copy of the model.

Return type:: Self

__deepcopy__(memo=None)[source]

Returns a deep copy of the model.

Return type:: Self

__delattr__(item)[source]

Implement delattr(self, name).

Return type:: Any

__dict__[source]

__eq__(other)[source]

Return self==value.

Return type:: bool

property __fields_set__: set[str][source]

classmethod __get_pydantic_core_schema__(source, handler, /)[source]

Hook into generating the model’s CoreSchema.

Parameters:

source (type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.
handler (GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.

Return type:

Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]

Returns:

A pydantic-core CoreSchema.

classmethod __get_pydantic_json_schema__(core_schema, handler, /)[source]

Hook into generating the model’s JSON schema.

Parameters:

core_schema (Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({'type': 'nullable', 'schema': current_schema}), or just call the handler with the original schema.
handler (GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.

Return type:

Returns:

A JSON schema, as a Python object.

__getattr__(item)[source]

Return type:: Any

__getstate__()[source]

Helper for pickle.

Return type:: dict[Any, Any]

__hash__ = None[source]

__init__(**data)[source]

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__iter__()[source]

So dict(model) works.

Return type:: Generator[Tuple[str, Any], None, None]

__module__ = 'kittycad.models.ok_modeling_cmd_response'[source]

__pretty__(fmt, **kwargs)[source]

Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.

Return type:: Generator[Any, None, None]

__private_attributes__: ClassVar[Dict[str, ModelPrivateAttr]] = {}[source]: Metadata about the private attributes of the model.

__pydantic_complete__: ClassVar[bool] = True[source]: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__: ClassVar[CoreSchema] = {'cls': <class 'kittycad.models.ok_modeling_cmd_response.OptionEntityGetNumChildren'>, 'config': {'title': 'OptionEntityGetNumChildren'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.ok_modeling_cmd_response.OptionEntityGetNumChildren'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.ok_modeling_cmd_response.OptionEntityGetNumChildren'>>]}, 'ref': 'kittycad.models.ok_modeling_cmd_response.OptionEntityGetNumChildren:94667213251504', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'data': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.entity_get_num_children.EntityGetNumChildren'>, 'config': {'title': 'EntityGetNumChildren'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.entity_get_num_children.EntityGetNumChildren'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.entity_get_num_children.EntityGetNumChildren'>>]}, 'ref': 'kittycad.models.entity_get_num_children.EntityGetNumChildren:94667206222512', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'num': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'type': 'int'}, 'type': 'model-field'}}, 'model_name': 'EntityGetNumChildren', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}, 'type': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': 'entity_get_num_children', 'schema': {'expected': ['entity_get_num_children'], 'type': 'literal'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'OptionEntityGetNumChildren', 'type': 'model-fields'}, 'type': 'model'}[source]: The core schema of the model.

__pydantic_custom_init__: ClassVar[bool] = False[source]: Whether the model has a custom __init__ method.

__pydantic_decorators__: ClassVar[_decorators.DecoratorInfos] = DecoratorInfos(validators={}, field_validators={}, root_validators={}, field_serializers={}, model_serializers={}, model_validators={}, computed_fields={})[source]: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_extra__: dict[str, Any] | None[source]: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to 'allow'.

__pydantic_fields_set__: set[str][source]: The names of fields explicitly set during instantiation.

__pydantic_generic_metadata__: ClassVar[_generics.PydanticGenericMetadata] = {'args': (), 'origin': None, 'parameters': ()}[source]: 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.

classmethod __pydantic_init_subclass__(**kwargs)[source]

This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.

This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.

This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.

Parameters:: **kwargs (Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.
Return type:: None

__pydantic_parent_namespace__: ClassVar[Dict[str, Any] | None] = None[source]: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__: ClassVar[None | Literal['model_post_init']] = None[source]: The name of the post-init method for the model, if defined.

__pydantic_private__: dict[str, Any] | None[source]: Values of private attributes set on the model instance.

__pydantic_root_model__: ClassVar[bool] = False[source]: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__: ClassVar[SchemaSerializer] = SchemaSerializer(serializer=Model( ModelSerializer { class: Py( 0x000056196d9e23b0, ), serializer: Fields( GeneralFieldsSerializer { fields: { "data": SerField { key_py: Py( 0x00007f9038238fa0, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196d32e2b0, ), serializer: Fields( GeneralFieldsSerializer { fields: { "num": SerField { key_py: Py( 0x00007f9037733630, ), alias: None, alias_py: None, serializer: Some( Int( IntSerializer, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 1, }, ), has_extra: false, root_model: false, name: "EntityGetNumChildren", }, ), ), required: true, }, "type": SerField { key_py: Py( 0x00007f903823d958, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f90347d6a30, ), ), serializer: Literal( LiteralSerializer { expected_int: {}, expected_str: { "entity_get_num_children", }, expected_py: None, name: "literal['entity_get_num_children']", }, ), }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "OptionEntityGetNumChildren", }, ), definitions=[])[source]: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__: ClassVar[SchemaValidator | PluggableSchemaValidator] = SchemaValidator(title="OptionEntityGetNumChildren", validator=Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "data", lookup_key: Simple { key: "data", py_key: Py( 0x00007f9033522a30, ), path: LookupPath( [ S( "data", Py( 0x00007f9033522a60, ), ), ], ), }, name_py: Py( 0x00007f9038238fa0, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "num", lookup_key: Simple { key: "num", py_key: Py( 0x00007f90335229d0, ), path: LookupPath( [ S( "num", Py( 0x00007f9033522a00, ), ), ], ), }, name_py: Py( 0x00007f9037733630, ), validator: Int( IntValidator { strict: false, }, ), frozen: false, }, ], model_name: "EntityGetNumChildren", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d32e2b0, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "EntityGetNumChildren", }, ), frozen: false, }, Field { name: "type", lookup_key: Simple { key: "type", py_key: Py( 0x00007f9033522a90, ), path: LookupPath( [ S( "type", Py( 0x00007f9033522ac0, ), ), ], ), }, name_py: Py( 0x00007f903823d958, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f90347d6a30, ), ), on_error: Raise, validator: Literal( LiteralValidator { lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "entity_get_num_children": 0, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f90347d6a30, ), ], }, expected_repr: "'entity_get_num_children'", name: "literal['entity_get_num_children']", }, ), validate_default: false, copy_default: false, name: "default[literal['entity_get_num_children']]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "OptionEntityGetNumChildren", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d9e23b0, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "OptionEntityGetNumChildren", }, ), definitions=[], cache_strings=True)[source]: The pydantic-core SchemaValidator used to validate instances of the model.

__repr__()[source]

Return repr(self).

Return type:: str

__repr_args__()[source]

Return type:: Iterable[tuple[str | None, Any]]

__repr_name__()[source]

Name of the instance’s class, used in __repr__.

Return type:: str

__repr_str__(join_str)[source]

Return type:: str

__rich_repr__()[source]

Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.

Return type:: Iterable[Any | tuple[Any] | tuple[str, Any] | tuple[str, Any, Any]]

__setattr__(name, value)[source]

Implement setattr(self, name, value).

Return type:: None

__setstate__(state)[source]

Return type:: None

__signature__: ClassVar[Signature] = <Signature (*, data: kittycad.models.entity_get_num_children.EntityGetNumChildren, type: Literal['entity_get_num_children'] = 'entity_get_num_children') -> None>[source]: The synthesized __init__ [Signature][inspect.Signature] of the model.

__slots__ = ('__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__')[source]

__str__()[source]

Return str(self).

Return type:: str

_abc_impl = <_abc._abc_data object>[source]

_calculate_keys(*args, **kwargs)[source]

Return type:: Any

_check_frozen(name, value)[source]

Return type:: None

_copy_and_set_values(*args, **kwargs)[source]

Return type:: Any

classmethod _get_value(*args, **kwargs)[source]

Return type:: Any

_iter(*args, **kwargs)[source]

Return type:: Any

classmethod construct(_fields_set=None, **values)[source]

Return type:: Self

copy(*, include=None, exclude=None, update=None, deep=False)[source]

Returns a copy of the model.

!!! warning “Deprecated”: This method is now deprecated; use model_copy instead.

If you need include or exclude, use:

`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `

Parameters:

include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.

Returns:

A copy of the model with included, excluded and updated fields as specified.

data: EntityGetNumChildren[source]

dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)[source]

Return type:: Dict[str, Any]

classmethod from_orm(obj)[source]

Return type:: Self

json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)[source]

Return type:: str

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}[source]: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'protected_namespaces': ()}[source]: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod model_construct(_fields_set=None, **values)[source]

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note: model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == 'allow', then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == 'ignore' (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == 'forbid' does not result in an error if extra values are passed, but they will be ignored.

Parameters:

_fields_set (set[str] | None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.
values (Any) – Trusted or pre-validated data dictionary.

Return type:

Self

Returns:

A new instance of the Model class with validated data.

model_copy(*, update=None, deep=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy

Returns a copy of the model.

Parameters:

update (dict[str, Any] | None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.
deep (bool) – Set to True to make a deep copy of the model.

Return type:

Self

Returns:

New model instance.

model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters:

mode (Union[Literal['json', 'python'], str]) – The mode in which to_python 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.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to include in the output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to exclude from the output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to use the field’s alias in the dictionary key if defined.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A dictionary representation of the model.

model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

Generates a JSON representation of the model using Pydantic’s to_json method.

Parameters:

indent (int | None) – Indentation to use in the JSON output. If None is passed, the output will be compact.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to include in the JSON output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to exclude from the JSON output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to serialize using field aliases.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A JSON string representation of the model.

property model_extra: dict[str, Any] | None[source]

Get extra fields set during validation.

Returns:: A dictionary of extra fields, or None if config.extra is not set to "allow".

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=EntityGetNumChildren, required=True), 'type': FieldInfo(annotation=Literal['entity_get_num_children'], required=False, default='entity_get_num_children')}[source]

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

property model_fields_set: set[str][source]

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,: i.e. that were not filled from defaults.

classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')[source]

Generates a JSON schema for a model class.

Parameters:

by_alias (bool) – Whether to use attribute aliases or not.
ref_template (str) – The reference template.
schema_generator (type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modifications
mode (Literal['validation', 'serialization']) – The mode in which to generate the schema.

Return type:

Returns:

The JSON schema for the given model class.

classmethod model_parametrized_name(params)[source]

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

Parameters:: params (tuple[type[Any], ...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.
Return type:: str
Returns:: String representing the new class where params are passed to cls as type variables.
Raises:: TypeError – Raised when trying to generate concrete names for non-generic models.

model_post_init(_BaseModel__context)[source]

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

Return type:: None

classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)[source]

Try to rebuild the pydantic-core schema for the model.

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.

Parameters:

force (bool) – Whether to force the rebuilding of the model schema, defaults to False.
raise_errors (bool) – Whether to raise errors, defaults to True.
_parent_namespace_depth (int) – The depth level of the parent namespace, defaults to 2.
_types_namespace (dict[str, Any] | None) – The types namespace, defaults to None.

Return type:

Returns:

Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.

classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)[source]

Validate a pydantic model instance.

Parameters:

obj (Any) – The object to validate.
strict (bool | None) – Whether to enforce types strictly.
from_attributes (bool | None) – Whether to extract data from object attributes.
context (Any | None) – Additional context to pass to the validator.

Raises:

ValidationError – If the object could not be validated.

Return type:

Self

Returns:

The validated model instance.

classmethod model_validate_json(json_data, *, strict=None, context=None)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing

Validate the given JSON data against the Pydantic model.

Parameters:

json_data (str | bytes | bytearray) – The JSON data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

Raises:

ValidationError – If json_data is not a JSON string or the object could not be validated.

classmethod model_validate_strings(obj, *, strict=None, context=None)[source]

Validate the given object with string data against the Pydantic model.

Parameters:

obj (Any) – The object containing string data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod parse_obj(obj)[source]

Return type:: Self

classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod schema(by_alias=True, ref_template='#/$defs/{model}')[source]

Return type:: Dict[str, Any]

classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)[source]

Return type:: str

type: Literal['entity_get_num_children'][source]

classmethod update_forward_refs(**localns)[source]

Return type:: None

classmethod validate(value)[source]

Return type:: Self

class kittycad.models.ok_modeling_cmd_response.OptionEntityGetParentId(**data)[source][source]

The response to the ‘EntityGetParentId’ endpoint

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__abstractmethods__ = frozenset({})[source]

__annotations__ = {'__class_vars__': 'ClassVar[set[str]]', '__private_attributes__': 'ClassVar[Dict[str, ModelPrivateAttr]]', '__pydantic_complete__': 'ClassVar[bool]', '__pydantic_core_schema__': 'ClassVar[CoreSchema]', '__pydantic_custom_init__': 'ClassVar[bool]', '__pydantic_decorators__': 'ClassVar[_decorators.DecoratorInfos]', '__pydantic_extra__': 'dict[str, Any] | None', '__pydantic_fields_set__': 'set[str]', '__pydantic_generic_metadata__': 'ClassVar[_generics.PydanticGenericMetadata]', '__pydantic_parent_namespace__': 'ClassVar[Dict[str, Any] | None]', '__pydantic_post_init__': "ClassVar[None | Literal['model_post_init']]", '__pydantic_private__': 'dict[str, Any] | None', '__pydantic_root_model__': 'ClassVar[bool]', '__pydantic_serializer__': 'ClassVar[SchemaSerializer]', '__pydantic_validator__': 'ClassVar[SchemaValidator | PluggableSchemaValidator]', '__signature__': 'ClassVar[Signature]', 'data': <class 'kittycad.models.entity_get_parent_id.EntityGetParentId'>, 'model_computed_fields': 'ClassVar[Dict[str, ComputedFieldInfo]]', 'model_config': 'ClassVar[ConfigDict]', 'model_fields': 'ClassVar[Dict[str, FieldInfo]]', 'type': typing.Literal['entity_get_parent_id']}[source]

classmethod __class_getitem__(typevar_values)[source]

Return type:: type[BaseModel] | PydanticRecursiveRef

__class_vars__: ClassVar[set[str]] = {}[source]: The names of the class variables defined on the model.

__copy__()[source]

Returns a shallow copy of the model.

Return type:: Self

__deepcopy__(memo=None)[source]

Returns a deep copy of the model.

Return type:: Self

__delattr__(item)[source]

Implement delattr(self, name).

Return type:: Any

__dict__[source]

__eq__(other)[source]

Return self==value.

Return type:: bool

property __fields_set__: set[str][source]

classmethod __get_pydantic_core_schema__(source, handler, /)[source]

Hook into generating the model’s CoreSchema.

Parameters:

source (type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.
handler (GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.

Return type:

Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]

Returns:

A pydantic-core CoreSchema.

classmethod __get_pydantic_json_schema__(core_schema, handler, /)[source]

Hook into generating the model’s JSON schema.

Parameters:

core_schema (Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({'type': 'nullable', 'schema': current_schema}), or just call the handler with the original schema.
handler (GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.

Return type:

Returns:

A JSON schema, as a Python object.

__getattr__(item)[source]

Return type:: Any

__getstate__()[source]

Helper for pickle.

Return type:: dict[Any, Any]

__hash__ = None[source]

__init__(**data)[source]

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__iter__()[source]

So dict(model) works.

Return type:: Generator[Tuple[str, Any], None, None]

__module__ = 'kittycad.models.ok_modeling_cmd_response'[source]

__pretty__(fmt, **kwargs)[source]

Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.

Return type:: Generator[Any, None, None]

__private_attributes__: ClassVar[Dict[str, ModelPrivateAttr]] = {}[source]: Metadata about the private attributes of the model.

__pydantic_complete__: ClassVar[bool] = True[source]: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__: ClassVar[CoreSchema] = {'cls': <class 'kittycad.models.ok_modeling_cmd_response.OptionEntityGetParentId'>, 'config': {'title': 'OptionEntityGetParentId'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.ok_modeling_cmd_response.OptionEntityGetParentId'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.ok_modeling_cmd_response.OptionEntityGetParentId'>>]}, 'ref': 'kittycad.models.ok_modeling_cmd_response.OptionEntityGetParentId:94667213261536', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'data': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.entity_get_parent_id.EntityGetParentId'>, 'config': {'title': 'EntityGetParentId'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.entity_get_parent_id.EntityGetParentId'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.entity_get_parent_id.EntityGetParentId'>>]}, 'ref': 'kittycad.models.entity_get_parent_id.EntityGetParentId:94667206229456', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'entity_id': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'type': 'str'}, 'type': 'model-field'}}, 'model_name': 'EntityGetParentId', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}, 'type': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': 'entity_get_parent_id', 'schema': {'expected': ['entity_get_parent_id'], 'type': 'literal'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'OptionEntityGetParentId', 'type': 'model-fields'}, 'type': 'model'}[source]: The core schema of the model.

__pydantic_custom_init__: ClassVar[bool] = False[source]: Whether the model has a custom __init__ method.

__pydantic_decorators__: ClassVar[_decorators.DecoratorInfos] = DecoratorInfos(validators={}, field_validators={}, root_validators={}, field_serializers={}, model_serializers={}, model_validators={}, computed_fields={})[source]: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_extra__: dict[str, Any] | None[source]: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to 'allow'.

__pydantic_fields_set__: set[str][source]: The names of fields explicitly set during instantiation.

__pydantic_generic_metadata__: ClassVar[_generics.PydanticGenericMetadata] = {'args': (), 'origin': None, 'parameters': ()}[source]: 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.

classmethod __pydantic_init_subclass__(**kwargs)[source]

This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.

This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.

This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.

Parameters:: **kwargs (Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.
Return type:: None

__pydantic_parent_namespace__: ClassVar[Dict[str, Any] | None] = None[source]: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__: ClassVar[None | Literal['model_post_init']] = None[source]: The name of the post-init method for the model, if defined.

__pydantic_private__: dict[str, Any] | None[source]: Values of private attributes set on the model instance.

__pydantic_root_model__: ClassVar[bool] = False[source]: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__: ClassVar[SchemaSerializer] = SchemaSerializer(serializer=Model( ModelSerializer { class: Py( 0x000056196d9e4ae0, ), serializer: Fields( GeneralFieldsSerializer { fields: { "data": SerField { key_py: Py( 0x00007f9038238fa0, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196d32fdd0, ), serializer: Fields( GeneralFieldsSerializer { fields: { "entity_id": SerField { key_py: Py( 0x00007f9033b11430, ), alias: None, alias_py: None, serializer: Some( Str( StrSerializer, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 1, }, ), has_extra: false, root_model: false, name: "EntityGetParentId", }, ), ), required: true, }, "type": SerField { key_py: Py( 0x00007f903823d958, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f90347d6b30, ), ), serializer: Literal( LiteralSerializer { expected_int: {}, expected_str: { "entity_get_parent_id", }, expected_py: None, name: "literal['entity_get_parent_id']", }, ), }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "OptionEntityGetParentId", }, ), definitions=[])[source]: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__: ClassVar[SchemaValidator | PluggableSchemaValidator] = SchemaValidator(title="OptionEntityGetParentId", validator=Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "data", lookup_key: Simple { key: "data", py_key: Py( 0x00007f9033522f40, ), path: LookupPath( [ S( "data", Py( 0x00007f9033522f70, ), ), ], ), }, name_py: Py( 0x00007f9038238fa0, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "entity_id", lookup_key: Simple { key: "entity_id", py_key: Py( 0x00007f90334bc330, ), path: LookupPath( [ S( "entity_id", Py( 0x00007f9033349ff0, ), ), ], ), }, name_py: Py( 0x00007f9033b11430, ), validator: Str( StrValidator { strict: false, coerce_numbers_to_str: false, }, ), frozen: false, }, ], model_name: "EntityGetParentId", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d32fdd0, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "EntityGetParentId", }, ), frozen: false, }, Field { name: "type", lookup_key: Simple { key: "type", py_key: Py( 0x00007f9033522fa0, ), path: LookupPath( [ S( "type", Py( 0x00007f9033522fd0, ), ), ], ), }, name_py: Py( 0x00007f903823d958, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f90347d6b30, ), ), on_error: Raise, validator: Literal( LiteralValidator { lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "entity_get_parent_id": 0, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f90347d6b30, ), ], }, expected_repr: "'entity_get_parent_id'", name: "literal['entity_get_parent_id']", }, ), validate_default: false, copy_default: false, name: "default[literal['entity_get_parent_id']]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "OptionEntityGetParentId", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d9e4ae0, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "OptionEntityGetParentId", }, ), definitions=[], cache_strings=True)[source]: The pydantic-core SchemaValidator used to validate instances of the model.

__repr__()[source]

Return repr(self).

Return type:: str

__repr_args__()[source]

Return type:: Iterable[tuple[str | None, Any]]

__repr_name__()[source]

Name of the instance’s class, used in __repr__.

Return type:: str

__repr_str__(join_str)[source]

Return type:: str

__rich_repr__()[source]

Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.

Return type:: Iterable[Any | tuple[Any] | tuple[str, Any] | tuple[str, Any, Any]]

__setattr__(name, value)[source]

Implement setattr(self, name, value).

Return type:: None

__setstate__(state)[source]

Return type:: None

__signature__: ClassVar[Signature] = <Signature (*, data: kittycad.models.entity_get_parent_id.EntityGetParentId, type: Literal['entity_get_parent_id'] = 'entity_get_parent_id') -> None>[source]: The synthesized __init__ [Signature][inspect.Signature] of the model.

__slots__ = ('__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__')[source]

__str__()[source]

Return str(self).

Return type:: str

_abc_impl = <_abc._abc_data object>[source]

_calculate_keys(*args, **kwargs)[source]

Return type:: Any

_check_frozen(name, value)[source]

Return type:: None

_copy_and_set_values(*args, **kwargs)[source]

Return type:: Any

classmethod _get_value(*args, **kwargs)[source]

Return type:: Any

_iter(*args, **kwargs)[source]

Return type:: Any

classmethod construct(_fields_set=None, **values)[source]

Return type:: Self

copy(*, include=None, exclude=None, update=None, deep=False)[source]

Returns a copy of the model.

!!! warning “Deprecated”: This method is now deprecated; use model_copy instead.

If you need include or exclude, use:

`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `

Parameters:

include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.

Returns:

A copy of the model with included, excluded and updated fields as specified.

data: EntityGetParentId[source]

dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)[source]

Return type:: Dict[str, Any]

classmethod from_orm(obj)[source]

Return type:: Self

json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)[source]

Return type:: str

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}[source]: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'protected_namespaces': ()}[source]: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod model_construct(_fields_set=None, **values)[source]

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note: model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == 'allow', then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == 'ignore' (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == 'forbid' does not result in an error if extra values are passed, but they will be ignored.

Parameters:

_fields_set (set[str] | None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.
values (Any) – Trusted or pre-validated data dictionary.

Return type:

Self

Returns:

A new instance of the Model class with validated data.

model_copy(*, update=None, deep=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy

Returns a copy of the model.

Parameters:

update (dict[str, Any] | None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.
deep (bool) – Set to True to make a deep copy of the model.

Return type:

Self

Returns:

New model instance.

model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters:

mode (Union[Literal['json', 'python'], str]) – The mode in which to_python 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.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to include in the output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to exclude from the output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to use the field’s alias in the dictionary key if defined.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A dictionary representation of the model.

model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

Generates a JSON representation of the model using Pydantic’s to_json method.

Parameters:

indent (int | None) – Indentation to use in the JSON output. If None is passed, the output will be compact.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to include in the JSON output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to exclude from the JSON output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to serialize using field aliases.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A JSON string representation of the model.

property model_extra: dict[str, Any] | None[source]

Get extra fields set during validation.

Returns:: A dictionary of extra fields, or None if config.extra is not set to "allow".

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=EntityGetParentId, required=True), 'type': FieldInfo(annotation=Literal['entity_get_parent_id'], required=False, default='entity_get_parent_id')}[source]

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

property model_fields_set: set[str][source]

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,: i.e. that were not filled from defaults.

classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')[source]

Generates a JSON schema for a model class.

Parameters:

by_alias (bool) – Whether to use attribute aliases or not.
ref_template (str) – The reference template.
schema_generator (type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modifications
mode (Literal['validation', 'serialization']) – The mode in which to generate the schema.

Return type:

Returns:

The JSON schema for the given model class.

classmethod model_parametrized_name(params)[source]

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

Parameters:: params (tuple[type[Any], ...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.
Return type:: str
Returns:: String representing the new class where params are passed to cls as type variables.
Raises:: TypeError – Raised when trying to generate concrete names for non-generic models.

model_post_init(_BaseModel__context)[source]

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

Return type:: None

classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)[source]

Try to rebuild the pydantic-core schema for the model.

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.

Parameters:

force (bool) – Whether to force the rebuilding of the model schema, defaults to False.
raise_errors (bool) – Whether to raise errors, defaults to True.
_parent_namespace_depth (int) – The depth level of the parent namespace, defaults to 2.
_types_namespace (dict[str, Any] | None) – The types namespace, defaults to None.

Return type:

Returns:

Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.

classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)[source]

Validate a pydantic model instance.

Parameters:

obj (Any) – The object to validate.
strict (bool | None) – Whether to enforce types strictly.
from_attributes (bool | None) – Whether to extract data from object attributes.
context (Any | None) – Additional context to pass to the validator.

Raises:

ValidationError – If the object could not be validated.

Return type:

Self

Returns:

The validated model instance.

classmethod model_validate_json(json_data, *, strict=None, context=None)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing

Validate the given JSON data against the Pydantic model.

Parameters:

json_data (str | bytes | bytearray) – The JSON data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

Raises:

ValidationError – If json_data is not a JSON string or the object could not be validated.

classmethod model_validate_strings(obj, *, strict=None, context=None)[source]

Validate the given object with string data against the Pydantic model.

Parameters:

obj (Any) – The object containing string data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod parse_obj(obj)[source]

Return type:: Self

classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod schema(by_alias=True, ref_template='#/$defs/{model}')[source]

Return type:: Dict[str, Any]

classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)[source]

Return type:: str

type: Literal['entity_get_parent_id'][source]

classmethod update_forward_refs(**localns)[source]

Return type:: None

classmethod validate(value)[source]

Return type:: Self

class kittycad.models.ok_modeling_cmd_response.OptionEntityGetSketchPaths(**data)[source][source]

The response to the ‘EntityGetSketchPaths’ endpoint

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__abstractmethods__ = frozenset({})[source]

__annotations__ = {'__class_vars__': 'ClassVar[set[str]]', '__private_attributes__': 'ClassVar[Dict[str, ModelPrivateAttr]]', '__pydantic_complete__': 'ClassVar[bool]', '__pydantic_core_schema__': 'ClassVar[CoreSchema]', '__pydantic_custom_init__': 'ClassVar[bool]', '__pydantic_decorators__': 'ClassVar[_decorators.DecoratorInfos]', '__pydantic_extra__': 'dict[str, Any] | None', '__pydantic_fields_set__': 'set[str]', '__pydantic_generic_metadata__': 'ClassVar[_generics.PydanticGenericMetadata]', '__pydantic_parent_namespace__': 'ClassVar[Dict[str, Any] | None]', '__pydantic_post_init__': "ClassVar[None | Literal['model_post_init']]", '__pydantic_private__': 'dict[str, Any] | None', '__pydantic_root_model__': 'ClassVar[bool]', '__pydantic_serializer__': 'ClassVar[SchemaSerializer]', '__pydantic_validator__': 'ClassVar[SchemaValidator | PluggableSchemaValidator]', '__signature__': 'ClassVar[Signature]', 'data': <class 'kittycad.models.entity_get_sketch_paths.EntityGetSketchPaths'>, 'model_computed_fields': 'ClassVar[Dict[str, ComputedFieldInfo]]', 'model_config': 'ClassVar[ConfigDict]', 'model_fields': 'ClassVar[Dict[str, FieldInfo]]', 'type': typing.Literal['entity_get_sketch_paths']}[source]

classmethod __class_getitem__(typevar_values)[source]

Return type:: type[BaseModel] | PydanticRecursiveRef

__class_vars__: ClassVar[set[str]] = {}[source]: The names of the class variables defined on the model.

__copy__()[source]

Returns a shallow copy of the model.

Return type:: Self

__deepcopy__(memo=None)[source]

Returns a deep copy of the model.

Return type:: Self

__delattr__(item)[source]

Implement delattr(self, name).

Return type:: Any

__dict__[source]

__eq__(other)[source]

Return self==value.

Return type:: bool

property __fields_set__: set[str][source]

classmethod __get_pydantic_core_schema__(source, handler, /)[source]

Hook into generating the model’s CoreSchema.

Parameters:

source (type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.
handler (GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.

Return type:

Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]

Returns:

A pydantic-core CoreSchema.

classmethod __get_pydantic_json_schema__(core_schema, handler, /)[source]

Hook into generating the model’s JSON schema.

Parameters:

core_schema (Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({'type': 'nullable', 'schema': current_schema}), or just call the handler with the original schema.
handler (GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.

Return type:

Returns:

A JSON schema, as a Python object.

__getattr__(item)[source]

Return type:: Any

__getstate__()[source]

Helper for pickle.

Return type:: dict[Any, Any]

__hash__ = None[source]

__init__(**data)[source]

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__iter__()[source]

So dict(model) works.

Return type:: Generator[Tuple[str, Any], None, None]

__module__ = 'kittycad.models.ok_modeling_cmd_response'[source]

__pretty__(fmt, **kwargs)[source]

Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.

Return type:: Generator[Any, None, None]

__private_attributes__: ClassVar[Dict[str, ModelPrivateAttr]] = {}[source]: Metadata about the private attributes of the model.

__pydantic_complete__: ClassVar[bool] = True[source]: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__: ClassVar[CoreSchema] = {'cls': <class 'kittycad.models.ok_modeling_cmd_response.OptionEntityGetSketchPaths'>, 'config': {'title': 'OptionEntityGetSketchPaths'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.ok_modeling_cmd_response.OptionEntityGetSketchPaths'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.ok_modeling_cmd_response.OptionEntityGetSketchPaths'>>]}, 'ref': 'kittycad.models.ok_modeling_cmd_response.OptionEntityGetSketchPaths:94667213293792', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'data': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.entity_get_sketch_paths.EntityGetSketchPaths'>, 'config': {'title': 'EntityGetSketchPaths'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.entity_get_sketch_paths.EntityGetSketchPaths'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.entity_get_sketch_paths.EntityGetSketchPaths'>>]}, 'ref': 'kittycad.models.entity_get_sketch_paths.EntityGetSketchPaths:94667206232640', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'entity_ids': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'items_schema': {'type': 'str'}, 'type': 'list'}, 'type': 'model-field'}}, 'model_name': 'EntityGetSketchPaths', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}, 'type': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': 'entity_get_sketch_paths', 'schema': {'expected': ['entity_get_sketch_paths'], 'type': 'literal'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'OptionEntityGetSketchPaths', 'type': 'model-fields'}, 'type': 'model'}[source]: The core schema of the model.

__pydantic_custom_init__: ClassVar[bool] = False[source]: Whether the model has a custom __init__ method.

__pydantic_decorators__: ClassVar[_decorators.DecoratorInfos] = DecoratorInfos(validators={}, field_validators={}, root_validators={}, field_serializers={}, model_serializers={}, model_validators={}, computed_fields={})[source]: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_extra__: dict[str, Any] | None[source]: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to 'allow'.

__pydantic_fields_set__: set[str][source]: The names of fields explicitly set during instantiation.

__pydantic_generic_metadata__: ClassVar[_generics.PydanticGenericMetadata] = {'args': (), 'origin': None, 'parameters': ()}[source]: 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.

classmethod __pydantic_init_subclass__(**kwargs)[source]

This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.

This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.

This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.

Parameters:: **kwargs (Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.
Return type:: None

__pydantic_parent_namespace__: ClassVar[Dict[str, Any] | None] = None[source]: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__: ClassVar[None | Literal['model_post_init']] = None[source]: The name of the post-init method for the model, if defined.

__pydantic_private__: dict[str, Any] | None[source]: Values of private attributes set on the model instance.

__pydantic_root_model__: ClassVar[bool] = False[source]: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__: ClassVar[SchemaSerializer] = SchemaSerializer(serializer=Model( ModelSerializer { class: Py( 0x000056196d9ec8e0, ), serializer: Fields( GeneralFieldsSerializer { fields: { "data": SerField { key_py: Py( 0x00007f9038238fa0, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196d330a40, ), serializer: Fields( GeneralFieldsSerializer { fields: { "entity_ids": SerField { key_py: Py( 0x00007f9033b07170, ), alias: None, alias_py: None, serializer: Some( List( ListSerializer { item_serializer: Str( StrSerializer, ), filter: SchemaFilter { include: None, exclude: None, }, name: "list[str]", }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 1, }, ), has_extra: false, root_model: false, name: "EntityGetSketchPaths", }, ), ), required: true, }, "type": SerField { key_py: Py( 0x00007f903823d958, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f90347d6c30, ), ), serializer: Literal( LiteralSerializer { expected_int: {}, expected_str: { "entity_get_sketch_paths", }, expected_py: None, name: "literal['entity_get_sketch_paths']", }, ), }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "OptionEntityGetSketchPaths", }, ), definitions=[])[source]: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__: ClassVar[SchemaValidator | PluggableSchemaValidator] = SchemaValidator(title="OptionEntityGetSketchPaths", validator=Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "data", lookup_key: Simple { key: "data", py_key: Py( 0x00007f9033522610, ), path: LookupPath( [ S( "data", Py( 0x00007f9033522760, ), ), ], ), }, name_py: Py( 0x00007f9038238fa0, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "entity_ids", lookup_key: Simple { key: "entity_ids", py_key: Py( 0x00007f9033349a30, ), path: LookupPath( [ S( "entity_ids", Py( 0x00007f9033349930, ), ), ], ), }, name_py: Py( 0x00007f9033b07170, ), validator: List( ListValidator { strict: false, item_validator: Some( Str( StrValidator { strict: false, coerce_numbers_to_str: false, }, ), ), min_length: None, max_length: None, name: OnceLock( <uninit>, ), fail_fast: false, }, ), frozen: false, }, ], model_name: "EntityGetSketchPaths", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d330a40, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "EntityGetSketchPaths", }, ), frozen: false, }, Field { name: "type", lookup_key: Simple { key: "type", py_key: Py( 0x00007f9033522730, ), path: LookupPath( [ S( "type", Py( 0x00007f90335226d0, ), ), ], ), }, name_py: Py( 0x00007f903823d958, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f90347d6c30, ), ), on_error: Raise, validator: Literal( LiteralValidator { lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "entity_get_sketch_paths": 0, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f90347d6c30, ), ], }, expected_repr: "'entity_get_sketch_paths'", name: "literal['entity_get_sketch_paths']", }, ), validate_default: false, copy_default: false, name: "default[literal['entity_get_sketch_paths']]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "OptionEntityGetSketchPaths", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d9ec8e0, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "OptionEntityGetSketchPaths", }, ), definitions=[], cache_strings=True)[source]: The pydantic-core SchemaValidator used to validate instances of the model.

__repr__()[source]

Return repr(self).

Return type:: str

__repr_args__()[source]

Return type:: Iterable[tuple[str | None, Any]]

__repr_name__()[source]

Name of the instance’s class, used in __repr__.

Return type:: str

__repr_str__(join_str)[source]

Return type:: str

__rich_repr__()[source]

Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.

Return type:: Iterable[Any | tuple[Any] | tuple[str, Any] | tuple[str, Any, Any]]

__setattr__(name, value)[source]

Implement setattr(self, name, value).

Return type:: None

__setstate__(state)[source]

Return type:: None

__signature__: ClassVar[Signature] = <Signature (*, data: kittycad.models.entity_get_sketch_paths.EntityGetSketchPaths, type: Literal['entity_get_sketch_paths'] = 'entity_get_sketch_paths') -> None>[source]: The synthesized __init__ [Signature][inspect.Signature] of the model.

__slots__ = ('__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__')[source]

__str__()[source]

Return str(self).

Return type:: str

_abc_impl = <_abc._abc_data object>[source]

_calculate_keys(*args, **kwargs)[source]

Return type:: Any

_check_frozen(name, value)[source]

Return type:: None

_copy_and_set_values(*args, **kwargs)[source]

Return type:: Any

classmethod _get_value(*args, **kwargs)[source]

Return type:: Any

_iter(*args, **kwargs)[source]

Return type:: Any

classmethod construct(_fields_set=None, **values)[source]

Return type:: Self

copy(*, include=None, exclude=None, update=None, deep=False)[source]

Returns a copy of the model.

!!! warning “Deprecated”: This method is now deprecated; use model_copy instead.

If you need include or exclude, use:

`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `

Parameters:

include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.

Returns:

A copy of the model with included, excluded and updated fields as specified.

data: EntityGetSketchPaths[source]

dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)[source]

Return type:: Dict[str, Any]

classmethod from_orm(obj)[source]

Return type:: Self

json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)[source]

Return type:: str

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}[source]: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'protected_namespaces': ()}[source]: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod model_construct(_fields_set=None, **values)[source]

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note: model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == 'allow', then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == 'ignore' (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == 'forbid' does not result in an error if extra values are passed, but they will be ignored.

Parameters:

_fields_set (set[str] | None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.
values (Any) – Trusted or pre-validated data dictionary.

Return type:

Self

Returns:

A new instance of the Model class with validated data.

model_copy(*, update=None, deep=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy

Returns a copy of the model.

Parameters:

update (dict[str, Any] | None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.
deep (bool) – Set to True to make a deep copy of the model.

Return type:

Self

Returns:

New model instance.

model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters:

mode (Union[Literal['json', 'python'], str]) – The mode in which to_python 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.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to include in the output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to exclude from the output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to use the field’s alias in the dictionary key if defined.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A dictionary representation of the model.

model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

Generates a JSON representation of the model using Pydantic’s to_json method.

Parameters:

indent (int | None) – Indentation to use in the JSON output. If None is passed, the output will be compact.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to include in the JSON output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to exclude from the JSON output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to serialize using field aliases.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A JSON string representation of the model.

property model_extra: dict[str, Any] | None[source]

Get extra fields set during validation.

Returns:: A dictionary of extra fields, or None if config.extra is not set to "allow".

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=EntityGetSketchPaths, required=True), 'type': FieldInfo(annotation=Literal['entity_get_sketch_paths'], required=False, default='entity_get_sketch_paths')}[source]

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

property model_fields_set: set[str][source]

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,: i.e. that were not filled from defaults.

classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')[source]

Generates a JSON schema for a model class.

Parameters:

by_alias (bool) – Whether to use attribute aliases or not.
ref_template (str) – The reference template.
schema_generator (type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modifications
mode (Literal['validation', 'serialization']) – The mode in which to generate the schema.

Return type:

Returns:

The JSON schema for the given model class.

classmethod model_parametrized_name(params)[source]

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

Parameters:: params (tuple[type[Any], ...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.
Return type:: str
Returns:: String representing the new class where params are passed to cls as type variables.
Raises:: TypeError – Raised when trying to generate concrete names for non-generic models.

model_post_init(_BaseModel__context)[source]

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

Return type:: None

classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)[source]

Try to rebuild the pydantic-core schema for the model.

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.

Parameters:

force (bool) – Whether to force the rebuilding of the model schema, defaults to False.
raise_errors (bool) – Whether to raise errors, defaults to True.
_parent_namespace_depth (int) – The depth level of the parent namespace, defaults to 2.
_types_namespace (dict[str, Any] | None) – The types namespace, defaults to None.

Return type:

Returns:

Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.

classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)[source]

Validate a pydantic model instance.

Parameters:

obj (Any) – The object to validate.
strict (bool | None) – Whether to enforce types strictly.
from_attributes (bool | None) – Whether to extract data from object attributes.
context (Any | None) – Additional context to pass to the validator.

Raises:

ValidationError – If the object could not be validated.

Return type:

Self

Returns:

The validated model instance.

classmethod model_validate_json(json_data, *, strict=None, context=None)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing

Validate the given JSON data against the Pydantic model.

Parameters:

json_data (str | bytes | bytearray) – The JSON data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

Raises:

ValidationError – If json_data is not a JSON string or the object could not be validated.

classmethod model_validate_strings(obj, *, strict=None, context=None)[source]

Validate the given object with string data against the Pydantic model.

Parameters:

obj (Any) – The object containing string data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod parse_obj(obj)[source]

Return type:: Self

classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod schema(by_alias=True, ref_template='#/$defs/{model}')[source]

Return type:: Dict[str, Any]

classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)[source]

Return type:: str

type: Literal['entity_get_sketch_paths'][source]

classmethod update_forward_refs(**localns)[source]

Return type:: None

classmethod validate(value)[source]

Return type:: Self

class kittycad.models.ok_modeling_cmd_response.OptionEntityLinearPattern(**data)[source][source]

The response to the ‘EntityLinearPattern’ endpoint

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__abstractmethods__ = frozenset({})[source]

__annotations__ = {'__class_vars__': 'ClassVar[set[str]]', '__private_attributes__': 'ClassVar[Dict[str, ModelPrivateAttr]]', '__pydantic_complete__': 'ClassVar[bool]', '__pydantic_core_schema__': 'ClassVar[CoreSchema]', '__pydantic_custom_init__': 'ClassVar[bool]', '__pydantic_decorators__': 'ClassVar[_decorators.DecoratorInfos]', '__pydantic_extra__': 'dict[str, Any] | None', '__pydantic_fields_set__': 'set[str]', '__pydantic_generic_metadata__': 'ClassVar[_generics.PydanticGenericMetadata]', '__pydantic_parent_namespace__': 'ClassVar[Dict[str, Any] | None]', '__pydantic_post_init__': "ClassVar[None | Literal['model_post_init']]", '__pydantic_private__': 'dict[str, Any] | None', '__pydantic_root_model__': 'ClassVar[bool]', '__pydantic_serializer__': 'ClassVar[SchemaSerializer]', '__pydantic_validator__': 'ClassVar[SchemaValidator | PluggableSchemaValidator]', '__signature__': 'ClassVar[Signature]', 'data': <class 'kittycad.models.entity_linear_pattern.EntityLinearPattern'>, 'model_computed_fields': 'ClassVar[Dict[str, ComputedFieldInfo]]', 'model_config': 'ClassVar[ConfigDict]', 'model_fields': 'ClassVar[Dict[str, FieldInfo]]', 'type': typing.Literal['entity_linear_pattern']}[source]

classmethod __class_getitem__(typevar_values)[source]

Return type:: type[BaseModel] | PydanticRecursiveRef

__class_vars__: ClassVar[set[str]] = {}[source]: The names of the class variables defined on the model.

__copy__()[source]

Returns a shallow copy of the model.

Return type:: Self

__deepcopy__(memo=None)[source]

Returns a deep copy of the model.

Return type:: Self

__delattr__(item)[source]

Implement delattr(self, name).

Return type:: Any

__dict__[source]

__eq__(other)[source]

Return self==value.

Return type:: bool

property __fields_set__: set[str][source]

classmethod __get_pydantic_core_schema__(source, handler, /)[source]

Hook into generating the model’s CoreSchema.

Parameters:

source (type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.
handler (GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.

Return type:

Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]

Returns:

A pydantic-core CoreSchema.

classmethod __get_pydantic_json_schema__(core_schema, handler, /)[source]

Hook into generating the model’s JSON schema.

Parameters:

core_schema (Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({'type': 'nullable', 'schema': current_schema}), or just call the handler with the original schema.
handler (GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.

Return type:

Returns:

A JSON schema, as a Python object.

__getattr__(item)[source]

Return type:: Any

__getstate__()[source]

Helper for pickle.

Return type:: dict[Any, Any]

__hash__ = None[source]

__init__(**data)[source]

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__iter__()[source]

So dict(model) works.

Return type:: Generator[Tuple[str, Any], None, None]

__module__ = 'kittycad.models.ok_modeling_cmd_response'[source]

__pretty__(fmt, **kwargs)[source]

Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.

Return type:: Generator[Any, None, None]

__private_attributes__: ClassVar[Dict[str, ModelPrivateAttr]] = {}[source]: Metadata about the private attributes of the model.

__pydantic_complete__: ClassVar[bool] = True[source]: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__: ClassVar[CoreSchema] = {'cls': <class 'kittycad.models.ok_modeling_cmd_response.OptionEntityLinearPattern'>, 'config': {'title': 'OptionEntityLinearPattern'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.ok_modeling_cmd_response.OptionEntityLinearPattern'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.ok_modeling_cmd_response.OptionEntityLinearPattern'>>]}, 'ref': 'kittycad.models.ok_modeling_cmd_response.OptionEntityLinearPattern:94667214065296', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'data': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.entity_linear_pattern.EntityLinearPattern'>, 'config': {'title': 'EntityLinearPattern'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.entity_linear_pattern.EntityLinearPattern'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.entity_linear_pattern.EntityLinearPattern'>>]}, 'ref': 'kittycad.models.entity_linear_pattern.EntityLinearPattern:94667206244720', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'entity_ids': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'items_schema': {'type': 'str'}, 'type': 'list'}, 'type': 'model-field'}}, 'model_name': 'EntityLinearPattern', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}, 'type': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': 'entity_linear_pattern', 'schema': {'expected': ['entity_linear_pattern'], 'type': 'literal'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'OptionEntityLinearPattern', 'type': 'model-fields'}, 'type': 'model'}[source]: The core schema of the model.

__pydantic_custom_init__: ClassVar[bool] = False[source]: Whether the model has a custom __init__ method.

__pydantic_decorators__: ClassVar[_decorators.DecoratorInfos] = DecoratorInfos(validators={}, field_validators={}, root_validators={}, field_serializers={}, model_serializers={}, model_validators={}, computed_fields={})[source]: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_extra__: dict[str, Any] | None[source]: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to 'allow'.

__pydantic_fields_set__: set[str][source]: The names of fields explicitly set during instantiation.

__pydantic_generic_metadata__: ClassVar[_generics.PydanticGenericMetadata] = {'args': (), 'origin': None, 'parameters': ()}[source]: 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.

classmethod __pydantic_init_subclass__(**kwargs)[source]

This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.

This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.

This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.

Parameters:: **kwargs (Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.
Return type:: None

__pydantic_parent_namespace__: ClassVar[Dict[str, Any] | None] = None[source]: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__: ClassVar[None | Literal['model_post_init']] = None[source]: The name of the post-init method for the model, if defined.

__pydantic_private__: dict[str, Any] | None[source]: Values of private attributes set on the model instance.

__pydantic_root_model__: ClassVar[bool] = False[source]: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__: ClassVar[SchemaSerializer] = SchemaSerializer(serializer=Model( ModelSerializer { class: Py( 0x000056196daa8e90, ), serializer: Fields( GeneralFieldsSerializer { fields: { "data": SerField { key_py: Py( 0x00007f9038238fa0, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196d333970, ), serializer: Fields( GeneralFieldsSerializer { fields: { "entity_ids": SerField { key_py: Py( 0x00007f9033b07170, ), alias: None, alias_py: None, serializer: Some( List( ListSerializer { item_serializer: Str( StrSerializer, ), filter: SchemaFilter { include: None, exclude: None, }, name: "list[str]", }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 1, }, ), has_extra: false, root_model: false, name: "EntityLinearPattern", }, ), ), required: true, }, "type": SerField { key_py: Py( 0x00007f903823d958, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f90347d6db0, ), ), serializer: Literal( LiteralSerializer { expected_int: {}, expected_str: { "entity_linear_pattern", }, expected_py: None, name: "literal['entity_linear_pattern']", }, ), }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "OptionEntityLinearPattern", }, ), definitions=[])[source]: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__: ClassVar[SchemaValidator | PluggableSchemaValidator] = SchemaValidator(title="OptionEntityLinearPattern", validator=Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "data", lookup_key: Simple { key: "data", py_key: Py( 0x00007f90333ab750, ), path: LookupPath( [ S( "data", Py( 0x00007f90333ab810, ), ), ], ), }, name_py: Py( 0x00007f9038238fa0, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "entity_ids", lookup_key: Simple { key: "entity_ids", py_key: Py( 0x00007f90333e1630, ), path: LookupPath( [ S( "entity_ids", Py( 0x00007f90333e15f0, ), ), ], ), }, name_py: Py( 0x00007f9033b07170, ), validator: List( ListValidator { strict: false, item_validator: Some( Str( StrValidator { strict: false, coerce_numbers_to_str: false, }, ), ), min_length: None, max_length: None, name: OnceLock( <uninit>, ), fail_fast: false, }, ), frozen: false, }, ], model_name: "EntityLinearPattern", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d333970, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "EntityLinearPattern", }, ), frozen: false, }, Field { name: "type", lookup_key: Simple { key: "type", py_key: Py( 0x00007f90333ab840, ), path: LookupPath( [ S( "type", Py( 0x00007f90333ab870, ), ), ], ), }, name_py: Py( 0x00007f903823d958, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f90347d6db0, ), ), on_error: Raise, validator: Literal( LiteralValidator { lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "entity_linear_pattern": 0, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f90347d6db0, ), ], }, expected_repr: "'entity_linear_pattern'", name: "literal['entity_linear_pattern']", }, ), validate_default: false, copy_default: false, name: "default[literal['entity_linear_pattern']]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "OptionEntityLinearPattern", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196daa8e90, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "OptionEntityLinearPattern", }, ), definitions=[], cache_strings=True)[source]: The pydantic-core SchemaValidator used to validate instances of the model.

__repr__()[source]

Return repr(self).

Return type:: str

__repr_args__()[source]

Return type:: Iterable[tuple[str | None, Any]]

__repr_name__()[source]

Name of the instance’s class, used in __repr__.

Return type:: str

__repr_str__(join_str)[source]

Return type:: str

__rich_repr__()[source]

Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.

Return type:: Iterable[Any | tuple[Any] | tuple[str, Any] | tuple[str, Any, Any]]

__setattr__(name, value)[source]

Implement setattr(self, name, value).

Return type:: None

__setstate__(state)[source]

Return type:: None

__signature__: ClassVar[Signature] = <Signature (*, data: kittycad.models.entity_linear_pattern.EntityLinearPattern, type: Literal['entity_linear_pattern'] = 'entity_linear_pattern') -> None>[source]: The synthesized __init__ [Signature][inspect.Signature] of the model.

__slots__ = ('__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__')[source]

__str__()[source]

Return str(self).

Return type:: str

_abc_impl = <_abc._abc_data object>[source]

_calculate_keys(*args, **kwargs)[source]

Return type:: Any

_check_frozen(name, value)[source]

Return type:: None

_copy_and_set_values(*args, **kwargs)[source]

Return type:: Any

classmethod _get_value(*args, **kwargs)[source]

Return type:: Any

_iter(*args, **kwargs)[source]

Return type:: Any

classmethod construct(_fields_set=None, **values)[source]

Return type:: Self

copy(*, include=None, exclude=None, update=None, deep=False)[source]

Returns a copy of the model.

!!! warning “Deprecated”: This method is now deprecated; use model_copy instead.

If you need include or exclude, use:

`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `

Parameters:

include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.

Returns:

A copy of the model with included, excluded and updated fields as specified.

data: EntityLinearPattern[source]

dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)[source]

Return type:: Dict[str, Any]

classmethod from_orm(obj)[source]

Return type:: Self

json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)[source]

Return type:: str

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}[source]: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'protected_namespaces': ()}[source]: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod model_construct(_fields_set=None, **values)[source]

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note: model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == 'allow', then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == 'ignore' (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == 'forbid' does not result in an error if extra values are passed, but they will be ignored.

Parameters:

_fields_set (set[str] | None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.
values (Any) – Trusted or pre-validated data dictionary.

Return type:

Self

Returns:

A new instance of the Model class with validated data.

model_copy(*, update=None, deep=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy

Returns a copy of the model.

Parameters:

update (dict[str, Any] | None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.
deep (bool) – Set to True to make a deep copy of the model.

Return type:

Self

Returns:

New model instance.

model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters:

mode (Union[Literal['json', 'python'], str]) – The mode in which to_python 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.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to include in the output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to exclude from the output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to use the field’s alias in the dictionary key if defined.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A dictionary representation of the model.

model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

Generates a JSON representation of the model using Pydantic’s to_json method.

Parameters:

indent (int | None) – Indentation to use in the JSON output. If None is passed, the output will be compact.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to include in the JSON output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to exclude from the JSON output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to serialize using field aliases.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A JSON string representation of the model.

property model_extra: dict[str, Any] | None[source]

Get extra fields set during validation.

Returns:: A dictionary of extra fields, or None if config.extra is not set to "allow".

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=EntityLinearPattern, required=True), 'type': FieldInfo(annotation=Literal['entity_linear_pattern'], required=False, default='entity_linear_pattern')}[source]

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

property model_fields_set: set[str][source]

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,: i.e. that were not filled from defaults.

classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')[source]

Generates a JSON schema for a model class.

Parameters:

by_alias (bool) – Whether to use attribute aliases or not.
ref_template (str) – The reference template.
schema_generator (type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modifications
mode (Literal['validation', 'serialization']) – The mode in which to generate the schema.

Return type:

Returns:

The JSON schema for the given model class.

classmethod model_parametrized_name(params)[source]

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

Parameters:: params (tuple[type[Any], ...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.
Return type:: str
Returns:: String representing the new class where params are passed to cls as type variables.
Raises:: TypeError – Raised when trying to generate concrete names for non-generic models.

model_post_init(_BaseModel__context)[source]

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

Return type:: None

classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)[source]

Try to rebuild the pydantic-core schema for the model.

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.

Parameters:

force (bool) – Whether to force the rebuilding of the model schema, defaults to False.
raise_errors (bool) – Whether to raise errors, defaults to True.
_parent_namespace_depth (int) – The depth level of the parent namespace, defaults to 2.
_types_namespace (dict[str, Any] | None) – The types namespace, defaults to None.

Return type:

Returns:

Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.

classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)[source]

Validate a pydantic model instance.

Parameters:

obj (Any) – The object to validate.
strict (bool | None) – Whether to enforce types strictly.
from_attributes (bool | None) – Whether to extract data from object attributes.
context (Any | None) – Additional context to pass to the validator.

Raises:

ValidationError – If the object could not be validated.

Return type:

Self

Returns:

The validated model instance.

classmethod model_validate_json(json_data, *, strict=None, context=None)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing

Validate the given JSON data against the Pydantic model.

Parameters:

json_data (str | bytes | bytearray) – The JSON data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

Raises:

ValidationError – If json_data is not a JSON string or the object could not be validated.

classmethod model_validate_strings(obj, *, strict=None, context=None)[source]

Validate the given object with string data against the Pydantic model.

Parameters:

obj (Any) – The object containing string data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod parse_obj(obj)[source]

Return type:: Self

classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod schema(by_alias=True, ref_template='#/$defs/{model}')[source]

Return type:: Dict[str, Any]

classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)[source]

Return type:: str

type: Literal['entity_linear_pattern'][source]

classmethod update_forward_refs(**localns)[source]

Return type:: None

classmethod validate(value)[source]

Return type:: Self

class kittycad.models.ok_modeling_cmd_response.OptionEntityLinearPatternTransform(**data)[source][source]

The response to the ‘EntityLinearPatternTransform’ endpoint

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__abstractmethods__ = frozenset({})[source]

__annotations__ = {'__class_vars__': 'ClassVar[set[str]]', '__private_attributes__': 'ClassVar[Dict[str, ModelPrivateAttr]]', '__pydantic_complete__': 'ClassVar[bool]', '__pydantic_core_schema__': 'ClassVar[CoreSchema]', '__pydantic_custom_init__': 'ClassVar[bool]', '__pydantic_decorators__': 'ClassVar[_decorators.DecoratorInfos]', '__pydantic_extra__': 'dict[str, Any] | None', '__pydantic_fields_set__': 'set[str]', '__pydantic_generic_metadata__': 'ClassVar[_generics.PydanticGenericMetadata]', '__pydantic_parent_namespace__': 'ClassVar[Dict[str, Any] | None]', '__pydantic_post_init__': "ClassVar[None | Literal['model_post_init']]", '__pydantic_private__': 'dict[str, Any] | None', '__pydantic_root_model__': 'ClassVar[bool]', '__pydantic_serializer__': 'ClassVar[SchemaSerializer]', '__pydantic_validator__': 'ClassVar[SchemaValidator | PluggableSchemaValidator]', '__signature__': 'ClassVar[Signature]', 'data': <class 'kittycad.models.entity_linear_pattern_transform.EntityLinearPatternTransform'>, 'model_computed_fields': 'ClassVar[Dict[str, ComputedFieldInfo]]', 'model_config': 'ClassVar[ConfigDict]', 'model_fields': 'ClassVar[Dict[str, FieldInfo]]', 'type': typing.Literal['entity_linear_pattern_transform']}[source]

classmethod __class_getitem__(typevar_values)[source]

Return type:: type[BaseModel] | PydanticRecursiveRef

__class_vars__: ClassVar[set[str]] = {}[source]: The names of the class variables defined on the model.

__copy__()[source]

Returns a shallow copy of the model.

Return type:: Self

__deepcopy__(memo=None)[source]

Returns a deep copy of the model.

Return type:: Self

__delattr__(item)[source]

Implement delattr(self, name).

Return type:: Any

__dict__[source]

__eq__(other)[source]

Return self==value.

Return type:: bool

property __fields_set__: set[str][source]

classmethod __get_pydantic_core_schema__(source, handler, /)[source]

Hook into generating the model’s CoreSchema.

Parameters:

source (type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.
handler (GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.

Return type:

Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]

Returns:

A pydantic-core CoreSchema.

classmethod __get_pydantic_json_schema__(core_schema, handler, /)[source]

Hook into generating the model’s JSON schema.

Parameters:

core_schema (Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({'type': 'nullable', 'schema': current_schema}), or just call the handler with the original schema.
handler (GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.

Return type:

Returns:

A JSON schema, as a Python object.

__getattr__(item)[source]

Return type:: Any

__getstate__()[source]

Helper for pickle.

Return type:: dict[Any, Any]

__hash__ = None[source]

__init__(**data)[source]

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__iter__()[source]

So dict(model) works.

Return type:: Generator[Tuple[str, Any], None, None]

__module__ = 'kittycad.models.ok_modeling_cmd_response'[source]

__pretty__(fmt, **kwargs)[source]

Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.

Return type:: Generator[Any, None, None]

__private_attributes__: ClassVar[Dict[str, ModelPrivateAttr]] = {}[source]: Metadata about the private attributes of the model.

__pydantic_complete__: ClassVar[bool] = True[source]: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__: ClassVar[CoreSchema] = {'cls': <class 'kittycad.models.ok_modeling_cmd_response.OptionEntityLinearPatternTransform'>, 'config': {'title': 'OptionEntityLinearPatternTransform'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.ok_modeling_cmd_response.OptionEntityLinearPatternTransform'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.ok_modeling_cmd_response.OptionEntityLinearPatternTransform'>>]}, 'ref': 'kittycad.models.ok_modeling_cmd_response.OptionEntityLinearPatternTransform:94667214051904', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'data': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.entity_linear_pattern_transform.EntityLinearPatternTransform'>, 'config': {'title': 'EntityLinearPatternTransform'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.entity_linear_pattern_transform.EntityLinearPatternTransform'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.entity_linear_pattern_transform.EntityLinearPatternTransform'>>]}, 'ref': 'kittycad.models.entity_linear_pattern_transform.EntityLinearPatternTransform:94667206241936', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'entity_ids': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'items_schema': {'type': 'str'}, 'type': 'list'}, 'type': 'model-field'}}, 'model_name': 'EntityLinearPatternTransform', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}, 'type': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': 'entity_linear_pattern_transform', 'schema': {'expected': ['entity_linear_pattern_transform'], 'type': 'literal'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'OptionEntityLinearPatternTransform', 'type': 'model-fields'}, 'type': 'model'}[source]: The core schema of the model.

__pydantic_custom_init__: ClassVar[bool] = False[source]: Whether the model has a custom __init__ method.

__pydantic_decorators__: ClassVar[_decorators.DecoratorInfos] = DecoratorInfos(validators={}, field_validators={}, root_validators={}, field_serializers={}, model_serializers={}, model_validators={}, computed_fields={})[source]: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_extra__: dict[str, Any] | None[source]: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to 'allow'.

__pydantic_fields_set__: set[str][source]: The names of fields explicitly set during instantiation.

__pydantic_generic_metadata__: ClassVar[_generics.PydanticGenericMetadata] = {'args': (), 'origin': None, 'parameters': ()}[source]: 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.

classmethod __pydantic_init_subclass__(**kwargs)[source]

This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.

This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.

This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.

Parameters:: **kwargs (Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.
Return type:: None

__pydantic_parent_namespace__: ClassVar[Dict[str, Any] | None] = None[source]: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__: ClassVar[None | Literal['model_post_init']] = None[source]: The name of the post-init method for the model, if defined.

__pydantic_private__: dict[str, Any] | None[source]: Values of private attributes set on the model instance.

__pydantic_root_model__: ClassVar[bool] = False[source]: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__: ClassVar[SchemaSerializer] = SchemaSerializer(serializer=Model( ModelSerializer { class: Py( 0x000056196daa5a40, ), serializer: Fields( GeneralFieldsSerializer { fields: { "type": SerField { key_py: Py( 0x00007f903823d958, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f9034696c40, ), ), serializer: Literal( LiteralSerializer { expected_int: {}, expected_str: { "entity_linear_pattern_transform", }, expected_py: None, name: "literal['entity_linear_pattern_transform']", }, ), }, ), ), required: true, }, "data": SerField { key_py: Py( 0x00007f9038238fa0, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196d332e90, ), serializer: Fields( GeneralFieldsSerializer { fields: { "entity_ids": SerField { key_py: Py( 0x00007f9033b07170, ), alias: None, alias_py: None, serializer: Some( List( ListSerializer { item_serializer: Str( StrSerializer, ), filter: SchemaFilter { include: None, exclude: None, }, name: "list[str]", }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 1, }, ), has_extra: false, root_model: false, name: "EntityLinearPatternTransform", }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "OptionEntityLinearPatternTransform", }, ), definitions=[])[source]: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__: ClassVar[SchemaValidator | PluggableSchemaValidator] = SchemaValidator(title="OptionEntityLinearPatternTransform", validator=Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "data", lookup_key: Simple { key: "data", py_key: Py( 0x00007f90333ab300, ), path: LookupPath( [ S( "data", Py( 0x00007f90333ab330, ), ), ], ), }, name_py: Py( 0x00007f9038238fa0, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "entity_ids", lookup_key: Simple { key: "entity_ids", py_key: Py( 0x00007f90333e0230, ), path: LookupPath( [ S( "entity_ids", Py( 0x00007f90333e01f0, ), ), ], ), }, name_py: Py( 0x00007f9033b07170, ), validator: List( ListValidator { strict: false, item_validator: Some( Str( StrValidator { strict: false, coerce_numbers_to_str: false, }, ), ), min_length: None, max_length: None, name: OnceLock( <uninit>, ), fail_fast: false, }, ), frozen: false, }, ], model_name: "EntityLinearPatternTransform", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d332e90, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "EntityLinearPatternTransform", }, ), frozen: false, }, Field { name: "type", lookup_key: Simple { key: "type", py_key: Py( 0x00007f90333ab360, ), path: LookupPath( [ S( "type", Py( 0x00007f90333ab390, ), ), ], ), }, name_py: Py( 0x00007f903823d958, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f9034696c40, ), ), on_error: Raise, validator: Literal( LiteralValidator { lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "entity_linear_pattern_transform": 0, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f9034696c40, ), ], }, expected_repr: "'entity_linear_pattern_transform'", name: "literal['entity_linear_pattern_transform']", }, ), validate_default: false, copy_default: false, name: "default[literal['entity_linear_pattern_transform']]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "OptionEntityLinearPatternTransform", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196daa5a40, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "OptionEntityLinearPatternTransform", }, ), definitions=[], cache_strings=True)[source]: The pydantic-core SchemaValidator used to validate instances of the model.

__repr__()[source]

Return repr(self).

Return type:: str

__repr_args__()[source]

Return type:: Iterable[tuple[str | None, Any]]

__repr_name__()[source]

Name of the instance’s class, used in __repr__.

Return type:: str

__repr_str__(join_str)[source]

Return type:: str

__rich_repr__()[source]

Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.

Return type:: Iterable[Any | tuple[Any] | tuple[str, Any] | tuple[str, Any, Any]]

__setattr__(name, value)[source]

Implement setattr(self, name, value).

Return type:: None

__setstate__(state)[source]

Return type:: None

__signature__: ClassVar[Signature] = <Signature (*, data: kittycad.models.entity_linear_pattern_transform.EntityLinearPatternTransform, type: Literal['entity_linear_pattern_transform'] = 'entity_linear_pattern_transform') -> None>[source]: The synthesized __init__ [Signature][inspect.Signature] of the model.

__slots__ = ('__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__')[source]

__str__()[source]

Return str(self).

Return type:: str

_abc_impl = <_abc._abc_data object>[source]

_calculate_keys(*args, **kwargs)[source]

Return type:: Any

_check_frozen(name, value)[source]

Return type:: None

_copy_and_set_values(*args, **kwargs)[source]

Return type:: Any

classmethod _get_value(*args, **kwargs)[source]

Return type:: Any

_iter(*args, **kwargs)[source]

Return type:: Any

classmethod construct(_fields_set=None, **values)[source]

Return type:: Self

copy(*, include=None, exclude=None, update=None, deep=False)[source]

Returns a copy of the model.

!!! warning “Deprecated”: This method is now deprecated; use model_copy instead.

If you need include or exclude, use:

`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `

Parameters:

include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.

Returns:

A copy of the model with included, excluded and updated fields as specified.

data: EntityLinearPatternTransform[source]

dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)[source]

Return type:: Dict[str, Any]

classmethod from_orm(obj)[source]

Return type:: Self

json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)[source]

Return type:: str

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}[source]: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'protected_namespaces': ()}[source]: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod model_construct(_fields_set=None, **values)[source]

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note: model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == 'allow', then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == 'ignore' (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == 'forbid' does not result in an error if extra values are passed, but they will be ignored.

Parameters:

_fields_set (set[str] | None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.
values (Any) – Trusted or pre-validated data dictionary.

Return type:

Self

Returns:

A new instance of the Model class with validated data.

model_copy(*, update=None, deep=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy

Returns a copy of the model.

Parameters:

update (dict[str, Any] | None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.
deep (bool) – Set to True to make a deep copy of the model.

Return type:

Self

Returns:

New model instance.

model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters:

mode (Union[Literal['json', 'python'], str]) – The mode in which to_python 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.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to include in the output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to exclude from the output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to use the field’s alias in the dictionary key if defined.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A dictionary representation of the model.

model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

Generates a JSON representation of the model using Pydantic’s to_json method.

Parameters:

indent (int | None) – Indentation to use in the JSON output. If None is passed, the output will be compact.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to include in the JSON output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to exclude from the JSON output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to serialize using field aliases.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A JSON string representation of the model.

property model_extra: dict[str, Any] | None[source]

Get extra fields set during validation.

Returns:: A dictionary of extra fields, or None if config.extra is not set to "allow".

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=EntityLinearPatternTransform, required=True), 'type': FieldInfo(annotation=Literal['entity_linear_pattern_transform'], required=False, default='entity_linear_pattern_transform')}[source]

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

property model_fields_set: set[str][source]

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,: i.e. that were not filled from defaults.

classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')[source]

Generates a JSON schema for a model class.

Parameters:

by_alias (bool) – Whether to use attribute aliases or not.
ref_template (str) – The reference template.
schema_generator (type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modifications
mode (Literal['validation', 'serialization']) – The mode in which to generate the schema.

Return type:

Returns:

The JSON schema for the given model class.

classmethod model_parametrized_name(params)[source]

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

Parameters:: params (tuple[type[Any], ...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.
Return type:: str
Returns:: String representing the new class where params are passed to cls as type variables.
Raises:: TypeError – Raised when trying to generate concrete names for non-generic models.

model_post_init(_BaseModel__context)[source]

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

Return type:: None

classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)[source]

Try to rebuild the pydantic-core schema for the model.

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.

Parameters:

force (bool) – Whether to force the rebuilding of the model schema, defaults to False.
raise_errors (bool) – Whether to raise errors, defaults to True.
_parent_namespace_depth (int) – The depth level of the parent namespace, defaults to 2.
_types_namespace (dict[str, Any] | None) – The types namespace, defaults to None.

Return type:

Returns:

Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.

classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)[source]

Validate a pydantic model instance.

Parameters:

obj (Any) – The object to validate.
strict (bool | None) – Whether to enforce types strictly.
from_attributes (bool | None) – Whether to extract data from object attributes.
context (Any | None) – Additional context to pass to the validator.

Raises:

ValidationError – If the object could not be validated.

Return type:

Self

Returns:

The validated model instance.

classmethod model_validate_json(json_data, *, strict=None, context=None)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing

Validate the given JSON data against the Pydantic model.

Parameters:

json_data (str | bytes | bytearray) – The JSON data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

Raises:

ValidationError – If json_data is not a JSON string or the object could not be validated.

classmethod model_validate_strings(obj, *, strict=None, context=None)[source]

Validate the given object with string data against the Pydantic model.

Parameters:

obj (Any) – The object containing string data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod parse_obj(obj)[source]

Return type:: Self

classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod schema(by_alias=True, ref_template='#/$defs/{model}')[source]

Return type:: Dict[str, Any]

classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)[source]

Return type:: str

type: Literal['entity_linear_pattern_transform'][source]

classmethod update_forward_refs(**localns)[source]

Return type:: None

classmethod validate(value)[source]

Return type:: Self

class kittycad.models.ok_modeling_cmd_response.OptionEntityMakeHelix(**data)[source][source]

The response to the ‘EntityMakeHelix’ endpoint

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__abstractmethods__ = frozenset({})[source]

__annotations__ = {'__class_vars__': 'ClassVar[set[str]]', '__private_attributes__': 'ClassVar[Dict[str, ModelPrivateAttr]]', '__pydantic_complete__': 'ClassVar[bool]', '__pydantic_core_schema__': 'ClassVar[CoreSchema]', '__pydantic_custom_init__': 'ClassVar[bool]', '__pydantic_decorators__': 'ClassVar[_decorators.DecoratorInfos]', '__pydantic_extra__': 'dict[str, Any] | None', '__pydantic_fields_set__': 'set[str]', '__pydantic_generic_metadata__': 'ClassVar[_generics.PydanticGenericMetadata]', '__pydantic_parent_namespace__': 'ClassVar[Dict[str, Any] | None]', '__pydantic_post_init__': "ClassVar[None | Literal['model_post_init']]", '__pydantic_private__': 'dict[str, Any] | None', '__pydantic_root_model__': 'ClassVar[bool]', '__pydantic_serializer__': 'ClassVar[SchemaSerializer]', '__pydantic_validator__': 'ClassVar[SchemaValidator | PluggableSchemaValidator]', '__signature__': 'ClassVar[Signature]', 'data': <class 'kittycad.models.entity_make_helix.EntityMakeHelix'>, 'model_computed_fields': 'ClassVar[Dict[str, ComputedFieldInfo]]', 'model_config': 'ClassVar[ConfigDict]', 'model_fields': 'ClassVar[Dict[str, FieldInfo]]', 'type': typing.Literal['entity_make_helix']}[source]

classmethod __class_getitem__(typevar_values)[source]

Return type:: type[BaseModel] | PydanticRecursiveRef

__class_vars__: ClassVar[set[str]] = {}[source]: The names of the class variables defined on the model.

__copy__()[source]

Returns a shallow copy of the model.

Return type:: Self

__deepcopy__(memo=None)[source]

Returns a deep copy of the model.

Return type:: Self

__delattr__(item)[source]

Implement delattr(self, name).

Return type:: Any

__dict__[source]

__eq__(other)[source]

Return self==value.

Return type:: bool

property __fields_set__: set[str][source]

classmethod __get_pydantic_core_schema__(source, handler, /)[source]

Hook into generating the model’s CoreSchema.

Parameters:

source (type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.
handler (GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.

Return type:

Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]

Returns:

A pydantic-core CoreSchema.

classmethod __get_pydantic_json_schema__(core_schema, handler, /)[source]

Hook into generating the model’s JSON schema.

Parameters:

core_schema (Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({'type': 'nullable', 'schema': current_schema}), or just call the handler with the original schema.
handler (GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.

Return type:

Returns:

A JSON schema, as a Python object.

__getattr__(item)[source]

Return type:: Any

__getstate__()[source]

Helper for pickle.

Return type:: dict[Any, Any]

__hash__ = None[source]

__init__(**data)[source]

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__iter__()[source]

So dict(model) works.

Return type:: Generator[Tuple[str, Any], None, None]

__module__ = 'kittycad.models.ok_modeling_cmd_response'[source]

__pretty__(fmt, **kwargs)[source]

Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.

Return type:: Generator[Any, None, None]

__private_attributes__: ClassVar[Dict[str, ModelPrivateAttr]] = {}[source]: Metadata about the private attributes of the model.

__pydantic_complete__: ClassVar[bool] = True[source]: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__: ClassVar[CoreSchema] = {'cls': <class 'kittycad.models.ok_modeling_cmd_response.OptionEntityMakeHelix'>, 'config': {'title': 'OptionEntityMakeHelix'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.ok_modeling_cmd_response.OptionEntityMakeHelix'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.ok_modeling_cmd_response.OptionEntityMakeHelix'>>]}, 'ref': 'kittycad.models.ok_modeling_cmd_response.OptionEntityMakeHelix:94667212794272', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'data': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.entity_make_helix.EntityMakeHelix'>, 'config': {'title': 'EntityMakeHelix'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.entity_make_helix.EntityMakeHelix'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.entity_make_helix.EntityMakeHelix'>>]}, 'ref': 'kittycad.models.entity_make_helix.EntityMakeHelix:94667206264384', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {}, 'model_name': 'EntityMakeHelix', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}, 'type': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': 'entity_make_helix', 'schema': {'expected': ['entity_make_helix'], 'type': 'literal'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'OptionEntityMakeHelix', 'type': 'model-fields'}, 'type': 'model'}[source]: The core schema of the model.

__pydantic_custom_init__: ClassVar[bool] = False[source]: Whether the model has a custom __init__ method.

__pydantic_decorators__: ClassVar[_decorators.DecoratorInfos] = DecoratorInfos(validators={}, field_validators={}, root_validators={}, field_serializers={}, model_serializers={}, model_validators={}, computed_fields={})[source]: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_extra__: dict[str, Any] | None[source]: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to 'allow'.

__pydantic_fields_set__: set[str][source]: The names of fields explicitly set during instantiation.

__pydantic_generic_metadata__: ClassVar[_generics.PydanticGenericMetadata] = {'args': (), 'origin': None, 'parameters': ()}[source]: 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.

classmethod __pydantic_init_subclass__(**kwargs)[source]

This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.

This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.

This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.

Parameters:: **kwargs (Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.
Return type:: None

__pydantic_parent_namespace__: ClassVar[Dict[str, Any] | None] = None[source]: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__: ClassVar[None | Literal['model_post_init']] = None[source]: The name of the post-init method for the model, if defined.

__pydantic_private__: dict[str, Any] | None[source]: Values of private attributes set on the model instance.

__pydantic_root_model__: ClassVar[bool] = False[source]: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__: ClassVar[SchemaSerializer] = SchemaSerializer(serializer=Model( ModelSerializer { class: Py( 0x000056196d9729a0, ), serializer: Fields( GeneralFieldsSerializer { fields: { "data": SerField { key_py: Py( 0x00007f9038238fa0, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196d338640, ), serializer: Fields( GeneralFieldsSerializer { fields: {}, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 0, }, ), has_extra: false, root_model: false, name: "EntityMakeHelix", }, ), ), required: true, }, "type": SerField { key_py: Py( 0x00007f903823d958, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f90347d6f30, ), ), serializer: Literal( LiteralSerializer { expected_int: {}, expected_str: { "entity_make_helix", }, expected_py: None, name: "literal['entity_make_helix']", }, ), }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "OptionEntityMakeHelix", }, ), definitions=[])[source]: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__: ClassVar[SchemaValidator | PluggableSchemaValidator] = SchemaValidator(title="OptionEntityMakeHelix", validator=Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "data", lookup_key: Simple { key: "data", py_key: Py( 0x00007f90336044e0, ), path: LookupPath( [ S( "data", Py( 0x00007f90336044b0, ), ), ], ), }, name_py: Py( 0x00007f9038238fa0, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [], model_name: "EntityMakeHelix", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d338640, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "EntityMakeHelix", }, ), frozen: false, }, Field { name: "type", lookup_key: Simple { key: "type", py_key: Py( 0x00007f90336052c0, ), path: LookupPath( [ S( "type", Py( 0x00007f9033605b60, ), ), ], ), }, name_py: Py( 0x00007f903823d958, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f90347d6f30, ), ), on_error: Raise, validator: Literal( LiteralValidator { lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "entity_make_helix": 0, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f90347d6f30, ), ], }, expected_repr: "'entity_make_helix'", name: "literal['entity_make_helix']", }, ), validate_default: false, copy_default: false, name: "default[literal['entity_make_helix']]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "OptionEntityMakeHelix", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d9729a0, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "OptionEntityMakeHelix", }, ), definitions=[], cache_strings=True)[source]: The pydantic-core SchemaValidator used to validate instances of the model.

__repr__()[source]

Return repr(self).

Return type:: str

__repr_args__()[source]

Return type:: Iterable[tuple[str | None, Any]]

__repr_name__()[source]

Name of the instance’s class, used in __repr__.

Return type:: str

__repr_str__(join_str)[source]

Return type:: str

__rich_repr__()[source]

Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.

Return type:: Iterable[Any | tuple[Any] | tuple[str, Any] | tuple[str, Any, Any]]

__setattr__(name, value)[source]

Implement setattr(self, name, value).

Return type:: None

__setstate__(state)[source]

Return type:: None

__signature__: ClassVar[Signature] = <Signature (*, data: kittycad.models.entity_make_helix.EntityMakeHelix, type: Literal['entity_make_helix'] = 'entity_make_helix') -> None>[source]: The synthesized __init__ [Signature][inspect.Signature] of the model.

__slots__ = ('__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__')[source]

__str__()[source]

Return str(self).

Return type:: str

_abc_impl = <_abc._abc_data object>[source]

_calculate_keys(*args, **kwargs)[source]

Return type:: Any

_check_frozen(name, value)[source]

Return type:: None

_copy_and_set_values(*args, **kwargs)[source]

Return type:: Any

classmethod _get_value(*args, **kwargs)[source]

Return type:: Any

_iter(*args, **kwargs)[source]

Return type:: Any

classmethod construct(_fields_set=None, **values)[source]

Return type:: Self

copy(*, include=None, exclude=None, update=None, deep=False)[source]

Returns a copy of the model.

!!! warning “Deprecated”: This method is now deprecated; use model_copy instead.

If you need include or exclude, use:

`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `

Parameters:

include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.

Returns:

A copy of the model with included, excluded and updated fields as specified.

data: EntityMakeHelix[source]

dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)[source]

Return type:: Dict[str, Any]

classmethod from_orm(obj)[source]

Return type:: Self

json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)[source]

Return type:: str

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}[source]: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'protected_namespaces': ()}[source]: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod model_construct(_fields_set=None, **values)[source]

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note: model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == 'allow', then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == 'ignore' (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == 'forbid' does not result in an error if extra values are passed, but they will be ignored.

Parameters:

_fields_set (set[str] | None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.
values (Any) – Trusted or pre-validated data dictionary.

Return type:

Self

Returns:

A new instance of the Model class with validated data.

model_copy(*, update=None, deep=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy

Returns a copy of the model.

Parameters:

update (dict[str, Any] | None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.
deep (bool) – Set to True to make a deep copy of the model.

Return type:

Self

Returns:

New model instance.

model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters:

mode (Union[Literal['json', 'python'], str]) – The mode in which to_python 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.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to include in the output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to exclude from the output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to use the field’s alias in the dictionary key if defined.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A dictionary representation of the model.

model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

Generates a JSON representation of the model using Pydantic’s to_json method.

Parameters:

indent (int | None) – Indentation to use in the JSON output. If None is passed, the output will be compact.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to include in the JSON output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to exclude from the JSON output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to serialize using field aliases.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A JSON string representation of the model.

property model_extra: dict[str, Any] | None[source]

Get extra fields set during validation.

Returns:: A dictionary of extra fields, or None if config.extra is not set to "allow".

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=EntityMakeHelix, required=True), 'type': FieldInfo(annotation=Literal['entity_make_helix'], required=False, default='entity_make_helix')}[source]

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

property model_fields_set: set[str][source]

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,: i.e. that were not filled from defaults.

classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')[source]

Generates a JSON schema for a model class.

Parameters:

by_alias (bool) – Whether to use attribute aliases or not.
ref_template (str) – The reference template.
schema_generator (type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modifications
mode (Literal['validation', 'serialization']) – The mode in which to generate the schema.

Return type:

Returns:

The JSON schema for the given model class.

classmethod model_parametrized_name(params)[source]

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

Parameters:: params (tuple[type[Any], ...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.
Return type:: str
Returns:: String representing the new class where params are passed to cls as type variables.
Raises:: TypeError – Raised when trying to generate concrete names for non-generic models.

model_post_init(_BaseModel__context)[source]

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

Return type:: None

classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)[source]

Try to rebuild the pydantic-core schema for the model.

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.

Parameters:

force (bool) – Whether to force the rebuilding of the model schema, defaults to False.
raise_errors (bool) – Whether to raise errors, defaults to True.
_parent_namespace_depth (int) – The depth level of the parent namespace, defaults to 2.
_types_namespace (dict[str, Any] | None) – The types namespace, defaults to None.

Return type:

Returns:

Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.

classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)[source]

Validate a pydantic model instance.

Parameters:

obj (Any) – The object to validate.
strict (bool | None) – Whether to enforce types strictly.
from_attributes (bool | None) – Whether to extract data from object attributes.
context (Any | None) – Additional context to pass to the validator.

Raises:

ValidationError – If the object could not be validated.

Return type:

Self

Returns:

The validated model instance.

classmethod model_validate_json(json_data, *, strict=None, context=None)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing

Validate the given JSON data against the Pydantic model.

Parameters:

json_data (str | bytes | bytearray) – The JSON data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

Raises:

ValidationError – If json_data is not a JSON string or the object could not be validated.

classmethod model_validate_strings(obj, *, strict=None, context=None)[source]

Validate the given object with string data against the Pydantic model.

Parameters:

obj (Any) – The object containing string data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod parse_obj(obj)[source]

Return type:: Self

classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod schema(by_alias=True, ref_template='#/$defs/{model}')[source]

Return type:: Dict[str, Any]

classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)[source]

Return type:: str

type: Literal['entity_make_helix'][source]

classmethod update_forward_refs(**localns)[source]

Return type:: None

classmethod validate(value)[source]

Return type:: Self

class kittycad.models.ok_modeling_cmd_response.OptionEntityMirror(**data)[source][source]

The response to the ‘EntityMirror’ endpoint

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__abstractmethods__ = frozenset({})[source]

__annotations__ = {'__class_vars__': 'ClassVar[set[str]]', '__private_attributes__': 'ClassVar[Dict[str, ModelPrivateAttr]]', '__pydantic_complete__': 'ClassVar[bool]', '__pydantic_core_schema__': 'ClassVar[CoreSchema]', '__pydantic_custom_init__': 'ClassVar[bool]', '__pydantic_decorators__': 'ClassVar[_decorators.DecoratorInfos]', '__pydantic_extra__': 'dict[str, Any] | None', '__pydantic_fields_set__': 'set[str]', '__pydantic_generic_metadata__': 'ClassVar[_generics.PydanticGenericMetadata]', '__pydantic_parent_namespace__': 'ClassVar[Dict[str, Any] | None]', '__pydantic_post_init__': "ClassVar[None | Literal['model_post_init']]", '__pydantic_private__': 'dict[str, Any] | None', '__pydantic_root_model__': 'ClassVar[bool]', '__pydantic_serializer__': 'ClassVar[SchemaSerializer]', '__pydantic_validator__': 'ClassVar[SchemaValidator | PluggableSchemaValidator]', '__signature__': 'ClassVar[Signature]', 'data': <class 'kittycad.models.entity_mirror.EntityMirror'>, 'model_computed_fields': 'ClassVar[Dict[str, ComputedFieldInfo]]', 'model_config': 'ClassVar[ConfigDict]', 'model_fields': 'ClassVar[Dict[str, FieldInfo]]', 'type': typing.Literal['entity_mirror']}[source]

classmethod __class_getitem__(typevar_values)[source]

Return type:: type[BaseModel] | PydanticRecursiveRef

__class_vars__: ClassVar[set[str]] = {}[source]: The names of the class variables defined on the model.

__copy__()[source]

Returns a shallow copy of the model.

Return type:: Self

__deepcopy__(memo=None)[source]

Returns a deep copy of the model.

Return type:: Self

__delattr__(item)[source]

Implement delattr(self, name).

Return type:: Any

__dict__[source]

__eq__(other)[source]

Return self==value.

Return type:: bool

property __fields_set__: set[str][source]

classmethod __get_pydantic_core_schema__(source, handler, /)[source]

Hook into generating the model’s CoreSchema.

Parameters:

source (type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.
handler (GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.

Return type:

Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]

Returns:

A pydantic-core CoreSchema.

classmethod __get_pydantic_json_schema__(core_schema, handler, /)[source]

Hook into generating the model’s JSON schema.

Parameters:

core_schema (Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({'type': 'nullable', 'schema': current_schema}), or just call the handler with the original schema.
handler (GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.

Return type:

Returns:

A JSON schema, as a Python object.

__getattr__(item)[source]

Return type:: Any

__getstate__()[source]

Helper for pickle.

Return type:: dict[Any, Any]

__hash__ = None[source]

__init__(**data)[source]

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__iter__()[source]

So dict(model) works.

Return type:: Generator[Tuple[str, Any], None, None]

__module__ = 'kittycad.models.ok_modeling_cmd_response'[source]

__pretty__(fmt, **kwargs)[source]

Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.

Return type:: Generator[Any, None, None]

__private_attributes__: ClassVar[Dict[str, ModelPrivateAttr]] = {}[source]: Metadata about the private attributes of the model.

__pydantic_complete__: ClassVar[bool] = True[source]: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__: ClassVar[CoreSchema] = {'cls': <class 'kittycad.models.ok_modeling_cmd_response.OptionEntityMirror'>, 'config': {'title': 'OptionEntityMirror'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.ok_modeling_cmd_response.OptionEntityMirror'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.ok_modeling_cmd_response.OptionEntityMirror'>>]}, 'ref': 'kittycad.models.ok_modeling_cmd_response.OptionEntityMirror:94667212803616', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'data': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.entity_mirror.EntityMirror'>, 'config': {'title': 'EntityMirror'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.entity_mirror.EntityMirror'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.entity_mirror.EntityMirror'>>]}, 'ref': 'kittycad.models.entity_mirror.EntityMirror:94667206267600', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {}, 'model_name': 'EntityMirror', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}, 'type': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': 'entity_mirror', 'schema': {'expected': ['entity_mirror'], 'type': 'literal'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'OptionEntityMirror', 'type': 'model-fields'}, 'type': 'model'}[source]: The core schema of the model.

__pydantic_custom_init__: ClassVar[bool] = False[source]: Whether the model has a custom __init__ method.

__pydantic_decorators__: ClassVar[_decorators.DecoratorInfos] = DecoratorInfos(validators={}, field_validators={}, root_validators={}, field_serializers={}, model_serializers={}, model_validators={}, computed_fields={})[source]: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_extra__: dict[str, Any] | None[source]: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to 'allow'.

__pydantic_fields_set__: set[str][source]: The names of fields explicitly set during instantiation.

__pydantic_generic_metadata__: ClassVar[_generics.PydanticGenericMetadata] = {'args': (), 'origin': None, 'parameters': ()}[source]: 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.

classmethod __pydantic_init_subclass__(**kwargs)[source]

This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.

This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.

This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.

Parameters:: **kwargs (Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.
Return type:: None

__pydantic_parent_namespace__: ClassVar[Dict[str, Any] | None] = None[source]: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__: ClassVar[None | Literal['model_post_init']] = None[source]: The name of the post-init method for the model, if defined.

__pydantic_private__: dict[str, Any] | None[source]: Values of private attributes set on the model instance.

__pydantic_root_model__: ClassVar[bool] = False[source]: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__: ClassVar[SchemaSerializer] = SchemaSerializer(serializer=Model( ModelSerializer { class: Py( 0x000056196d974e20, ), serializer: Fields( GeneralFieldsSerializer { fields: { "data": SerField { key_py: Py( 0x00007f9038238fa0, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196d3392d0, ), serializer: Fields( GeneralFieldsSerializer { fields: {}, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 0, }, ), has_extra: false, root_model: false, name: "EntityMirror", }, ), ), required: true, }, "type": SerField { key_py: Py( 0x00007f903823d958, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f90347d6fb0, ), ), serializer: Literal( LiteralSerializer { expected_int: {}, expected_str: { "entity_mirror", }, expected_py: None, name: "literal['entity_mirror']", }, ), }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "OptionEntityMirror", }, ), definitions=[])[source]: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__: ClassVar[SchemaValidator | PluggableSchemaValidator] = SchemaValidator(title="OptionEntityMirror", validator=Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "data", lookup_key: Simple { key: "data", py_key: Py( 0x00007f9033607690, ), path: LookupPath( [ S( "data", Py( 0x00007f90336076c0, ), ), ], ), }, name_py: Py( 0x00007f9038238fa0, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [], model_name: "EntityMirror", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d3392d0, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "EntityMirror", }, ), frozen: false, }, Field { name: "type", lookup_key: Simple { key: "type", py_key: Py( 0x00007f90336076f0, ), path: LookupPath( [ S( "type", Py( 0x00007f9033607720, ), ), ], ), }, name_py: Py( 0x00007f903823d958, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f90347d6fb0, ), ), on_error: Raise, validator: Literal( LiteralValidator { lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "entity_mirror": 0, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f90347d6fb0, ), ], }, expected_repr: "'entity_mirror'", name: "literal['entity_mirror']", }, ), validate_default: false, copy_default: false, name: "default[literal['entity_mirror']]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "OptionEntityMirror", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d974e20, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "OptionEntityMirror", }, ), definitions=[], cache_strings=True)[source]: The pydantic-core SchemaValidator used to validate instances of the model.

__repr__()[source]

Return repr(self).

Return type:: str

__repr_args__()[source]

Return type:: Iterable[tuple[str | None, Any]]

__repr_name__()[source]

Name of the instance’s class, used in __repr__.

Return type:: str

__repr_str__(join_str)[source]

Return type:: str

__rich_repr__()[source]

Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.

Return type:: Iterable[Any | tuple[Any] | tuple[str, Any] | tuple[str, Any, Any]]

__setattr__(name, value)[source]

Implement setattr(self, name, value).

Return type:: None

__setstate__(state)[source]

Return type:: None

__signature__: ClassVar[Signature] = <Signature (*, data: kittycad.models.entity_mirror.EntityMirror, type: Literal['entity_mirror'] = 'entity_mirror') -> None>[source]: The synthesized __init__ [Signature][inspect.Signature] of the model.

__slots__ = ('__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__')[source]

__str__()[source]

Return str(self).

Return type:: str

_abc_impl = <_abc._abc_data object>[source]

_calculate_keys(*args, **kwargs)[source]

Return type:: Any

_check_frozen(name, value)[source]

Return type:: None

_copy_and_set_values(*args, **kwargs)[source]

Return type:: Any

classmethod _get_value(*args, **kwargs)[source]

Return type:: Any

_iter(*args, **kwargs)[source]

Return type:: Any

classmethod construct(_fields_set=None, **values)[source]

Return type:: Self

copy(*, include=None, exclude=None, update=None, deep=False)[source]

Returns a copy of the model.

!!! warning “Deprecated”: This method is now deprecated; use model_copy instead.

If you need include or exclude, use:

`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `

Parameters:

include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.

Returns:

A copy of the model with included, excluded and updated fields as specified.

data: EntityMirror[source]

dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)[source]

Return type:: Dict[str, Any]

classmethod from_orm(obj)[source]

Return type:: Self

json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)[source]

Return type:: str

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}[source]: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'protected_namespaces': ()}[source]: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod model_construct(_fields_set=None, **values)[source]

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note: model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == 'allow', then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == 'ignore' (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == 'forbid' does not result in an error if extra values are passed, but they will be ignored.

Parameters:

_fields_set (set[str] | None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.
values (Any) – Trusted or pre-validated data dictionary.

Return type:

Self

Returns:

A new instance of the Model class with validated data.

model_copy(*, update=None, deep=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy

Returns a copy of the model.

Parameters:

update (dict[str, Any] | None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.
deep (bool) – Set to True to make a deep copy of the model.

Return type:

Self

Returns:

New model instance.

model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters:

mode (Union[Literal['json', 'python'], str]) – The mode in which to_python 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.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to include in the output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to exclude from the output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to use the field’s alias in the dictionary key if defined.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A dictionary representation of the model.

model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

Generates a JSON representation of the model using Pydantic’s to_json method.

Parameters:

indent (int | None) – Indentation to use in the JSON output. If None is passed, the output will be compact.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to include in the JSON output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to exclude from the JSON output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to serialize using field aliases.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A JSON string representation of the model.

property model_extra: dict[str, Any] | None[source]

Get extra fields set during validation.

Returns:: A dictionary of extra fields, or None if config.extra is not set to "allow".

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=EntityMirror, required=True), 'type': FieldInfo(annotation=Literal['entity_mirror'], required=False, default='entity_mirror')}[source]

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

property model_fields_set: set[str][source]

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,: i.e. that were not filled from defaults.

classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')[source]

Generates a JSON schema for a model class.

Parameters:

by_alias (bool) – Whether to use attribute aliases or not.
ref_template (str) – The reference template.
schema_generator (type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modifications
mode (Literal['validation', 'serialization']) – The mode in which to generate the schema.

Return type:

Returns:

The JSON schema for the given model class.

classmethod model_parametrized_name(params)[source]

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

Parameters:: params (tuple[type[Any], ...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.
Return type:: str
Returns:: String representing the new class where params are passed to cls as type variables.
Raises:: TypeError – Raised when trying to generate concrete names for non-generic models.

model_post_init(_BaseModel__context)[source]

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

Return type:: None

classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)[source]

Try to rebuild the pydantic-core schema for the model.

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.

Parameters:

force (bool) – Whether to force the rebuilding of the model schema, defaults to False.
raise_errors (bool) – Whether to raise errors, defaults to True.
_parent_namespace_depth (int) – The depth level of the parent namespace, defaults to 2.
_types_namespace (dict[str, Any] | None) – The types namespace, defaults to None.

Return type:

Returns:

Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.

classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)[source]

Validate a pydantic model instance.

Parameters:

obj (Any) – The object to validate.
strict (bool | None) – Whether to enforce types strictly.
from_attributes (bool | None) – Whether to extract data from object attributes.
context (Any | None) – Additional context to pass to the validator.

Raises:

ValidationError – If the object could not be validated.

Return type:

Self

Returns:

The validated model instance.

classmethod model_validate_json(json_data, *, strict=None, context=None)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing

Validate the given JSON data against the Pydantic model.

Parameters:

json_data (str | bytes | bytearray) – The JSON data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

Raises:

ValidationError – If json_data is not a JSON string or the object could not be validated.

classmethod model_validate_strings(obj, *, strict=None, context=None)[source]

Validate the given object with string data against the Pydantic model.

Parameters:

obj (Any) – The object containing string data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod parse_obj(obj)[source]

Return type:: Self

classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod schema(by_alias=True, ref_template='#/$defs/{model}')[source]

Return type:: Dict[str, Any]

classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)[source]

Return type:: str

type: Literal['entity_mirror'][source]

classmethod update_forward_refs(**localns)[source]

Return type:: None

classmethod validate(value)[source]

Return type:: Self

class kittycad.models.ok_modeling_cmd_response.OptionEntityMirrorAcrossEdge(**data)[source][source]

The response to the ‘EntityMirrorAcrossEdge’ endpoint

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__abstractmethods__ = frozenset({})[source]

__annotations__ = {'__class_vars__': 'ClassVar[set[str]]', '__private_attributes__': 'ClassVar[Dict[str, ModelPrivateAttr]]', '__pydantic_complete__': 'ClassVar[bool]', '__pydantic_core_schema__': 'ClassVar[CoreSchema]', '__pydantic_custom_init__': 'ClassVar[bool]', '__pydantic_decorators__': 'ClassVar[_decorators.DecoratorInfos]', '__pydantic_extra__': 'dict[str, Any] | None', '__pydantic_fields_set__': 'set[str]', '__pydantic_generic_metadata__': 'ClassVar[_generics.PydanticGenericMetadata]', '__pydantic_parent_namespace__': 'ClassVar[Dict[str, Any] | None]', '__pydantic_post_init__': "ClassVar[None | Literal['model_post_init']]", '__pydantic_private__': 'dict[str, Any] | None', '__pydantic_root_model__': 'ClassVar[bool]', '__pydantic_serializer__': 'ClassVar[SchemaSerializer]', '__pydantic_validator__': 'ClassVar[SchemaValidator | PluggableSchemaValidator]', '__signature__': 'ClassVar[Signature]', 'data': <class 'kittycad.models.entity_mirror_across_edge.EntityMirrorAcrossEdge'>, 'model_computed_fields': 'ClassVar[Dict[str, ComputedFieldInfo]]', 'model_config': 'ClassVar[ConfigDict]', 'model_fields': 'ClassVar[Dict[str, FieldInfo]]', 'type': typing.Literal['entity_mirror_across_edge']}[source]

classmethod __class_getitem__(typevar_values)[source]

Return type:: type[BaseModel] | PydanticRecursiveRef

__class_vars__: ClassVar[set[str]] = {}[source]: The names of the class variables defined on the model.

__copy__()[source]

Returns a shallow copy of the model.

Return type:: Self

__deepcopy__(memo=None)[source]

Returns a deep copy of the model.

Return type:: Self

__delattr__(item)[source]

Implement delattr(self, name).

Return type:: Any

__dict__[source]

__eq__(other)[source]

Return self==value.

Return type:: bool

property __fields_set__: set[str][source]

classmethod __get_pydantic_core_schema__(source, handler, /)[source]

Hook into generating the model’s CoreSchema.

Parameters:

source (type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.
handler (GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.

Return type:

Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]

Returns:

A pydantic-core CoreSchema.

classmethod __get_pydantic_json_schema__(core_schema, handler, /)[source]

Hook into generating the model’s JSON schema.

Parameters:

core_schema (Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({'type': 'nullable', 'schema': current_schema}), or just call the handler with the original schema.
handler (GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.

Return type:

Returns:

A JSON schema, as a Python object.

__getattr__(item)[source]

Return type:: Any

__getstate__()[source]

Helper for pickle.

Return type:: dict[Any, Any]

__hash__ = None[source]

__init__(**data)[source]

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__iter__()[source]

So dict(model) works.

Return type:: Generator[Tuple[str, Any], None, None]

__module__ = 'kittycad.models.ok_modeling_cmd_response'[source]

__pretty__(fmt, **kwargs)[source]

Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.

Return type:: Generator[Any, None, None]

__private_attributes__: ClassVar[Dict[str, ModelPrivateAttr]] = {}[source]: Metadata about the private attributes of the model.

__pydantic_complete__: ClassVar[bool] = True[source]: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__: ClassVar[CoreSchema] = {'cls': <class 'kittycad.models.ok_modeling_cmd_response.OptionEntityMirrorAcrossEdge'>, 'config': {'title': 'OptionEntityMirrorAcrossEdge'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.ok_modeling_cmd_response.OptionEntityMirrorAcrossEdge'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.ok_modeling_cmd_response.OptionEntityMirrorAcrossEdge'>>]}, 'ref': 'kittycad.models.ok_modeling_cmd_response.OptionEntityMirrorAcrossEdge:94667212813088', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'data': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.entity_mirror_across_edge.EntityMirrorAcrossEdge'>, 'config': {'title': 'EntityMirrorAcrossEdge'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.entity_mirror_across_edge.EntityMirrorAcrossEdge'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.entity_mirror_across_edge.EntityMirrorAcrossEdge'>>]}, 'ref': 'kittycad.models.entity_mirror_across_edge.EntityMirrorAcrossEdge:94667206253376', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {}, 'model_name': 'EntityMirrorAcrossEdge', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}, 'type': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': 'entity_mirror_across_edge', 'schema': {'expected': ['entity_mirror_across_edge'], 'type': 'literal'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'OptionEntityMirrorAcrossEdge', 'type': 'model-fields'}, 'type': 'model'}[source]: The core schema of the model.

__pydantic_custom_init__: ClassVar[bool] = False[source]: Whether the model has a custom __init__ method.

__pydantic_decorators__: ClassVar[_decorators.DecoratorInfos] = DecoratorInfos(validators={}, field_validators={}, root_validators={}, field_serializers={}, model_serializers={}, model_validators={}, computed_fields={})[source]: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_extra__: dict[str, Any] | None[source]: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to 'allow'.

__pydantic_fields_set__: set[str][source]: The names of fields explicitly set during instantiation.

__pydantic_generic_metadata__: ClassVar[_generics.PydanticGenericMetadata] = {'args': (), 'origin': None, 'parameters': ()}[source]: 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.

classmethod __pydantic_init_subclass__(**kwargs)[source]

This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.

This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.

This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.

Parameters:: **kwargs (Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.
Return type:: None

__pydantic_parent_namespace__: ClassVar[Dict[str, Any] | None] = None[source]: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__: ClassVar[None | Literal['model_post_init']] = None[source]: The name of the post-init method for the model, if defined.

__pydantic_private__: dict[str, Any] | None[source]: Values of private attributes set on the model instance.

__pydantic_root_model__: ClassVar[bool] = False[source]: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__: ClassVar[SchemaSerializer] = SchemaSerializer(serializer=Model( ModelSerializer { class: Py( 0x000056196d977320, ), serializer: Fields( GeneralFieldsSerializer { fields: { "data": SerField { key_py: Py( 0x00007f9038238fa0, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196d335b40, ), serializer: Fields( GeneralFieldsSerializer { fields: {}, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 0, }, ), has_extra: false, root_model: false, name: "EntityMirrorAcrossEdge", }, ), ), required: true, }, "type": SerField { key_py: Py( 0x00007f903823d958, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f9034696ce0, ), ), serializer: Literal( LiteralSerializer { expected_int: {}, expected_str: { "entity_mirror_across_edge", }, expected_py: None, name: "literal['entity_mirror_across_edge']", }, ), }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "OptionEntityMirrorAcrossEdge", }, ), definitions=[])[source]: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__: ClassVar[SchemaValidator | PluggableSchemaValidator] = SchemaValidator(title="OptionEntityMirrorAcrossEdge", validator=Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "data", lookup_key: Simple { key: "data", py_key: Py( 0x00007f9033607b40, ), path: LookupPath( [ S( "data", Py( 0x00007f9033607b70, ), ), ], ), }, name_py: Py( 0x00007f9038238fa0, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [], model_name: "EntityMirrorAcrossEdge", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d335b40, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "EntityMirrorAcrossEdge", }, ), frozen: false, }, Field { name: "type", lookup_key: Simple { key: "type", py_key: Py( 0x00007f9033607ba0, ), path: LookupPath( [ S( "type", Py( 0x00007f9033607bd0, ), ), ], ), }, name_py: Py( 0x00007f903823d958, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f9034696ce0, ), ), on_error: Raise, validator: Literal( LiteralValidator { lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "entity_mirror_across_edge": 0, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f9034696ce0, ), ], }, expected_repr: "'entity_mirror_across_edge'", name: "literal['entity_mirror_across_edge']", }, ), validate_default: false, copy_default: false, name: "default[literal['entity_mirror_across_edge']]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "OptionEntityMirrorAcrossEdge", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d977320, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "OptionEntityMirrorAcrossEdge", }, ), definitions=[], cache_strings=True)[source]: The pydantic-core SchemaValidator used to validate instances of the model.

__repr__()[source]

Return repr(self).

Return type:: str

__repr_args__()[source]

Return type:: Iterable[tuple[str | None, Any]]

__repr_name__()[source]

Name of the instance’s class, used in __repr__.

Return type:: str

__repr_str__(join_str)[source]

Return type:: str

__rich_repr__()[source]

Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.

Return type:: Iterable[Any | tuple[Any] | tuple[str, Any] | tuple[str, Any, Any]]

__setattr__(name, value)[source]

Implement setattr(self, name, value).

Return type:: None

__setstate__(state)[source]

Return type:: None

__signature__: ClassVar[Signature] = <Signature (*, data: kittycad.models.entity_mirror_across_edge.EntityMirrorAcrossEdge, type: Literal['entity_mirror_across_edge'] = 'entity_mirror_across_edge') -> None>[source]: The synthesized __init__ [Signature][inspect.Signature] of the model.

__slots__ = ('__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__')[source]

__str__()[source]

Return str(self).

Return type:: str

_abc_impl = <_abc._abc_data object>[source]

_calculate_keys(*args, **kwargs)[source]

Return type:: Any

_check_frozen(name, value)[source]

Return type:: None

_copy_and_set_values(*args, **kwargs)[source]

Return type:: Any

classmethod _get_value(*args, **kwargs)[source]

Return type:: Any

_iter(*args, **kwargs)[source]

Return type:: Any

classmethod construct(_fields_set=None, **values)[source]

Return type:: Self

copy(*, include=None, exclude=None, update=None, deep=False)[source]

Returns a copy of the model.

!!! warning “Deprecated”: This method is now deprecated; use model_copy instead.

If you need include or exclude, use:

`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `

Parameters:

include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.

Returns:

A copy of the model with included, excluded and updated fields as specified.

data: EntityMirrorAcrossEdge[source]

dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)[source]

Return type:: Dict[str, Any]

classmethod from_orm(obj)[source]

Return type:: Self

json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)[source]

Return type:: str

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}[source]: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'protected_namespaces': ()}[source]: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod model_construct(_fields_set=None, **values)[source]

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note: model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == 'allow', then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == 'ignore' (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == 'forbid' does not result in an error if extra values are passed, but they will be ignored.

Parameters:

_fields_set (set[str] | None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.
values (Any) – Trusted or pre-validated data dictionary.

Return type:

Self

Returns:

A new instance of the Model class with validated data.

model_copy(*, update=None, deep=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy

Returns a copy of the model.

Parameters:

update (dict[str, Any] | None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.
deep (bool) – Set to True to make a deep copy of the model.

Return type:

Self

Returns:

New model instance.

model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters:

mode (Union[Literal['json', 'python'], str]) – The mode in which to_python 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.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to include in the output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to exclude from the output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to use the field’s alias in the dictionary key if defined.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A dictionary representation of the model.

model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

Generates a JSON representation of the model using Pydantic’s to_json method.

Parameters:

indent (int | None) – Indentation to use in the JSON output. If None is passed, the output will be compact.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to include in the JSON output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to exclude from the JSON output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to serialize using field aliases.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A JSON string representation of the model.

property model_extra: dict[str, Any] | None[source]

Get extra fields set during validation.

Returns:: A dictionary of extra fields, or None if config.extra is not set to "allow".

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=EntityMirrorAcrossEdge, required=True), 'type': FieldInfo(annotation=Literal['entity_mirror_across_edge'], required=False, default='entity_mirror_across_edge')}[source]

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

property model_fields_set: set[str][source]

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,: i.e. that were not filled from defaults.

classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')[source]

Generates a JSON schema for a model class.

Parameters:

by_alias (bool) – Whether to use attribute aliases or not.
ref_template (str) – The reference template.
schema_generator (type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modifications
mode (Literal['validation', 'serialization']) – The mode in which to generate the schema.

Return type:

Returns:

The JSON schema for the given model class.

classmethod model_parametrized_name(params)[source]

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

Parameters:: params (tuple[type[Any], ...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.
Return type:: str
Returns:: String representing the new class where params are passed to cls as type variables.
Raises:: TypeError – Raised when trying to generate concrete names for non-generic models.

model_post_init(_BaseModel__context)[source]

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

Return type:: None

classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)[source]

Try to rebuild the pydantic-core schema for the model.

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.

Parameters:

force (bool) – Whether to force the rebuilding of the model schema, defaults to False.
raise_errors (bool) – Whether to raise errors, defaults to True.
_parent_namespace_depth (int) – The depth level of the parent namespace, defaults to 2.
_types_namespace (dict[str, Any] | None) – The types namespace, defaults to None.

Return type:

Returns:

Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.

classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)[source]

Validate a pydantic model instance.

Parameters:

obj (Any) – The object to validate.
strict (bool | None) – Whether to enforce types strictly.
from_attributes (bool | None) – Whether to extract data from object attributes.
context (Any | None) – Additional context to pass to the validator.

Raises:

ValidationError – If the object could not be validated.

Return type:

Self

Returns:

The validated model instance.

classmethod model_validate_json(json_data, *, strict=None, context=None)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing

Validate the given JSON data against the Pydantic model.

Parameters:

json_data (str | bytes | bytearray) – The JSON data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

Raises:

ValidationError – If json_data is not a JSON string or the object could not be validated.

classmethod model_validate_strings(obj, *, strict=None, context=None)[source]

Validate the given object with string data against the Pydantic model.

Parameters:

obj (Any) – The object containing string data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod parse_obj(obj)[source]

Return type:: Self

classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod schema(by_alias=True, ref_template='#/$defs/{model}')[source]

Return type:: Dict[str, Any]

classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)[source]

Return type:: str

type: Literal['entity_mirror_across_edge'][source]

classmethod update_forward_refs(**localns)[source]

Return type:: None

classmethod validate(value)[source]

Return type:: Self

class kittycad.models.ok_modeling_cmd_response.OptionEntitySetOpacity(**data)[source][source]

The response to the ‘EntitySetOpacity’ endpoint

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__abstractmethods__ = frozenset({})[source]

__annotations__ = {'__class_vars__': 'ClassVar[set[str]]', '__private_attributes__': 'ClassVar[Dict[str, ModelPrivateAttr]]', '__pydantic_complete__': 'ClassVar[bool]', '__pydantic_core_schema__': 'ClassVar[CoreSchema]', '__pydantic_custom_init__': 'ClassVar[bool]', '__pydantic_decorators__': 'ClassVar[_decorators.DecoratorInfos]', '__pydantic_extra__': 'dict[str, Any] | None', '__pydantic_fields_set__': 'set[str]', '__pydantic_generic_metadata__': 'ClassVar[_generics.PydanticGenericMetadata]', '__pydantic_parent_namespace__': 'ClassVar[Dict[str, Any] | None]', '__pydantic_post_init__': "ClassVar[None | Literal['model_post_init']]", '__pydantic_private__': 'dict[str, Any] | None', '__pydantic_root_model__': 'ClassVar[bool]', '__pydantic_serializer__': 'ClassVar[SchemaSerializer]', '__pydantic_validator__': 'ClassVar[SchemaValidator | PluggableSchemaValidator]', '__signature__': 'ClassVar[Signature]', 'data': <class 'kittycad.models.entity_set_opacity.EntitySetOpacity'>, 'model_computed_fields': 'ClassVar[Dict[str, ComputedFieldInfo]]', 'model_config': 'ClassVar[ConfigDict]', 'model_fields': 'ClassVar[Dict[str, FieldInfo]]', 'type': typing.Literal['entity_set_opacity']}[source]

classmethod __class_getitem__(typevar_values)[source]

Return type:: type[BaseModel] | PydanticRecursiveRef

__class_vars__: ClassVar[set[str]] = {}[source]: The names of the class variables defined on the model.

__copy__()[source]

Returns a shallow copy of the model.

Return type:: Self

__deepcopy__(memo=None)[source]

Returns a deep copy of the model.

Return type:: Self

__delattr__(item)[source]

Implement delattr(self, name).

Return type:: Any

__dict__[source]

__eq__(other)[source]

Return self==value.

Return type:: bool

property __fields_set__: set[str][source]

classmethod __get_pydantic_core_schema__(source, handler, /)[source]

Hook into generating the model’s CoreSchema.

Parameters:

source (type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.
handler (GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.

Return type:

Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]

Returns:

A pydantic-core CoreSchema.

classmethod __get_pydantic_json_schema__(core_schema, handler, /)[source]

Hook into generating the model’s JSON schema.

Parameters:

core_schema (Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({'type': 'nullable', 'schema': current_schema}), or just call the handler with the original schema.
handler (GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.

Return type:

Returns:

A JSON schema, as a Python object.

__getattr__(item)[source]

Return type:: Any

__getstate__()[source]

Helper for pickle.

Return type:: dict[Any, Any]

__hash__ = None[source]

__init__(**data)[source]

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__iter__()[source]

So dict(model) works.

Return type:: Generator[Tuple[str, Any], None, None]

__module__ = 'kittycad.models.ok_modeling_cmd_response'[source]

__pretty__(fmt, **kwargs)[source]

Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.

Return type:: Generator[Any, None, None]

__private_attributes__: ClassVar[Dict[str, ModelPrivateAttr]] = {}[source]: Metadata about the private attributes of the model.

__pydantic_complete__: ClassVar[bool] = True[source]: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__: ClassVar[CoreSchema] = {'cls': <class 'kittycad.models.ok_modeling_cmd_response.OptionEntitySetOpacity'>, 'config': {'title': 'OptionEntitySetOpacity'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.ok_modeling_cmd_response.OptionEntitySetOpacity'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.ok_modeling_cmd_response.OptionEntitySetOpacity'>>]}, 'ref': 'kittycad.models.ok_modeling_cmd_response.OptionEntitySetOpacity:94667212962320', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'data': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.entity_set_opacity.EntitySetOpacity'>, 'config': {'title': 'EntitySetOpacity'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.entity_set_opacity.EntitySetOpacity'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.entity_set_opacity.EntitySetOpacity'>>]}, 'ref': 'kittycad.models.entity_set_opacity.EntitySetOpacity:94667206262896', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {}, 'model_name': 'EntitySetOpacity', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}, 'type': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': 'entity_set_opacity', 'schema': {'expected': ['entity_set_opacity'], 'type': 'literal'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'OptionEntitySetOpacity', 'type': 'model-fields'}, 'type': 'model'}[source]: The core schema of the model.

__pydantic_custom_init__: ClassVar[bool] = False[source]: Whether the model has a custom __init__ method.

__pydantic_decorators__: ClassVar[_decorators.DecoratorInfos] = DecoratorInfos(validators={}, field_validators={}, root_validators={}, field_serializers={}, model_serializers={}, model_validators={}, computed_fields={})[source]: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_extra__: dict[str, Any] | None[source]: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to 'allow'.

__pydantic_fields_set__: set[str][source]: The names of fields explicitly set during instantiation.

__pydantic_generic_metadata__: ClassVar[_generics.PydanticGenericMetadata] = {'args': (), 'origin': None, 'parameters': ()}[source]: 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.

classmethod __pydantic_init_subclass__(**kwargs)[source]

This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.

This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.

This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.

Parameters:: **kwargs (Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.
Return type:: None

__pydantic_parent_namespace__: ClassVar[Dict[str, Any] | None] = None[source]: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__: ClassVar[None | Literal['model_post_init']] = None[source]: The name of the post-init method for the model, if defined.

__pydantic_private__: dict[str, Any] | None[source]: Values of private attributes set on the model instance.

__pydantic_root_model__: ClassVar[bool] = False[source]: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__: ClassVar[SchemaSerializer] = SchemaSerializer(serializer=Model( ModelSerializer { class: Py( 0x000056196d99ba10, ), serializer: Fields( GeneralFieldsSerializer { fields: { "type": SerField { key_py: Py( 0x00007f903823d958, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f90347d71f0, ), ), serializer: Literal( LiteralSerializer { expected_int: {}, expected_str: { "entity_set_opacity", }, expected_py: None, name: "literal['entity_set_opacity']", }, ), }, ), ), required: true, }, "data": SerField { key_py: Py( 0x00007f9038238fa0, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196d338070, ), serializer: Fields( GeneralFieldsSerializer { fields: {}, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 0, }, ), has_extra: false, root_model: false, name: "EntitySetOpacity", }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "OptionEntitySetOpacity", }, ), definitions=[])[source]: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__: ClassVar[SchemaValidator | PluggableSchemaValidator] = SchemaValidator(title="OptionEntitySetOpacity", validator=Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "data", lookup_key: Simple { key: "data", py_key: Py( 0x00007f90336073c0, ), path: LookupPath( [ S( "data", Py( 0x00007f90336064c0, ), ), ], ), }, name_py: Py( 0x00007f9038238fa0, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [], model_name: "EntitySetOpacity", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d338070, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "EntitySetOpacity", }, ), frozen: false, }, Field { name: "type", lookup_key: Simple { key: "type", py_key: Py( 0x00007f9033606fa0, ), path: LookupPath( [ S( "type", Py( 0x00007f9033606220, ), ), ], ), }, name_py: Py( 0x00007f903823d958, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f90347d71f0, ), ), on_error: Raise, validator: Literal( LiteralValidator { lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "entity_set_opacity": 0, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f90347d71f0, ), ], }, expected_repr: "'entity_set_opacity'", name: "literal['entity_set_opacity']", }, ), validate_default: false, copy_default: false, name: "default[literal['entity_set_opacity']]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "OptionEntitySetOpacity", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d99ba10, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "OptionEntitySetOpacity", }, ), definitions=[], cache_strings=True)[source]: The pydantic-core SchemaValidator used to validate instances of the model.

__repr__()[source]

Return repr(self).

Return type:: str

__repr_args__()[source]

Return type:: Iterable[tuple[str | None, Any]]

__repr_name__()[source]

Name of the instance’s class, used in __repr__.

Return type:: str

__repr_str__(join_str)[source]

Return type:: str

__rich_repr__()[source]

Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.

Return type:: Iterable[Any | tuple[Any] | tuple[str, Any] | tuple[str, Any, Any]]

__setattr__(name, value)[source]

Implement setattr(self, name, value).

Return type:: None

__setstate__(state)[source]

Return type:: None

__signature__: ClassVar[Signature] = <Signature (*, data: kittycad.models.entity_set_opacity.EntitySetOpacity, type: Literal['entity_set_opacity'] = 'entity_set_opacity') -> None>[source]: The synthesized __init__ [Signature][inspect.Signature] of the model.

__slots__ = ('__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__')[source]

__str__()[source]

Return str(self).

Return type:: str

_abc_impl = <_abc._abc_data object>[source]

_calculate_keys(*args, **kwargs)[source]

Return type:: Any

_check_frozen(name, value)[source]

Return type:: None

_copy_and_set_values(*args, **kwargs)[source]

Return type:: Any

classmethod _get_value(*args, **kwargs)[source]

Return type:: Any

_iter(*args, **kwargs)[source]

Return type:: Any

classmethod construct(_fields_set=None, **values)[source]

Return type:: Self

copy(*, include=None, exclude=None, update=None, deep=False)[source]

Returns a copy of the model.

!!! warning “Deprecated”: This method is now deprecated; use model_copy instead.

If you need include or exclude, use:

`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `

Parameters:

include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.

Returns:

A copy of the model with included, excluded and updated fields as specified.

data: EntitySetOpacity[source]

dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)[source]

Return type:: Dict[str, Any]

classmethod from_orm(obj)[source]

Return type:: Self

json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)[source]

Return type:: str

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}[source]: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'protected_namespaces': ()}[source]: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod model_construct(_fields_set=None, **values)[source]

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note: model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == 'allow', then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == 'ignore' (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == 'forbid' does not result in an error if extra values are passed, but they will be ignored.

Parameters:

_fields_set (set[str] | None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.
values (Any) – Trusted or pre-validated data dictionary.

Return type:

Self

Returns:

A new instance of the Model class with validated data.

model_copy(*, update=None, deep=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy

Returns a copy of the model.

Parameters:

update (dict[str, Any] | None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.
deep (bool) – Set to True to make a deep copy of the model.

Return type:

Self

Returns:

New model instance.

model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters:

mode (Union[Literal['json', 'python'], str]) – The mode in which to_python 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.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to include in the output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to exclude from the output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to use the field’s alias in the dictionary key if defined.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A dictionary representation of the model.

model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

Generates a JSON representation of the model using Pydantic’s to_json method.

Parameters:

indent (int | None) – Indentation to use in the JSON output. If None is passed, the output will be compact.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to include in the JSON output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to exclude from the JSON output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to serialize using field aliases.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A JSON string representation of the model.

property model_extra: dict[str, Any] | None[source]

Get extra fields set during validation.

Returns:: A dictionary of extra fields, or None if config.extra is not set to "allow".

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=EntitySetOpacity, required=True), 'type': FieldInfo(annotation=Literal['entity_set_opacity'], required=False, default='entity_set_opacity')}[source]

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

property model_fields_set: set[str][source]

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,: i.e. that were not filled from defaults.

classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')[source]

Generates a JSON schema for a model class.

Parameters:

by_alias (bool) – Whether to use attribute aliases or not.
ref_template (str) – The reference template.
schema_generator (type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modifications
mode (Literal['validation', 'serialization']) – The mode in which to generate the schema.

Return type:

Returns:

The JSON schema for the given model class.

classmethod model_parametrized_name(params)[source]

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

Parameters:: params (tuple[type[Any], ...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.
Return type:: str
Returns:: String representing the new class where params are passed to cls as type variables.
Raises:: TypeError – Raised when trying to generate concrete names for non-generic models.

model_post_init(_BaseModel__context)[source]

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

Return type:: None

classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)[source]

Try to rebuild the pydantic-core schema for the model.

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.

Parameters:

force (bool) – Whether to force the rebuilding of the model schema, defaults to False.
raise_errors (bool) – Whether to raise errors, defaults to True.
_parent_namespace_depth (int) – The depth level of the parent namespace, defaults to 2.
_types_namespace (dict[str, Any] | None) – The types namespace, defaults to None.

Return type:

Returns:

Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.

classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)[source]

Validate a pydantic model instance.

Parameters:

obj (Any) – The object to validate.
strict (bool | None) – Whether to enforce types strictly.
from_attributes (bool | None) – Whether to extract data from object attributes.
context (Any | None) – Additional context to pass to the validator.

Raises:

ValidationError – If the object could not be validated.

Return type:

Self

Returns:

The validated model instance.

classmethod model_validate_json(json_data, *, strict=None, context=None)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing

Validate the given JSON data against the Pydantic model.

Parameters:

json_data (str | bytes | bytearray) – The JSON data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

Raises:

ValidationError – If json_data is not a JSON string or the object could not be validated.

classmethod model_validate_strings(obj, *, strict=None, context=None)[source]

Validate the given object with string data against the Pydantic model.

Parameters:

obj (Any) – The object containing string data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod parse_obj(obj)[source]

Return type:: Self

classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod schema(by_alias=True, ref_template='#/$defs/{model}')[source]

Return type:: Dict[str, Any]

classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)[source]

Return type:: str

type: Literal['entity_set_opacity'][source]

classmethod update_forward_refs(**localns)[source]

Return type:: None

classmethod validate(value)[source]

Return type:: Self

class kittycad.models.ok_modeling_cmd_response.OptionExport(**data)[source][source]

The response to the ‘Export’ endpoint

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__abstractmethods__ = frozenset({})[source]

__annotations__ = {'__class_vars__': 'ClassVar[set[str]]', '__private_attributes__': 'ClassVar[Dict[str, ModelPrivateAttr]]', '__pydantic_complete__': 'ClassVar[bool]', '__pydantic_core_schema__': 'ClassVar[CoreSchema]', '__pydantic_custom_init__': 'ClassVar[bool]', '__pydantic_decorators__': 'ClassVar[_decorators.DecoratorInfos]', '__pydantic_extra__': 'dict[str, Any] | None', '__pydantic_fields_set__': 'set[str]', '__pydantic_generic_metadata__': 'ClassVar[_generics.PydanticGenericMetadata]', '__pydantic_parent_namespace__': 'ClassVar[Dict[str, Any] | None]', '__pydantic_post_init__': "ClassVar[None | Literal['model_post_init']]", '__pydantic_private__': 'dict[str, Any] | None', '__pydantic_root_model__': 'ClassVar[bool]', '__pydantic_serializer__': 'ClassVar[SchemaSerializer]', '__pydantic_validator__': 'ClassVar[SchemaValidator | PluggableSchemaValidator]', '__signature__': 'ClassVar[Signature]', 'data': <class 'kittycad.models.export.Export'>, 'model_computed_fields': 'ClassVar[Dict[str, ComputedFieldInfo]]', 'model_config': 'ClassVar[ConfigDict]', 'model_fields': 'ClassVar[Dict[str, FieldInfo]]', 'type': typing.Literal['export']}[source]

classmethod __class_getitem__(typevar_values)[source]

Return type:: type[BaseModel] | PydanticRecursiveRef

__class_vars__: ClassVar[set[str]] = {}[source]: The names of the class variables defined on the model.

__copy__()[source]

Returns a shallow copy of the model.

Return type:: Self

__deepcopy__(memo=None)[source]

Returns a deep copy of the model.

Return type:: Self

__delattr__(item)[source]

Implement delattr(self, name).

Return type:: Any

__dict__[source]

__eq__(other)[source]

Return self==value.

Return type:: bool

property __fields_set__: set[str][source]

classmethod __get_pydantic_core_schema__(source, handler, /)[source]

Hook into generating the model’s CoreSchema.

Parameters:

source (type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.
handler (GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.

Return type:

Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]

Returns:

A pydantic-core CoreSchema.

classmethod __get_pydantic_json_schema__(core_schema, handler, /)[source]

Hook into generating the model’s JSON schema.

Parameters:

core_schema (Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({'type': 'nullable', 'schema': current_schema}), or just call the handler with the original schema.
handler (GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.

Return type:

Returns:

A JSON schema, as a Python object.

__getattr__(item)[source]

Return type:: Any

__getstate__()[source]

Helper for pickle.

Return type:: dict[Any, Any]

__hash__ = None[source]

__init__(**data)[source]

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__iter__()[source]

So dict(model) works.

Return type:: Generator[Tuple[str, Any], None, None]

__module__ = 'kittycad.models.ok_modeling_cmd_response'[source]

__pretty__(fmt, **kwargs)[source]

Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.

Return type:: Generator[Any, None, None]

__private_attributes__: ClassVar[Dict[str, ModelPrivateAttr]] = {}[source]: Metadata about the private attributes of the model.

__pydantic_complete__: ClassVar[bool] = True[source]: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__: ClassVar[CoreSchema] = {'cls': <class 'kittycad.models.ok_modeling_cmd_response.OptionExport'>, 'config': {'title': 'OptionExport'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.ok_modeling_cmd_response.OptionExport'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.ok_modeling_cmd_response.OptionExport'>>]}, 'ref': 'kittycad.models.ok_modeling_cmd_response.OptionExport:94667213205616', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'data': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.export.Export'>, 'config': {'title': 'Export'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.export.Export'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.export.Export'>>]}, 'ref': 'kittycad.models.export.Export:94667206349152', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'files': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'items_schema': {'cls': <class 'kittycad.models.export_file.ExportFile'>, 'config': {'title': 'ExportFile'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.export_file.ExportFile'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.export_file.ExportFile'>>]}, 'ref': 'kittycad.models.export_file.ExportFile:94667206340224', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'contents': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'function': {'function': <bound method Base64Data.validate of <class 'kittycad.models.base64data.Base64Data'>>, 'type': 'no-info'}, 'schema': {'choices': [{'type': 'str'}, {'type': 'bytes'}], 'type': 'union'}, 'serialization': {'function': <bound method Base64Data.serialize of <class 'kittycad.models.base64data.Base64Data'>>, 'type': 'function-plain'}, 'type': 'function-after'}, 'type': 'model-field'}, 'name': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'type': 'str'}, 'type': 'model-field'}}, 'model_name': 'ExportFile', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'list'}, 'type': 'model-field'}}, 'model_name': 'Export', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}, 'type': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': 'export', 'schema': {'expected': ['export'], 'type': 'literal'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'OptionExport', 'type': 'model-fields'}, 'type': 'model'}[source]: The core schema of the model.

__pydantic_custom_init__: ClassVar[bool] = False[source]: Whether the model has a custom __init__ method.

__pydantic_decorators__: ClassVar[_decorators.DecoratorInfos] = DecoratorInfos(validators={}, field_validators={}, root_validators={}, field_serializers={}, model_serializers={}, model_validators={}, computed_fields={})[source]: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_extra__: dict[str, Any] | None[source]: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to 'allow'.

__pydantic_fields_set__: set[str][source]: The names of fields explicitly set during instantiation.

__pydantic_generic_metadata__: ClassVar[_generics.PydanticGenericMetadata] = {'args': (), 'origin': None, 'parameters': ()}[source]: 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.

classmethod __pydantic_init_subclass__(**kwargs)[source]

This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.

This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.

This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.

Parameters:: **kwargs (Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.
Return type:: None

__pydantic_parent_namespace__: ClassVar[Dict[str, Any] | None] = None[source]: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__: ClassVar[None | Literal['model_post_init']] = None[source]: The name of the post-init method for the model, if defined.

__pydantic_private__: dict[str, Any] | None[source]: Values of private attributes set on the model instance.

__pydantic_root_model__: ClassVar[bool] = False[source]: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__: ClassVar[SchemaSerializer] = SchemaSerializer(serializer=Model( ModelSerializer { class: Py( 0x000056196d9d7070, ), serializer: Fields( GeneralFieldsSerializer { fields: { "type": SerField { key_py: Py( 0x00007f903823d958, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f9036ab04e0, ), ), serializer: Literal( LiteralSerializer { expected_int: {}, expected_str: { "export", }, expected_py: None, name: "literal['export']", }, ), }, ), ), required: true, }, "data": SerField { key_py: Py( 0x00007f9038238fa0, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196d34d160, ), serializer: Fields( GeneralFieldsSerializer { fields: { "files": SerField { key_py: Py( 0x00007f90381f1aa0, ), alias: None, alias_py: None, serializer: Some( List( ListSerializer { item_serializer: Model( ModelSerializer { class: Py( 0x000056196d34ae80, ), serializer: Fields( GeneralFieldsSerializer { fields: { "contents": SerField { key_py: Py( 0x00007f90381f5880, ), alias: None, alias_py: None, serializer: Some( Function( FunctionPlainSerializer { func: Py( 0x00007f90339473c0, ), name: "plain_function[serialize]", function_name: "serialize", return_serializer: Any( AnySerializer, ), fallback_serializer: None, when_used: Always, is_field_serializer: false, info_arg: false, }, ), ), required: true, }, "name": SerField { key_py: Py( 0x00007f903823b6b0, ), alias: None, alias_py: None, serializer: Some( Str( StrSerializer, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "ExportFile", }, ), filter: SchemaFilter { include: None, exclude: None, }, name: "list[ExportFile]", }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 1, }, ), has_extra: false, root_model: false, name: "Export", }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "OptionExport", }, ), definitions=[])[source]: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__: ClassVar[SchemaValidator | PluggableSchemaValidator] = SchemaValidator(title="OptionExport", validator=Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "data", lookup_key: Simple { key: "data", py_key: Py( 0x00007f90334d7db0, ), path: LookupPath( [ S( "data", Py( 0x00007f90334d7e10, ), ), ], ), }, name_py: Py( 0x00007f9038238fa0, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "files", lookup_key: Simple { key: "files", py_key: Py( 0x00007f90334d7720, ), path: LookupPath( [ S( "files", Py( 0x00007f90334d7f90, ), ), ], ), }, name_py: Py( 0x00007f90381f1aa0, ), validator: List( ListValidator { strict: false, item_validator: Some( Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "contents", lookup_key: Simple { key: "contents", py_key: Py( 0x00007f9033337770, ), path: LookupPath( [ S( "contents", Py( 0x00007f90333361f0, ), ), ], ), }, name_py: Py( 0x00007f90381f5880, ), validator: FunctionAfter( FunctionAfterValidator { validator: Union( UnionValidator { mode: Smart, choices: [ ( Str( StrValidator { strict: false, coerce_numbers_to_str: false, }, ), None, ), ( Bytes( BytesValidator { strict: false, bytes_mode: ValBytesMode { ser: Utf8, }, }, ), None, ), ], custom_error: None, strict: false, name: "union[str,bytes]", }, ), func: Py( 0x00007f9033947340, ), config: Py( 0x00007f9033524300, ), name: "function-after[validate(), union[str,bytes]]", field_name: None, info_arg: false, }, ), frozen: false, }, Field { name: "name", lookup_key: Simple { key: "name", py_key: Py( 0x00007f90334d7f60, ), path: LookupPath( [ S( "name", Py( 0x00007f90334d7ed0, ), ), ], ), }, name_py: Py( 0x00007f903823b6b0, ), validator: Str( StrValidator { strict: false, coerce_numbers_to_str: false, }, ), frozen: false, }, ], model_name: "ExportFile", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d34ae80, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "ExportFile", }, ), ), min_length: None, max_length: None, name: OnceLock( <uninit>, ), fail_fast: false, }, ), frozen: false, }, ], model_name: "Export", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d34d160, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "Export", }, ), frozen: false, }, Field { name: "type", lookup_key: Simple { key: "type", py_key: Py( 0x00007f90334d7cc0, ), path: LookupPath( [ S( "type", Py( 0x00007f90334d76f0, ), ), ], ), }, name_py: Py( 0x00007f903823d958, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f9036ab04e0, ), ), on_error: Raise, validator: Literal( LiteralValidator { lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "export": 0, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f9036ab04e0, ), ], }, expected_repr: "'export'", name: "literal['export']", }, ), validate_default: false, copy_default: false, name: "default[literal['export']]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "OptionExport", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d9d7070, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "OptionExport", }, ), definitions=[], cache_strings=True)[source]: The pydantic-core SchemaValidator used to validate instances of the model.

__repr__()[source]

Return repr(self).

Return type:: str

__repr_args__()[source]

Return type:: Iterable[tuple[str | None, Any]]

__repr_name__()[source]

Name of the instance’s class, used in __repr__.

Return type:: str

__repr_str__(join_str)[source]

Return type:: str

__rich_repr__()[source]

Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.

Return type:: Iterable[Any | tuple[Any] | tuple[str, Any] | tuple[str, Any, Any]]

__setattr__(name, value)[source]

Implement setattr(self, name, value).

Return type:: None

__setstate__(state)[source]

Return type:: None

__signature__: ClassVar[Signature] = <Signature (*, data: kittycad.models.export.Export, type: Literal['export'] = 'export') -> None>[source]: The synthesized __init__ [Signature][inspect.Signature] of the model.

__slots__ = ('__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__')[source]

__str__()[source]

Return str(self).

Return type:: str

_abc_impl = <_abc._abc_data object>[source]

_calculate_keys(*args, **kwargs)[source]

Return type:: Any

_check_frozen(name, value)[source]

Return type:: None

_copy_and_set_values(*args, **kwargs)[source]

Return type:: Any

classmethod _get_value(*args, **kwargs)[source]

Return type:: Any

_iter(*args, **kwargs)[source]

Return type:: Any

classmethod construct(_fields_set=None, **values)[source]

Return type:: Self

copy(*, include=None, exclude=None, update=None, deep=False)[source]

Returns a copy of the model.

!!! warning “Deprecated”: This method is now deprecated; use model_copy instead.

If you need include or exclude, use:

`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `

Parameters:

include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.

Returns:

A copy of the model with included, excluded and updated fields as specified.

data: Export[source]

dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)[source]

Return type:: Dict[str, Any]

classmethod from_orm(obj)[source]

Return type:: Self

json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)[source]

Return type:: str

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}[source]: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'protected_namespaces': ()}[source]: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod model_construct(_fields_set=None, **values)[source]

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note: model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == 'allow', then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == 'ignore' (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == 'forbid' does not result in an error if extra values are passed, but they will be ignored.

Parameters:

_fields_set (set[str] | None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.
values (Any) – Trusted or pre-validated data dictionary.

Return type:

Self

Returns:

A new instance of the Model class with validated data.

model_copy(*, update=None, deep=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy

Returns a copy of the model.

Parameters:

update (dict[str, Any] | None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.
deep (bool) – Set to True to make a deep copy of the model.

Return type:

Self

Returns:

New model instance.

model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters:

mode (Union[Literal['json', 'python'], str]) – The mode in which to_python 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.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to include in the output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to exclude from the output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to use the field’s alias in the dictionary key if defined.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A dictionary representation of the model.

model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

Generates a JSON representation of the model using Pydantic’s to_json method.

Parameters:

indent (int | None) – Indentation to use in the JSON output. If None is passed, the output will be compact.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to include in the JSON output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to exclude from the JSON output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to serialize using field aliases.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A JSON string representation of the model.

property model_extra: dict[str, Any] | None[source]

Get extra fields set during validation.

Returns:: A dictionary of extra fields, or None if config.extra is not set to "allow".

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=Export, required=True), 'type': FieldInfo(annotation=Literal['export'], required=False, default='export')}[source]

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

property model_fields_set: set[str][source]

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,: i.e. that were not filled from defaults.

classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')[source]

Generates a JSON schema for a model class.

Parameters:

by_alias (bool) – Whether to use attribute aliases or not.
ref_template (str) – The reference template.
schema_generator (type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modifications
mode (Literal['validation', 'serialization']) – The mode in which to generate the schema.

Return type:

Returns:

The JSON schema for the given model class.

classmethod model_parametrized_name(params)[source]

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

Parameters:: params (tuple[type[Any], ...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.
Return type:: str
Returns:: String representing the new class where params are passed to cls as type variables.
Raises:: TypeError – Raised when trying to generate concrete names for non-generic models.

model_post_init(_BaseModel__context)[source]

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

Return type:: None

classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)[source]

Try to rebuild the pydantic-core schema for the model.

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.

Parameters:

force (bool) – Whether to force the rebuilding of the model schema, defaults to False.
raise_errors (bool) – Whether to raise errors, defaults to True.
_parent_namespace_depth (int) – The depth level of the parent namespace, defaults to 2.
_types_namespace (dict[str, Any] | None) – The types namespace, defaults to None.

Return type:

Returns:

Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.

classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)[source]

Validate a pydantic model instance.

Parameters:

obj (Any) – The object to validate.
strict (bool | None) – Whether to enforce types strictly.
from_attributes (bool | None) – Whether to extract data from object attributes.
context (Any | None) – Additional context to pass to the validator.

Raises:

ValidationError – If the object could not be validated.

Return type:

Self

Returns:

The validated model instance.

classmethod model_validate_json(json_data, *, strict=None, context=None)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing

Validate the given JSON data against the Pydantic model.

Parameters:

json_data (str | bytes | bytearray) – The JSON data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

Raises:

ValidationError – If json_data is not a JSON string or the object could not be validated.

classmethod model_validate_strings(obj, *, strict=None, context=None)[source]

Validate the given object with string data against the Pydantic model.

Parameters:

obj (Any) – The object containing string data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod parse_obj(obj)[source]

Return type:: Self

classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod schema(by_alias=True, ref_template='#/$defs/{model}')[source]

Return type:: Dict[str, Any]

classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)[source]

Return type:: str

type: Literal['export'][source]

classmethod update_forward_refs(**localns)[source]

Return type:: None

classmethod validate(value)[source]

Return type:: Self

class kittycad.models.ok_modeling_cmd_response.OptionExtendPath(**data)[source][source]

The response to the ‘ExtendPath’ endpoint

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__abstractmethods__ = frozenset({})[source]

__annotations__ = {'__class_vars__': 'ClassVar[set[str]]', '__private_attributes__': 'ClassVar[Dict[str, ModelPrivateAttr]]', '__pydantic_complete__': 'ClassVar[bool]', '__pydantic_core_schema__': 'ClassVar[CoreSchema]', '__pydantic_custom_init__': 'ClassVar[bool]', '__pydantic_decorators__': 'ClassVar[_decorators.DecoratorInfos]', '__pydantic_extra__': 'dict[str, Any] | None', '__pydantic_fields_set__': 'set[str]', '__pydantic_generic_metadata__': 'ClassVar[_generics.PydanticGenericMetadata]', '__pydantic_parent_namespace__': 'ClassVar[Dict[str, Any] | None]', '__pydantic_post_init__': "ClassVar[None | Literal['model_post_init']]", '__pydantic_private__': 'dict[str, Any] | None', '__pydantic_root_model__': 'ClassVar[bool]', '__pydantic_serializer__': 'ClassVar[SchemaSerializer]', '__pydantic_validator__': 'ClassVar[SchemaValidator | PluggableSchemaValidator]', '__signature__': 'ClassVar[Signature]', 'data': <class 'kittycad.models.extend_path.ExtendPath'>, 'model_computed_fields': 'ClassVar[Dict[str, ComputedFieldInfo]]', 'model_config': 'ClassVar[ConfigDict]', 'model_fields': 'ClassVar[Dict[str, FieldInfo]]', 'type': typing.Literal['extend_path']}[source]

classmethod __class_getitem__(typevar_values)[source]

Return type:: type[BaseModel] | PydanticRecursiveRef

__class_vars__: ClassVar[set[str]] = {}[source]: The names of the class variables defined on the model.

__copy__()[source]

Returns a shallow copy of the model.

Return type:: Self

__deepcopy__(memo=None)[source]

Returns a deep copy of the model.

Return type:: Self

__delattr__(item)[source]

Implement delattr(self, name).

Return type:: Any

__dict__[source]

__eq__(other)[source]

Return self==value.

Return type:: bool

property __fields_set__: set[str][source]

classmethod __get_pydantic_core_schema__(source, handler, /)[source]

Hook into generating the model’s CoreSchema.

Parameters:

source (type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.
handler (GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.

Return type:

Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]

Returns:

A pydantic-core CoreSchema.

classmethod __get_pydantic_json_schema__(core_schema, handler, /)[source]

Hook into generating the model’s JSON schema.

Parameters:

core_schema (Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({'type': 'nullable', 'schema': current_schema}), or just call the handler with the original schema.
handler (GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.

Return type:

Returns:

A JSON schema, as a Python object.

__getattr__(item)[source]

Return type:: Any

__getstate__()[source]

Helper for pickle.

Return type:: dict[Any, Any]

__hash__ = None[source]

__init__(**data)[source]

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__iter__()[source]

So dict(model) works.

Return type:: Generator[Tuple[str, Any], None, None]

__module__ = 'kittycad.models.ok_modeling_cmd_response'[source]

__pretty__(fmt, **kwargs)[source]

Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.

Return type:: Generator[Any, None, None]

__private_attributes__: ClassVar[Dict[str, ModelPrivateAttr]] = {}[source]: Metadata about the private attributes of the model.

__pydantic_complete__: ClassVar[bool] = True[source]: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__: ClassVar[CoreSchema] = {'cls': <class 'kittycad.models.ok_modeling_cmd_response.OptionExtendPath'>, 'config': {'title': 'OptionExtendPath'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.ok_modeling_cmd_response.OptionExtendPath'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.ok_modeling_cmd_response.OptionExtendPath'>>]}, 'ref': 'kittycad.models.ok_modeling_cmd_response.OptionExtendPath:94667212720112', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'data': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.extend_path.ExtendPath'>, 'config': {'title': 'ExtendPath'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.extend_path.ExtendPath'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.extend_path.ExtendPath'>>]}, 'ref': 'kittycad.models.extend_path.ExtendPath:94667206361808', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {}, 'model_name': 'ExtendPath', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}, 'type': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': 'extend_path', 'schema': {'expected': ['extend_path'], 'type': 'literal'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'OptionExtendPath', 'type': 'model-fields'}, 'type': 'model'}[source]: The core schema of the model.

__pydantic_custom_init__: ClassVar[bool] = False[source]: Whether the model has a custom __init__ method.

__pydantic_decorators__: ClassVar[_decorators.DecoratorInfos] = DecoratorInfos(validators={}, field_validators={}, root_validators={}, field_serializers={}, model_serializers={}, model_validators={}, computed_fields={})[source]: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_extra__: dict[str, Any] | None[source]: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to 'allow'.

__pydantic_fields_set__: set[str][source]: The names of fields explicitly set during instantiation.

__pydantic_generic_metadata__: ClassVar[_generics.PydanticGenericMetadata] = {'args': (), 'origin': None, 'parameters': ()}[source]: 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.

classmethod __pydantic_init_subclass__(**kwargs)[source]

This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.

This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.

This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.

Parameters:: **kwargs (Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.
Return type:: None

__pydantic_parent_namespace__: ClassVar[Dict[str, Any] | None] = None[source]: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__: ClassVar[None | Literal['model_post_init']] = None[source]: The name of the post-init method for the model, if defined.

__pydantic_private__: dict[str, Any] | None[source]: Values of private attributes set on the model instance.

__pydantic_root_model__: ClassVar[bool] = False[source]: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__: ClassVar[SchemaSerializer] = SchemaSerializer(serializer=Model( ModelSerializer { class: Py( 0x000056196d9607f0, ), serializer: Fields( GeneralFieldsSerializer { fields: { "data": SerField { key_py: Py( 0x00007f9038238fa0, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196d3502d0, ), serializer: Fields( GeneralFieldsSerializer { fields: {}, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 0, }, ), has_extra: false, root_model: false, name: "ExtendPath", }, ), ), required: true, }, "type": SerField { key_py: Py( 0x00007f903823d958, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f9034fbc130, ), ), serializer: Literal( LiteralSerializer { expected_int: {}, expected_str: { "extend_path", }, expected_py: None, name: "literal['extend_path']", }, ), }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "OptionExtendPath", }, ), definitions=[])[source]: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__: ClassVar[SchemaValidator | PluggableSchemaValidator] = SchemaValidator(title="OptionExtendPath", validator=Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "data", lookup_key: Simple { key: "data", py_key: Py( 0x00007f90336063a0, ), path: LookupPath( [ S( "data", Py( 0x00007f9033606010, ), ), ], ), }, name_py: Py( 0x00007f9038238fa0, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [], model_name: "ExtendPath", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d3502d0, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "ExtendPath", }, ), frozen: false, }, Field { name: "type", lookup_key: Simple { key: "type", py_key: Py( 0x00007f9033606070, ), path: LookupPath( [ S( "type", Py( 0x00007f9033606040, ), ), ], ), }, name_py: Py( 0x00007f903823d958, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f9034fbc130, ), ), on_error: Raise, validator: Literal( LiteralValidator { lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "extend_path": 0, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f9034fbc130, ), ], }, expected_repr: "'extend_path'", name: "literal['extend_path']", }, ), validate_default: false, copy_default: false, name: "default[literal['extend_path']]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "OptionExtendPath", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d9607f0, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "OptionExtendPath", }, ), definitions=[], cache_strings=True)[source]: The pydantic-core SchemaValidator used to validate instances of the model.

__repr__()[source]

Return repr(self).

Return type:: str

__repr_args__()[source]

Return type:: Iterable[tuple[str | None, Any]]

__repr_name__()[source]

Name of the instance’s class, used in __repr__.

Return type:: str

__repr_str__(join_str)[source]

Return type:: str

__rich_repr__()[source]

Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.

Return type:: Iterable[Any | tuple[Any] | tuple[str, Any] | tuple[str, Any, Any]]

__setattr__(name, value)[source]

Implement setattr(self, name, value).

Return type:: None

__setstate__(state)[source]

Return type:: None

__signature__: ClassVar[Signature] = <Signature (*, data: kittycad.models.extend_path.ExtendPath, type: Literal['extend_path'] = 'extend_path') -> None>[source]: The synthesized __init__ [Signature][inspect.Signature] of the model.

__slots__ = ('__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__')[source]

__str__()[source]

Return str(self).

Return type:: str

_abc_impl = <_abc._abc_data object>[source]

_calculate_keys(*args, **kwargs)[source]

Return type:: Any

_check_frozen(name, value)[source]

Return type:: None

_copy_and_set_values(*args, **kwargs)[source]

Return type:: Any

classmethod _get_value(*args, **kwargs)[source]

Return type:: Any

_iter(*args, **kwargs)[source]

Return type:: Any

classmethod construct(_fields_set=None, **values)[source]

Return type:: Self

copy(*, include=None, exclude=None, update=None, deep=False)[source]

Returns a copy of the model.

!!! warning “Deprecated”: This method is now deprecated; use model_copy instead.

If you need include or exclude, use:

`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `

Parameters:

include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.

Returns:

A copy of the model with included, excluded and updated fields as specified.

data: ExtendPath[source]

dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)[source]

Return type:: Dict[str, Any]

classmethod from_orm(obj)[source]

Return type:: Self

json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)[source]

Return type:: str

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}[source]: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'protected_namespaces': ()}[source]: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod model_construct(_fields_set=None, **values)[source]

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note: model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == 'allow', then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == 'ignore' (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == 'forbid' does not result in an error if extra values are passed, but they will be ignored.

Parameters:

_fields_set (set[str] | None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.
values (Any) – Trusted or pre-validated data dictionary.

Return type:

Self

Returns:

A new instance of the Model class with validated data.

model_copy(*, update=None, deep=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy

Returns a copy of the model.

Parameters:

update (dict[str, Any] | None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.
deep (bool) – Set to True to make a deep copy of the model.

Return type:

Self

Returns:

New model instance.

model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters:

mode (Union[Literal['json', 'python'], str]) – The mode in which to_python 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.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to include in the output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to exclude from the output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to use the field’s alias in the dictionary key if defined.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A dictionary representation of the model.

model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

Generates a JSON representation of the model using Pydantic’s to_json method.

Parameters:

indent (int | None) – Indentation to use in the JSON output. If None is passed, the output will be compact.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to include in the JSON output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to exclude from the JSON output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to serialize using field aliases.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A JSON string representation of the model.

property model_extra: dict[str, Any] | None[source]

Get extra fields set during validation.

Returns:: A dictionary of extra fields, or None if config.extra is not set to "allow".

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=ExtendPath, required=True), 'type': FieldInfo(annotation=Literal['extend_path'], required=False, default='extend_path')}[source]

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

property model_fields_set: set[str][source]

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,: i.e. that were not filled from defaults.

classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')[source]

Generates a JSON schema for a model class.

Parameters:

by_alias (bool) – Whether to use attribute aliases or not.
ref_template (str) – The reference template.
schema_generator (type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modifications
mode (Literal['validation', 'serialization']) – The mode in which to generate the schema.

Return type:

Returns:

The JSON schema for the given model class.

classmethod model_parametrized_name(params)[source]

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

Parameters:: params (tuple[type[Any], ...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.
Return type:: str
Returns:: String representing the new class where params are passed to cls as type variables.
Raises:: TypeError – Raised when trying to generate concrete names for non-generic models.

model_post_init(_BaseModel__context)[source]

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

Return type:: None

classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)[source]

Try to rebuild the pydantic-core schema for the model.

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.

Parameters:

force (bool) – Whether to force the rebuilding of the model schema, defaults to False.
raise_errors (bool) – Whether to raise errors, defaults to True.
_parent_namespace_depth (int) – The depth level of the parent namespace, defaults to 2.
_types_namespace (dict[str, Any] | None) – The types namespace, defaults to None.

Return type:

Returns:

Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.

classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)[source]

Validate a pydantic model instance.

Parameters:

obj (Any) – The object to validate.
strict (bool | None) – Whether to enforce types strictly.
from_attributes (bool | None) – Whether to extract data from object attributes.
context (Any | None) – Additional context to pass to the validator.

Raises:

ValidationError – If the object could not be validated.

Return type:

Self

Returns:

The validated model instance.

classmethod model_validate_json(json_data, *, strict=None, context=None)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing

Validate the given JSON data against the Pydantic model.

Parameters:

json_data (str | bytes | bytearray) – The JSON data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

Raises:

ValidationError – If json_data is not a JSON string or the object could not be validated.

classmethod model_validate_strings(obj, *, strict=None, context=None)[source]

Validate the given object with string data against the Pydantic model.

Parameters:

obj (Any) – The object containing string data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod parse_obj(obj)[source]

Return type:: Self

classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod schema(by_alias=True, ref_template='#/$defs/{model}')[source]

Return type:: Dict[str, Any]

classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)[source]

Return type:: str

type: Literal['extend_path'][source]

classmethod update_forward_refs(**localns)[source]

Return type:: None

classmethod validate(value)[source]

Return type:: Self

class kittycad.models.ok_modeling_cmd_response.OptionExtrude(**data)[source][source]

The response to the ‘Extrude’ endpoint

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__abstractmethods__ = frozenset({})[source]

__annotations__ = {'__class_vars__': 'ClassVar[set[str]]', '__private_attributes__': 'ClassVar[Dict[str, ModelPrivateAttr]]', '__pydantic_complete__': 'ClassVar[bool]', '__pydantic_core_schema__': 'ClassVar[CoreSchema]', '__pydantic_custom_init__': 'ClassVar[bool]', '__pydantic_decorators__': 'ClassVar[_decorators.DecoratorInfos]', '__pydantic_extra__': 'dict[str, Any] | None', '__pydantic_fields_set__': 'set[str]', '__pydantic_generic_metadata__': 'ClassVar[_generics.PydanticGenericMetadata]', '__pydantic_parent_namespace__': 'ClassVar[Dict[str, Any] | None]', '__pydantic_post_init__': "ClassVar[None | Literal['model_post_init']]", '__pydantic_private__': 'dict[str, Any] | None', '__pydantic_root_model__': 'ClassVar[bool]', '__pydantic_serializer__': 'ClassVar[SchemaSerializer]', '__pydantic_validator__': 'ClassVar[SchemaValidator | PluggableSchemaValidator]', '__signature__': 'ClassVar[Signature]', 'data': <class 'kittycad.models.extrude.Extrude'>, 'model_computed_fields': 'ClassVar[Dict[str, ComputedFieldInfo]]', 'model_config': 'ClassVar[ConfigDict]', 'model_fields': 'ClassVar[Dict[str, FieldInfo]]', 'type': typing.Literal['extrude']}[source]

classmethod __class_getitem__(typevar_values)[source]

Return type:: type[BaseModel] | PydanticRecursiveRef

__class_vars__: ClassVar[set[str]] = {}[source]: The names of the class variables defined on the model.

__copy__()[source]

Returns a shallow copy of the model.

Return type:: Self

__deepcopy__(memo=None)[source]

Returns a deep copy of the model.

Return type:: Self

__delattr__(item)[source]

Implement delattr(self, name).

Return type:: Any

__dict__[source]

__eq__(other)[source]

Return self==value.

Return type:: bool

property __fields_set__: set[str][source]

classmethod __get_pydantic_core_schema__(source, handler, /)[source]

Hook into generating the model’s CoreSchema.

Parameters:

source (type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.
handler (GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.

Return type:

Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]

Returns:

A pydantic-core CoreSchema.

classmethod __get_pydantic_json_schema__(core_schema, handler, /)[source]

Hook into generating the model’s JSON schema.

Parameters:

core_schema (Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({'type': 'nullable', 'schema': current_schema}), or just call the handler with the original schema.
handler (GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.

Return type:

Returns:

A JSON schema, as a Python object.

__getattr__(item)[source]

Return type:: Any

__getstate__()[source]

Helper for pickle.

Return type:: dict[Any, Any]

__hash__ = None[source]

__init__(**data)[source]

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__iter__()[source]

So dict(model) works.

Return type:: Generator[Tuple[str, Any], None, None]

__module__ = 'kittycad.models.ok_modeling_cmd_response'[source]

__pretty__(fmt, **kwargs)[source]

Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.

Return type:: Generator[Any, None, None]

__private_attributes__: ClassVar[Dict[str, ModelPrivateAttr]] = {}[source]: Metadata about the private attributes of the model.

__pydantic_complete__: ClassVar[bool] = True[source]: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__: ClassVar[CoreSchema] = {'cls': <class 'kittycad.models.ok_modeling_cmd_response.OptionExtrude'>, 'config': {'title': 'OptionExtrude'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.ok_modeling_cmd_response.OptionExtrude'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.ok_modeling_cmd_response.OptionExtrude'>>]}, 'ref': 'kittycad.models.ok_modeling_cmd_response.OptionExtrude:94667212728992', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'data': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.extrude.Extrude'>, 'config': {'title': 'Extrude'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.extrude.Extrude'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.extrude.Extrude'>>]}, 'ref': 'kittycad.models.extrude.Extrude:94667206482928', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {}, 'model_name': 'Extrude', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}, 'type': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': 'extrude', 'schema': {'expected': ['extrude'], 'type': 'literal'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'OptionExtrude', 'type': 'model-fields'}, 'type': 'model'}[source]: The core schema of the model.

__pydantic_custom_init__: ClassVar[bool] = False[source]: Whether the model has a custom __init__ method.

__pydantic_decorators__: ClassVar[_decorators.DecoratorInfos] = DecoratorInfos(validators={}, field_validators={}, root_validators={}, field_serializers={}, model_serializers={}, model_validators={}, computed_fields={})[source]: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_extra__: dict[str, Any] | None[source]: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to 'allow'.

__pydantic_fields_set__: set[str][source]: The names of fields explicitly set during instantiation.

__pydantic_generic_metadata__: ClassVar[_generics.PydanticGenericMetadata] = {'args': (), 'origin': None, 'parameters': ()}[source]: 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.

classmethod __pydantic_init_subclass__(**kwargs)[source]

This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.

This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.

This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.

Parameters:: **kwargs (Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.
Return type:: None

__pydantic_parent_namespace__: ClassVar[Dict[str, Any] | None] = None[source]: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__: ClassVar[None | Literal['model_post_init']] = None[source]: The name of the post-init method for the model, if defined.

__pydantic_private__: dict[str, Any] | None[source]: Values of private attributes set on the model instance.

__pydantic_root_model__: ClassVar[bool] = False[source]: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__: ClassVar[SchemaSerializer] = SchemaSerializer(serializer=Model( ModelSerializer { class: Py( 0x000056196d962aa0, ), serializer: Fields( GeneralFieldsSerializer { fields: { "type": SerField { key_py: Py( 0x00007f903823d958, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f9034acce10, ), ), serializer: Literal( LiteralSerializer { expected_int: {}, expected_str: { "extrude", }, expected_py: None, name: "literal['extrude']", }, ), }, ), ), required: true, }, "data": SerField { key_py: Py( 0x00007f9038238fa0, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196d36dbf0, ), serializer: Fields( GeneralFieldsSerializer { fields: {}, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 0, }, ), has_extra: false, root_model: false, name: "Extrude", }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "OptionExtrude", }, ), definitions=[])[source]: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__: ClassVar[SchemaValidator | PluggableSchemaValidator] = SchemaValidator(title="OptionExtrude", validator=Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "data", lookup_key: Simple { key: "data", py_key: Py( 0x00007f9033604900, ), path: LookupPath( [ S( "data", Py( 0x00007f9033604ed0, ), ), ], ), }, name_py: Py( 0x00007f9038238fa0, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [], model_name: "Extrude", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d36dbf0, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "Extrude", }, ), frozen: false, }, Field { name: "type", lookup_key: Simple { key: "type", py_key: Py( 0x00007f9033604e40, ), path: LookupPath( [ S( "type", Py( 0x00007f9033604e70, ), ), ], ), }, name_py: Py( 0x00007f903823d958, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f9034acce10, ), ), on_error: Raise, validator: Literal( LiteralValidator { lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "extrude": 0, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f9034acce10, ), ], }, expected_repr: "'extrude'", name: "literal['extrude']", }, ), validate_default: false, copy_default: false, name: "default[literal['extrude']]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "OptionExtrude", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d962aa0, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "OptionExtrude", }, ), definitions=[], cache_strings=True)[source]: The pydantic-core SchemaValidator used to validate instances of the model.

__repr__()[source]

Return repr(self).

Return type:: str

__repr_args__()[source]

Return type:: Iterable[tuple[str | None, Any]]

__repr_name__()[source]

Name of the instance’s class, used in __repr__.

Return type:: str

__repr_str__(join_str)[source]

Return type:: str

__rich_repr__()[source]

Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.

Return type:: Iterable[Any | tuple[Any] | tuple[str, Any] | tuple[str, Any, Any]]

__setattr__(name, value)[source]

Implement setattr(self, name, value).

Return type:: None

__setstate__(state)[source]

Return type:: None

__signature__: ClassVar[Signature] = <Signature (*, data: kittycad.models.extrude.Extrude, type: Literal['extrude'] = 'extrude') -> None>[source]: The synthesized __init__ [Signature][inspect.Signature] of the model.

__slots__ = ('__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__')[source]

__str__()[source]

Return str(self).

Return type:: str

_abc_impl = <_abc._abc_data object>[source]

_calculate_keys(*args, **kwargs)[source]

Return type:: Any

_check_frozen(name, value)[source]

Return type:: None

_copy_and_set_values(*args, **kwargs)[source]

Return type:: Any

classmethod _get_value(*args, **kwargs)[source]

Return type:: Any

_iter(*args, **kwargs)[source]

Return type:: Any

classmethod construct(_fields_set=None, **values)[source]

Return type:: Self

copy(*, include=None, exclude=None, update=None, deep=False)[source]

Returns a copy of the model.

!!! warning “Deprecated”: This method is now deprecated; use model_copy instead.

If you need include or exclude, use:

`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `

Parameters:

include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.

Returns:

A copy of the model with included, excluded and updated fields as specified.

data: Extrude[source]

dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)[source]

Return type:: Dict[str, Any]

classmethod from_orm(obj)[source]

Return type:: Self

json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)[source]

Return type:: str

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}[source]: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'protected_namespaces': ()}[source]: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod model_construct(_fields_set=None, **values)[source]

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note: model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == 'allow', then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == 'ignore' (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == 'forbid' does not result in an error if extra values are passed, but they will be ignored.

Parameters:

_fields_set (set[str] | None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.
values (Any) – Trusted or pre-validated data dictionary.

Return type:

Self

Returns:

A new instance of the Model class with validated data.

model_copy(*, update=None, deep=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy

Returns a copy of the model.

Parameters:

update (dict[str, Any] | None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.
deep (bool) – Set to True to make a deep copy of the model.

Return type:

Self

Returns:

New model instance.

model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters:

mode (Union[Literal['json', 'python'], str]) – The mode in which to_python 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.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to include in the output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to exclude from the output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to use the field’s alias in the dictionary key if defined.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A dictionary representation of the model.

model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

Generates a JSON representation of the model using Pydantic’s to_json method.

Parameters:

indent (int | None) – Indentation to use in the JSON output. If None is passed, the output will be compact.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to include in the JSON output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to exclude from the JSON output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to serialize using field aliases.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A JSON string representation of the model.

property model_extra: dict[str, Any] | None[source]

Get extra fields set during validation.

Returns:: A dictionary of extra fields, or None if config.extra is not set to "allow".

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=Extrude, required=True), 'type': FieldInfo(annotation=Literal['extrude'], required=False, default='extrude')}[source]

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

property model_fields_set: set[str][source]

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,: i.e. that were not filled from defaults.

classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')[source]

Generates a JSON schema for a model class.

Parameters:

by_alias (bool) – Whether to use attribute aliases or not.
ref_template (str) – The reference template.
schema_generator (type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modifications
mode (Literal['validation', 'serialization']) – The mode in which to generate the schema.

Return type:

Returns:

The JSON schema for the given model class.

classmethod model_parametrized_name(params)[source]

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

Parameters:: params (tuple[type[Any], ...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.
Return type:: str
Returns:: String representing the new class where params are passed to cls as type variables.
Raises:: TypeError – Raised when trying to generate concrete names for non-generic models.

model_post_init(_BaseModel__context)[source]

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

Return type:: None

classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)[source]

Try to rebuild the pydantic-core schema for the model.

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.

Parameters:

force (bool) – Whether to force the rebuilding of the model schema, defaults to False.
raise_errors (bool) – Whether to raise errors, defaults to True.
_parent_namespace_depth (int) – The depth level of the parent namespace, defaults to 2.
_types_namespace (dict[str, Any] | None) – The types namespace, defaults to None.

Return type:

Returns:

Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.

classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)[source]

Validate a pydantic model instance.

Parameters:

obj (Any) – The object to validate.
strict (bool | None) – Whether to enforce types strictly.
from_attributes (bool | None) – Whether to extract data from object attributes.
context (Any | None) – Additional context to pass to the validator.

Raises:

ValidationError – If the object could not be validated.

Return type:

Self

Returns:

The validated model instance.

classmethod model_validate_json(json_data, *, strict=None, context=None)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing

Validate the given JSON data against the Pydantic model.

Parameters:

json_data (str | bytes | bytearray) – The JSON data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

Raises:

ValidationError – If json_data is not a JSON string or the object could not be validated.

classmethod model_validate_strings(obj, *, strict=None, context=None)[source]

Validate the given object with string data against the Pydantic model.

Parameters:

obj (Any) – The object containing string data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod parse_obj(obj)[source]

Return type:: Self

classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod schema(by_alias=True, ref_template='#/$defs/{model}')[source]

Return type:: Dict[str, Any]

classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)[source]

Return type:: str

type: Literal['extrude'][source]

classmethod update_forward_refs(**localns)[source]

Return type:: None

classmethod validate(value)[source]

Return type:: Self

class kittycad.models.ok_modeling_cmd_response.OptionExtrusionFaceInfo(**data)[source][source]

The response to the ‘ExtrusionFaceInfo’ endpoint

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__abstractmethods__ = frozenset({})[source]

__annotations__ = {'__class_vars__': 'ClassVar[set[str]]', '__private_attributes__': 'ClassVar[Dict[str, ModelPrivateAttr]]', '__pydantic_complete__': 'ClassVar[bool]', '__pydantic_core_schema__': 'ClassVar[CoreSchema]', '__pydantic_custom_init__': 'ClassVar[bool]', '__pydantic_decorators__': 'ClassVar[_decorators.DecoratorInfos]', '__pydantic_extra__': 'dict[str, Any] | None', '__pydantic_fields_set__': 'set[str]', '__pydantic_generic_metadata__': 'ClassVar[_generics.PydanticGenericMetadata]', '__pydantic_parent_namespace__': 'ClassVar[Dict[str, Any] | None]', '__pydantic_post_init__': "ClassVar[None | Literal['model_post_init']]", '__pydantic_private__': 'dict[str, Any] | None', '__pydantic_root_model__': 'ClassVar[bool]', '__pydantic_serializer__': 'ClassVar[SchemaSerializer]', '__pydantic_validator__': 'ClassVar[SchemaValidator | PluggableSchemaValidator]', '__signature__': 'ClassVar[Signature]', 'data': <class 'kittycad.models.extrusion_face_info.ExtrusionFaceInfo'>, 'model_computed_fields': 'ClassVar[Dict[str, ComputedFieldInfo]]', 'model_config': 'ClassVar[ConfigDict]', 'model_fields': 'ClassVar[Dict[str, FieldInfo]]', 'type': typing.Literal['extrusion_face_info']}[source]

classmethod __class_getitem__(typevar_values)[source]

Return type:: type[BaseModel] | PydanticRecursiveRef

__class_vars__: ClassVar[set[str]] = {}[source]: The names of the class variables defined on the model.

__copy__()[source]

Returns a shallow copy of the model.

Return type:: Self

__deepcopy__(memo=None)[source]

Returns a deep copy of the model.

Return type:: Self

__delattr__(item)[source]

Implement delattr(self, name).

Return type:: Any

__dict__[source]

__eq__(other)[source]

Return self==value.

Return type:: bool

property __fields_set__: set[str][source]

classmethod __get_pydantic_core_schema__(source, handler, /)[source]

Hook into generating the model’s CoreSchema.

Parameters:

source (type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.
handler (GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.

Return type:

Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]

Returns:

A pydantic-core CoreSchema.

classmethod __get_pydantic_json_schema__(core_schema, handler, /)[source]

Hook into generating the model’s JSON schema.

Parameters:

core_schema (Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({'type': 'nullable', 'schema': current_schema}), or just call the handler with the original schema.
handler (GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.

Return type:

Returns:

A JSON schema, as a Python object.

__getattr__(item)[source]

Return type:: Any

__getstate__()[source]

Helper for pickle.

Return type:: dict[Any, Any]

__hash__ = None[source]

__init__(**data)[source]

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__iter__()[source]

So dict(model) works.

Return type:: Generator[Tuple[str, Any], None, None]

__module__ = 'kittycad.models.ok_modeling_cmd_response'[source]

__pretty__(fmt, **kwargs)[source]

Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.

Return type:: Generator[Any, None, None]

__private_attributes__: ClassVar[Dict[str, ModelPrivateAttr]] = {}[source]: Metadata about the private attributes of the model.

__pydantic_complete__: ClassVar[bool] = True[source]: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__: ClassVar[CoreSchema] = {'cls': <class 'kittycad.models.ok_modeling_cmd_response.OptionExtrusionFaceInfo'>, 'config': {'title': 'OptionExtrusionFaceInfo'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.ok_modeling_cmd_response.OptionExtrusionFaceInfo'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.ok_modeling_cmd_response.OptionExtrusionFaceInfo'>>]}, 'ref': 'kittycad.models.ok_modeling_cmd_response.OptionExtrusionFaceInfo:94667214102352', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'data': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.extrusion_face_info.ExtrusionFaceInfo'>, 'config': {'title': 'ExtrusionFaceInfo'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.extrusion_face_info.ExtrusionFaceInfo'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.extrusion_face_info.ExtrusionFaceInfo'>>]}, 'ref': 'kittycad.models.extrusion_face_info.ExtrusionFaceInfo:94667206504032', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'cap': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <enum 'ExtrusionFaceCapType'>, 'members': [ExtrusionFaceCapType.NONE, ExtrusionFaceCapType.TOP, ExtrusionFaceCapType.BOTTOM], 'metadata': {'pydantic_js_functions': [<function GenerateSchema._enum_schema.<locals>.get_json_schema>]}, 'ref': 'kittycad.models.extrusion_face_cap_type.ExtrusionFaceCapType:94667206501088', 'sub_type': 'str', 'type': 'enum'}, 'type': 'model-field'}, 'curve_id': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': None, 'schema': {'schema': {'type': 'str'}, 'type': 'nullable'}, 'type': 'default'}, 'type': 'model-field'}, 'face_id': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': None, 'schema': {'schema': {'type': 'str'}, 'type': 'nullable'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'ExtrusionFaceInfo', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}, 'type': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': 'extrusion_face_info', 'schema': {'expected': ['extrusion_face_info'], 'type': 'literal'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'OptionExtrusionFaceInfo', 'type': 'model-fields'}, 'type': 'model'}[source]: The core schema of the model.

__pydantic_custom_init__: ClassVar[bool] = False[source]: Whether the model has a custom __init__ method.

__pydantic_decorators__: ClassVar[_decorators.DecoratorInfos] = DecoratorInfos(validators={}, field_validators={}, root_validators={}, field_serializers={}, model_serializers={}, model_validators={}, computed_fields={})[source]: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_extra__: dict[str, Any] | None[source]: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to 'allow'.

__pydantic_fields_set__: set[str][source]: The names of fields explicitly set during instantiation.

__pydantic_generic_metadata__: ClassVar[_generics.PydanticGenericMetadata] = {'args': (), 'origin': None, 'parameters': ()}[source]: 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.

classmethod __pydantic_init_subclass__(**kwargs)[source]

This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.

This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.

This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.

Parameters:: **kwargs (Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.
Return type:: None

__pydantic_parent_namespace__: ClassVar[Dict[str, Any] | None] = None[source]: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__: ClassVar[None | Literal['model_post_init']] = None[source]: The name of the post-init method for the model, if defined.

__pydantic_private__: dict[str, Any] | None[source]: Values of private attributes set on the model instance.

__pydantic_root_model__: ClassVar[bool] = False[source]: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__: ClassVar[SchemaSerializer] = SchemaSerializer(serializer=Model( ModelSerializer { class: Py( 0x000056196dab1f50, ), serializer: Fields( GeneralFieldsSerializer { fields: { "type": SerField { key_py: Py( 0x00007f903823d958, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f90347d42f0, ), ), serializer: Literal( LiteralSerializer { expected_int: {}, expected_str: { "extrusion_face_info", }, expected_py: None, name: "literal['extrusion_face_info']", }, ), }, ), ), required: true, }, "data": SerField { key_py: Py( 0x00007f9038238fa0, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196d372e60, ), serializer: Fields( GeneralFieldsSerializer { fields: { "face_id": SerField { key_py: Py( 0x00007f9033e20420, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f9038148100, ), ), serializer: Nullable( NullableSerializer { serializer: Str( StrSerializer, ), }, ), }, ), ), required: true, }, "cap": SerField { key_py: Py( 0x00007f90361ae2e0, ), alias: None, alias_py: None, serializer: Some( Enum( EnumSerializer { class: Py( 0x000056196d3722e0, ), serializer: Some( Str( StrSerializer, ), ), }, ), ), required: true, }, "curve_id": SerField { key_py: Py( 0x00007f90339660f0, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f9038148100, ), ), serializer: Nullable( NullableSerializer { serializer: Str( StrSerializer, ), }, ), }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 3, }, ), has_extra: false, root_model: false, name: "ExtrusionFaceInfo", }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "OptionExtrusionFaceInfo", }, ), definitions=[])[source]: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__: ClassVar[SchemaValidator | PluggableSchemaValidator] = SchemaValidator(title="OptionExtrusionFaceInfo", validator=Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "data", lookup_key: Simple { key: "data", py_key: Py( 0x00007f90333a9230, ), path: LookupPath( [ S( "data", Py( 0x00007f90333a9200, ), ), ], ), }, name_py: Py( 0x00007f9038238fa0, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "cap", lookup_key: Simple { key: "cap", py_key: Py( 0x00007f90333a8a50, ), path: LookupPath( [ S( "cap", Py( 0x00007f90333a8150, ), ), ], ), }, name_py: Py( 0x00007f90361ae2e0, ), validator: StrEnum( EnumValidator { phantom: PhantomData<_pydantic_core::validators::enum_::StrEnumValidator>, class: Py( 0x000056196d3722e0, ), lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "none": 0, "top": 1, "bottom": 2, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f903392d430, ), Py( 0x00007f903392d490, ), Py( 0x00007f903392d4f0, ), ], }, missing: None, expected_repr: "'none', 'top' or 'bottom'", strict: false, class_repr: "ExtrusionFaceCapType", name: "str-enum[ExtrusionFaceCapType]", }, ), frozen: false, }, Field { name: "curve_id", lookup_key: Simple { key: "curve_id", py_key: Py( 0x00007f90333e3b70, ), path: LookupPath( [ S( "curve_id", Py( 0x00007f90333e3b30, ), ), ], ), }, name_py: Py( 0x00007f90339660f0, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f9038148100, ), ), on_error: Raise, validator: Nullable( NullableValidator { validator: Str( StrValidator { strict: false, coerce_numbers_to_str: false, }, ), name: "nullable[str]", }, ), validate_default: false, copy_default: false, name: "default[nullable[str]]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, Field { name: "face_id", lookup_key: Simple { key: "face_id", py_key: Py( 0x00007f90333a8420, ), path: LookupPath( [ S( "face_id", Py( 0x00007f90333a81b0, ), ), ], ), }, name_py: Py( 0x00007f9033e20420, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f9038148100, ), ), on_error: Raise, validator: Nullable( NullableValidator { validator: Str( StrValidator { strict: false, coerce_numbers_to_str: false, }, ), name: "nullable[str]", }, ), validate_default: false, copy_default: false, name: "default[nullable[str]]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "ExtrusionFaceInfo", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d372e60, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "ExtrusionFaceInfo", }, ), frozen: false, }, Field { name: "type", lookup_key: Simple { key: "type", py_key: Py( 0x00007f90333a88d0, ), path: LookupPath( [ S( "type", Py( 0x00007f90333a9140, ), ), ], ), }, name_py: Py( 0x00007f903823d958, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f90347d42f0, ), ), on_error: Raise, validator: Literal( LiteralValidator { lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "extrusion_face_info": 0, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f90347d42f0, ), ], }, expected_repr: "'extrusion_face_info'", name: "literal['extrusion_face_info']", }, ), validate_default: false, copy_default: false, name: "default[literal['extrusion_face_info']]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "OptionExtrusionFaceInfo", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196dab1f50, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "OptionExtrusionFaceInfo", }, ), definitions=[], cache_strings=True)[source]: The pydantic-core SchemaValidator used to validate instances of the model.

__repr__()[source]

Return repr(self).

Return type:: str

__repr_args__()[source]

Return type:: Iterable[tuple[str | None, Any]]

__repr_name__()[source]

Name of the instance’s class, used in __repr__.

Return type:: str

__repr_str__(join_str)[source]

Return type:: str

__rich_repr__()[source]

Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.

Return type:: Iterable[Any | tuple[Any] | tuple[str, Any] | tuple[str, Any, Any]]

__setattr__(name, value)[source]

Implement setattr(self, name, value).

Return type:: None

__setstate__(state)[source]

Return type:: None

__signature__: ClassVar[Signature] = <Signature (*, data: kittycad.models.extrusion_face_info.ExtrusionFaceInfo, type: Literal['extrusion_face_info'] = 'extrusion_face_info') -> None>[source]: The synthesized __init__ [Signature][inspect.Signature] of the model.

__slots__ = ('__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__')[source]

__str__()[source]

Return str(self).

Return type:: str

_abc_impl = <_abc._abc_data object>[source]

_calculate_keys(*args, **kwargs)[source]

Return type:: Any

_check_frozen(name, value)[source]

Return type:: None

_copy_and_set_values(*args, **kwargs)[source]

Return type:: Any

classmethod _get_value(*args, **kwargs)[source]

Return type:: Any

_iter(*args, **kwargs)[source]

Return type:: Any

classmethod construct(_fields_set=None, **values)[source]

Return type:: Self

copy(*, include=None, exclude=None, update=None, deep=False)[source]

Returns a copy of the model.

!!! warning “Deprecated”: This method is now deprecated; use model_copy instead.

If you need include or exclude, use:

`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `

Parameters:

include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.

Returns:

A copy of the model with included, excluded and updated fields as specified.

data: ExtrusionFaceInfo[source]

dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)[source]

Return type:: Dict[str, Any]

classmethod from_orm(obj)[source]

Return type:: Self

json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)[source]

Return type:: str

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}[source]: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'protected_namespaces': ()}[source]: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod model_construct(_fields_set=None, **values)[source]

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note: model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == 'allow', then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == 'ignore' (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == 'forbid' does not result in an error if extra values are passed, but they will be ignored.

Parameters:

_fields_set (set[str] | None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.
values (Any) – Trusted or pre-validated data dictionary.

Return type:

Self

Returns:

A new instance of the Model class with validated data.

model_copy(*, update=None, deep=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy

Returns a copy of the model.

Parameters:

update (dict[str, Any] | None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.
deep (bool) – Set to True to make a deep copy of the model.

Return type:

Self

Returns:

New model instance.

model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters:

mode (Union[Literal['json', 'python'], str]) – The mode in which to_python 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.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to include in the output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to exclude from the output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to use the field’s alias in the dictionary key if defined.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A dictionary representation of the model.

model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

Generates a JSON representation of the model using Pydantic’s to_json method.

Parameters:

indent (int | None) – Indentation to use in the JSON output. If None is passed, the output will be compact.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to include in the JSON output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to exclude from the JSON output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to serialize using field aliases.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A JSON string representation of the model.

property model_extra: dict[str, Any] | None[source]

Get extra fields set during validation.

Returns:: A dictionary of extra fields, or None if config.extra is not set to "allow".

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=ExtrusionFaceInfo, required=True), 'type': FieldInfo(annotation=Literal['extrusion_face_info'], required=False, default='extrusion_face_info')}[source]

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

property model_fields_set: set[str][source]

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,: i.e. that were not filled from defaults.

classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')[source]

Generates a JSON schema for a model class.

Parameters:

by_alias (bool) – Whether to use attribute aliases or not.
ref_template (str) – The reference template.
schema_generator (type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modifications
mode (Literal['validation', 'serialization']) – The mode in which to generate the schema.

Return type:

Returns:

The JSON schema for the given model class.

classmethod model_parametrized_name(params)[source]

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

Parameters:: params (tuple[type[Any], ...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.
Return type:: str
Returns:: String representing the new class where params are passed to cls as type variables.
Raises:: TypeError – Raised when trying to generate concrete names for non-generic models.

model_post_init(_BaseModel__context)[source]

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

Return type:: None

classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)[source]

Try to rebuild the pydantic-core schema for the model.

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.

Parameters:

force (bool) – Whether to force the rebuilding of the model schema, defaults to False.
raise_errors (bool) – Whether to raise errors, defaults to True.
_parent_namespace_depth (int) – The depth level of the parent namespace, defaults to 2.
_types_namespace (dict[str, Any] | None) – The types namespace, defaults to None.

Return type:

Returns:

Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.

classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)[source]

Validate a pydantic model instance.

Parameters:

obj (Any) – The object to validate.
strict (bool | None) – Whether to enforce types strictly.
from_attributes (bool | None) – Whether to extract data from object attributes.
context (Any | None) – Additional context to pass to the validator.

Raises:

ValidationError – If the object could not be validated.

Return type:

Self

Returns:

The validated model instance.

classmethod model_validate_json(json_data, *, strict=None, context=None)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing

Validate the given JSON data against the Pydantic model.

Parameters:

json_data (str | bytes | bytearray) – The JSON data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

Raises:

ValidationError – If json_data is not a JSON string or the object could not be validated.

classmethod model_validate_strings(obj, *, strict=None, context=None)[source]

Validate the given object with string data against the Pydantic model.

Parameters:

obj (Any) – The object containing string data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod parse_obj(obj)[source]

Return type:: Self

classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod schema(by_alias=True, ref_template='#/$defs/{model}')[source]

Return type:: Dict[str, Any]

classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)[source]

Return type:: str

type: Literal['extrusion_face_info'][source]

classmethod update_forward_refs(**localns)[source]

Return type:: None

classmethod validate(value)[source]

Return type:: Self

class kittycad.models.ok_modeling_cmd_response.OptionFaceGetCenter(**data)[source][source]

The response to the ‘FaceGetCenter’ endpoint

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__abstractmethods__ = frozenset({})[source]

__annotations__ = {'__class_vars__': 'ClassVar[set[str]]', '__private_attributes__': 'ClassVar[Dict[str, ModelPrivateAttr]]', '__pydantic_complete__': 'ClassVar[bool]', '__pydantic_core_schema__': 'ClassVar[CoreSchema]', '__pydantic_custom_init__': 'ClassVar[bool]', '__pydantic_decorators__': 'ClassVar[_decorators.DecoratorInfos]', '__pydantic_extra__': 'dict[str, Any] | None', '__pydantic_fields_set__': 'set[str]', '__pydantic_generic_metadata__': 'ClassVar[_generics.PydanticGenericMetadata]', '__pydantic_parent_namespace__': 'ClassVar[Dict[str, Any] | None]', '__pydantic_post_init__': "ClassVar[None | Literal['model_post_init']]", '__pydantic_private__': 'dict[str, Any] | None', '__pydantic_root_model__': 'ClassVar[bool]', '__pydantic_serializer__': 'ClassVar[SchemaSerializer]', '__pydantic_validator__': 'ClassVar[SchemaValidator | PluggableSchemaValidator]', '__signature__': 'ClassVar[Signature]', 'data': <class 'kittycad.models.face_get_center.FaceGetCenter'>, 'model_computed_fields': 'ClassVar[Dict[str, ComputedFieldInfo]]', 'model_config': 'ClassVar[ConfigDict]', 'model_fields': 'ClassVar[Dict[str, FieldInfo]]', 'type': typing.Literal['face_get_center']}[source]

classmethod __class_getitem__(typevar_values)[source]

Return type:: type[BaseModel] | PydanticRecursiveRef

__class_vars__: ClassVar[set[str]] = {}[source]: The names of the class variables defined on the model.

__copy__()[source]

Returns a shallow copy of the model.

Return type:: Self

__deepcopy__(memo=None)[source]

Returns a deep copy of the model.

Return type:: Self

__delattr__(item)[source]

Implement delattr(self, name).

Return type:: Any

__dict__[source]

__eq__(other)[source]

Return self==value.

Return type:: bool

property __fields_set__: set[str][source]

classmethod __get_pydantic_core_schema__(source, handler, /)[source]

Hook into generating the model’s CoreSchema.

Parameters:

source (type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.
handler (GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.

Return type:

Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]

Returns:

A pydantic-core CoreSchema.

classmethod __get_pydantic_json_schema__(core_schema, handler, /)[source]

Hook into generating the model’s JSON schema.

Parameters:

core_schema (Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({'type': 'nullable', 'schema': current_schema}), or just call the handler with the original schema.
handler (GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.

Return type:

Returns:

A JSON schema, as a Python object.

__getattr__(item)[source]

Return type:: Any

__getstate__()[source]

Helper for pickle.

Return type:: dict[Any, Any]

__hash__ = None[source]

__init__(**data)[source]

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__iter__()[source]

So dict(model) works.

Return type:: Generator[Tuple[str, Any], None, None]

__module__ = 'kittycad.models.ok_modeling_cmd_response'[source]

__pretty__(fmt, **kwargs)[source]

Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.

Return type:: Generator[Any, None, None]

__private_attributes__: ClassVar[Dict[str, ModelPrivateAttr]] = {}[source]: Metadata about the private attributes of the model.

__pydantic_complete__: ClassVar[bool] = True[source]: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__: ClassVar[CoreSchema] = {'cls': <class 'kittycad.models.ok_modeling_cmd_response.OptionFaceGetCenter'>, 'config': {'title': 'OptionFaceGetCenter'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.ok_modeling_cmd_response.OptionFaceGetCenter'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.ok_modeling_cmd_response.OptionFaceGetCenter'>>]}, 'ref': 'kittycad.models.ok_modeling_cmd_response.OptionFaceGetCenter:94667213865664', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'data': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.face_get_center.FaceGetCenter'>, 'config': {'title': 'FaceGetCenter'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.face_get_center.FaceGetCenter'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.face_get_center.FaceGetCenter'>>]}, 'ref': 'kittycad.models.face_get_center.FaceGetCenter:94667206512416', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'pos': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.point3d.Point3d'>, 'config': {'title': 'Point3d'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.point3d.Point3d'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.point3d.Point3d'>>]}, 'ref': 'kittycad.models.point3d.Point3d:94667194426368', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'x': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'type': 'float'}, 'type': 'model-field'}, 'y': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'type': 'float'}, 'type': 'model-field'}, 'z': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'type': 'float'}, 'type': 'model-field'}}, 'model_name': 'Point3d', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}}, 'model_name': 'FaceGetCenter', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}, 'type': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': 'face_get_center', 'schema': {'expected': ['face_get_center'], 'type': 'literal'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'OptionFaceGetCenter', 'type': 'model-fields'}, 'type': 'model'}[source]: The core schema of the model.

__pydantic_custom_init__: ClassVar[bool] = False[source]: Whether the model has a custom __init__ method.

__pydantic_decorators__: ClassVar[_decorators.DecoratorInfos] = DecoratorInfos(validators={}, field_validators={}, root_validators={}, field_serializers={}, model_serializers={}, model_validators={}, computed_fields={})[source]: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_extra__: dict[str, Any] | None[source]: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to 'allow'.

__pydantic_fields_set__: set[str][source]: The names of fields explicitly set during instantiation.

__pydantic_generic_metadata__: ClassVar[_generics.PydanticGenericMetadata] = {'args': (), 'origin': None, 'parameters': ()}[source]: 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.

classmethod __pydantic_init_subclass__(**kwargs)[source]

This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.

This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.

This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.

Parameters:: **kwargs (Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.
Return type:: None

__pydantic_parent_namespace__: ClassVar[Dict[str, Any] | None] = None[source]: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__: ClassVar[None | Literal['model_post_init']] = None[source]: The name of the post-init method for the model, if defined.

__pydantic_private__: dict[str, Any] | None[source]: Values of private attributes set on the model instance.

__pydantic_root_model__: ClassVar[bool] = False[source]: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__: ClassVar[SchemaSerializer] = SchemaSerializer(serializer=Model( ModelSerializer { class: Py( 0x000056196da782c0, ), serializer: Fields( GeneralFieldsSerializer { fields: { "type": SerField { key_py: Py( 0x00007f903823d958, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f90347d6870, ), ), serializer: Literal( LiteralSerializer { expected_int: {}, expected_str: { "face_get_center", }, expected_py: None, name: "literal['face_get_center']", }, ), }, ), ), required: true, }, "data": SerField { key_py: Py( 0x00007f9038238fa0, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196d374f20, ), serializer: Fields( GeneralFieldsSerializer { fields: { "pos": SerField { key_py: Py( 0x00007f903823c150, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196c7ee400, ), serializer: Fields( GeneralFieldsSerializer { fields: { "z": SerField { key_py: Py( 0x00007f903823f588, ), alias: None, alias_py: None, serializer: Some( Float( FloatSerializer { inf_nan_mode: Null, }, ), ), required: true, }, "y": SerField { key_py: Py( 0x00007f903823f558, ), alias: None, alias_py: None, serializer: Some( Float( FloatSerializer { inf_nan_mode: Null, }, ), ), required: true, }, "x": SerField { key_py: Py( 0x00007f903823de18, ), alias: None, alias_py: None, serializer: Some( Float( FloatSerializer { inf_nan_mode: Null, }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 3, }, ), has_extra: false, root_model: false, name: "Point3d", }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 1, }, ), has_extra: false, root_model: false, name: "FaceGetCenter", }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "OptionFaceGetCenter", }, ), definitions=[])[source]: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__: ClassVar[SchemaValidator | PluggableSchemaValidator] = SchemaValidator(title="OptionFaceGetCenter", validator=Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "data", lookup_key: Simple { key: "data", py_key: Py( 0x00007f90333a8300, ), path: LookupPath( [ S( "data", Py( 0x00007f90333a8360, ), ), ], ), }, name_py: Py( 0x00007f9038238fa0, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "pos", lookup_key: Simple { key: "pos", py_key: Py( 0x00007f90333a84b0, ), path: LookupPath( [ S( "pos", Py( 0x00007f90333a8690, ), ), ], ), }, name_py: Py( 0x00007f903823c150, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "x", lookup_key: Simple { key: "x", py_key: Py( 0x00007f903823f528, ), path: LookupPath( [ S( "x", Py( 0x00007f903823f528, ), ), ], ), }, name_py: Py( 0x00007f903823de18, ), validator: Float( FloatValidator { strict: false, allow_inf_nan: true, }, ), frozen: false, }, Field { name: "y", lookup_key: Simple { key: "y", py_key: Py( 0x00007f903823f558, ), path: LookupPath( [ S( "y", Py( 0x00007f903823f558, ), ), ], ), }, name_py: Py( 0x00007f903823f558, ), validator: Float( FloatValidator { strict: false, allow_inf_nan: true, }, ), frozen: false, }, Field { name: "z", lookup_key: Simple { key: "z", py_key: Py( 0x00007f903823f588, ), path: LookupPath( [ S( "z", Py( 0x00007f903823f588, ), ), ], ), }, name_py: Py( 0x00007f903823f588, ), validator: Float( FloatValidator { strict: false, allow_inf_nan: true, }, ), frozen: false, }, ], model_name: "Point3d", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196c7ee400, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "Point3d", }, ), frozen: false, }, ], model_name: "FaceGetCenter", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d374f20, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "FaceGetCenter", }, ), frozen: false, }, Field { name: "type", lookup_key: Simple { key: "type", py_key: Py( 0x00007f90333a8330, ), path: LookupPath( [ S( "type", Py( 0x00007f90333a8480, ), ), ], ), }, name_py: Py( 0x00007f903823d958, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f90347d6870, ), ), on_error: Raise, validator: Literal( LiteralValidator { lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "face_get_center": 0, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f90347d6870, ), ], }, expected_repr: "'face_get_center'", name: "literal['face_get_center']", }, ), validate_default: false, copy_default: false, name: "default[literal['face_get_center']]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "OptionFaceGetCenter", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196da782c0, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "OptionFaceGetCenter", }, ), definitions=[], cache_strings=True)[source]: The pydantic-core SchemaValidator used to validate instances of the model.

__repr__()[source]

Return repr(self).

Return type:: str

__repr_args__()[source]

Return type:: Iterable[tuple[str | None, Any]]

__repr_name__()[source]

Name of the instance’s class, used in __repr__.

Return type:: str

__repr_str__(join_str)[source]

Return type:: str

__rich_repr__()[source]

Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.

Return type:: Iterable[Any | tuple[Any] | tuple[str, Any] | tuple[str, Any, Any]]

__setattr__(name, value)[source]

Implement setattr(self, name, value).

Return type:: None

__setstate__(state)[source]

Return type:: None

__signature__: ClassVar[Signature] = <Signature (*, data: kittycad.models.face_get_center.FaceGetCenter, type: Literal['face_get_center'] = 'face_get_center') -> None>[source]: The synthesized __init__ [Signature][inspect.Signature] of the model.

__slots__ = ('__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__')[source]

__str__()[source]

Return str(self).

Return type:: str

_abc_impl = <_abc._abc_data object>[source]

_calculate_keys(*args, **kwargs)[source]

Return type:: Any

_check_frozen(name, value)[source]

Return type:: None

_copy_and_set_values(*args, **kwargs)[source]

Return type:: Any

classmethod _get_value(*args, **kwargs)[source]

Return type:: Any

_iter(*args, **kwargs)[source]

Return type:: Any

classmethod construct(_fields_set=None, **values)[source]

Return type:: Self

copy(*, include=None, exclude=None, update=None, deep=False)[source]

Returns a copy of the model.

!!! warning “Deprecated”: This method is now deprecated; use model_copy instead.

If you need include or exclude, use:

`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `

Parameters:

include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.

Returns:

A copy of the model with included, excluded and updated fields as specified.

data: FaceGetCenter[source]

dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)[source]

Return type:: Dict[str, Any]

classmethod from_orm(obj)[source]

Return type:: Self

json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)[source]

Return type:: str

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}[source]: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'protected_namespaces': ()}[source]: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod model_construct(_fields_set=None, **values)[source]

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note: model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == 'allow', then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == 'ignore' (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == 'forbid' does not result in an error if extra values are passed, but they will be ignored.

Parameters:

_fields_set (set[str] | None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.
values (Any) – Trusted or pre-validated data dictionary.

Return type:

Self

Returns:

A new instance of the Model class with validated data.

model_copy(*, update=None, deep=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy

Returns a copy of the model.

Parameters:

update (dict[str, Any] | None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.
deep (bool) – Set to True to make a deep copy of the model.

Return type:

Self

Returns:

New model instance.

model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters:

mode (Union[Literal['json', 'python'], str]) – The mode in which to_python 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.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to include in the output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to exclude from the output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to use the field’s alias in the dictionary key if defined.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A dictionary representation of the model.

model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

Generates a JSON representation of the model using Pydantic’s to_json method.

Parameters:

indent (int | None) – Indentation to use in the JSON output. If None is passed, the output will be compact.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to include in the JSON output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to exclude from the JSON output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to serialize using field aliases.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A JSON string representation of the model.

property model_extra: dict[str, Any] | None[source]

Get extra fields set during validation.

Returns:: A dictionary of extra fields, or None if config.extra is not set to "allow".

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=FaceGetCenter, required=True), 'type': FieldInfo(annotation=Literal['face_get_center'], required=False, default='face_get_center')}[source]

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

property model_fields_set: set[str][source]

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,: i.e. that were not filled from defaults.

classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')[source]

Generates a JSON schema for a model class.

Parameters:

by_alias (bool) – Whether to use attribute aliases or not.
ref_template (str) – The reference template.
schema_generator (type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modifications
mode (Literal['validation', 'serialization']) – The mode in which to generate the schema.

Return type:

Returns:

The JSON schema for the given model class.

classmethod model_parametrized_name(params)[source]

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

Parameters:: params (tuple[type[Any], ...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.
Return type:: str
Returns:: String representing the new class where params are passed to cls as type variables.
Raises:: TypeError – Raised when trying to generate concrete names for non-generic models.

model_post_init(_BaseModel__context)[source]

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

Return type:: None

classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)[source]

Try to rebuild the pydantic-core schema for the model.

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.

Parameters:

force (bool) – Whether to force the rebuilding of the model schema, defaults to False.
raise_errors (bool) – Whether to raise errors, defaults to True.
_parent_namespace_depth (int) – The depth level of the parent namespace, defaults to 2.
_types_namespace (dict[str, Any] | None) – The types namespace, defaults to None.

Return type:

Returns:

Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.

classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)[source]

Validate a pydantic model instance.

Parameters:

obj (Any) – The object to validate.
strict (bool | None) – Whether to enforce types strictly.
from_attributes (bool | None) – Whether to extract data from object attributes.
context (Any | None) – Additional context to pass to the validator.

Raises:

ValidationError – If the object could not be validated.

Return type:

Self

Returns:

The validated model instance.

classmethod model_validate_json(json_data, *, strict=None, context=None)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing

Validate the given JSON data against the Pydantic model.

Parameters:

json_data (str | bytes | bytearray) – The JSON data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

Raises:

ValidationError – If json_data is not a JSON string or the object could not be validated.

classmethod model_validate_strings(obj, *, strict=None, context=None)[source]

Validate the given object with string data against the Pydantic model.

Parameters:

obj (Any) – The object containing string data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod parse_obj(obj)[source]

Return type:: Self

classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod schema(by_alias=True, ref_template='#/$defs/{model}')[source]

Return type:: Dict[str, Any]

classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)[source]

Return type:: str

type: Literal['face_get_center'][source]

classmethod update_forward_refs(**localns)[source]

Return type:: None

classmethod validate(value)[source]

Return type:: Self

class kittycad.models.ok_modeling_cmd_response.OptionFaceGetGradient(**data)[source][source]

The response to the ‘FaceGetGradient’ endpoint

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__abstractmethods__ = frozenset({})[source]

__annotations__ = {'__class_vars__': 'ClassVar[set[str]]', '__private_attributes__': 'ClassVar[Dict[str, ModelPrivateAttr]]', '__pydantic_complete__': 'ClassVar[bool]', '__pydantic_core_schema__': 'ClassVar[CoreSchema]', '__pydantic_custom_init__': 'ClassVar[bool]', '__pydantic_decorators__': 'ClassVar[_decorators.DecoratorInfos]', '__pydantic_extra__': 'dict[str, Any] | None', '__pydantic_fields_set__': 'set[str]', '__pydantic_generic_metadata__': 'ClassVar[_generics.PydanticGenericMetadata]', '__pydantic_parent_namespace__': 'ClassVar[Dict[str, Any] | None]', '__pydantic_post_init__': "ClassVar[None | Literal['model_post_init']]", '__pydantic_private__': 'dict[str, Any] | None', '__pydantic_root_model__': 'ClassVar[bool]', '__pydantic_serializer__': 'ClassVar[SchemaSerializer]', '__pydantic_validator__': 'ClassVar[SchemaValidator | PluggableSchemaValidator]', '__signature__': 'ClassVar[Signature]', 'data': <class 'kittycad.models.face_get_gradient.FaceGetGradient'>, 'model_computed_fields': 'ClassVar[Dict[str, ComputedFieldInfo]]', 'model_config': 'ClassVar[ConfigDict]', 'model_fields': 'ClassVar[Dict[str, FieldInfo]]', 'type': typing.Literal['face_get_gradient']}[source]

classmethod __class_getitem__(typevar_values)[source]

Return type:: type[BaseModel] | PydanticRecursiveRef

__class_vars__: ClassVar[set[str]] = {}[source]: The names of the class variables defined on the model.

__copy__()[source]

Returns a shallow copy of the model.

Return type:: Self

__deepcopy__(memo=None)[source]

Returns a deep copy of the model.

Return type:: Self

__delattr__(item)[source]

Implement delattr(self, name).

Return type:: Any

__dict__[source]

__eq__(other)[source]

Return self==value.

Return type:: bool

property __fields_set__: set[str][source]

classmethod __get_pydantic_core_schema__(source, handler, /)[source]

Hook into generating the model’s CoreSchema.

Parameters:

source (type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.
handler (GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.

Return type:

Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]

Returns:

A pydantic-core CoreSchema.

classmethod __get_pydantic_json_schema__(core_schema, handler, /)[source]

Hook into generating the model’s JSON schema.

Parameters:

core_schema (Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({'type': 'nullable', 'schema': current_schema}), or just call the handler with the original schema.
handler (GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.

Return type:

Returns:

A JSON schema, as a Python object.

__getattr__(item)[source]

Return type:: Any

__getstate__()[source]

Helper for pickle.

Return type:: dict[Any, Any]

__hash__ = None[source]

__init__(**data)[source]

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__iter__()[source]

So dict(model) works.

Return type:: Generator[Tuple[str, Any], None, None]

__module__ = 'kittycad.models.ok_modeling_cmd_response'[source]

__pretty__(fmt, **kwargs)[source]

Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.

Return type:: Generator[Any, None, None]

__private_attributes__: ClassVar[Dict[str, ModelPrivateAttr]] = {}[source]: Metadata about the private attributes of the model.

__pydantic_complete__: ClassVar[bool] = True[source]: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__: ClassVar[CoreSchema] = {'definitions': [{'cls': <class 'kittycad.models.point3d.Point3d'>, 'config': {'title': 'Point3d'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.point3d.Point3d'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.point3d.Point3d'>>]}, 'ref': 'kittycad.models.point3d.Point3d:94667194426368', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'x': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'type': 'float'}, 'type': 'model-field'}, 'y': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'type': 'float'}, 'type': 'model-field'}, 'z': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'type': 'float'}, 'type': 'model-field'}}, 'model_name': 'Point3d', 'type': 'model-fields'}, 'type': 'model'}], 'schema': {'cls': <class 'kittycad.models.ok_modeling_cmd_response.OptionFaceGetGradient'>, 'config': {'title': 'OptionFaceGetGradient'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.ok_modeling_cmd_response.OptionFaceGetGradient'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.ok_modeling_cmd_response.OptionFaceGetGradient'>>]}, 'ref': 'kittycad.models.ok_modeling_cmd_response.OptionFaceGetGradient:94667213881520', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'data': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.face_get_gradient.FaceGetGradient'>, 'config': {'title': 'FaceGetGradient'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.face_get_gradient.FaceGetGradient'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.face_get_gradient.FaceGetGradient'>>]}, 'ref': 'kittycad.models.face_get_gradient.FaceGetGradient:94667206521936', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'df_du': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'schema_ref': 'kittycad.models.point3d.Point3d:94667194426368', 'type': 'definition-ref'}, 'type': 'model-field'}, 'df_dv': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'schema_ref': 'kittycad.models.point3d.Point3d:94667194426368', 'type': 'definition-ref'}, 'type': 'model-field'}, 'normal': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'schema_ref': 'kittycad.models.point3d.Point3d:94667194426368', 'type': 'definition-ref'}, 'type': 'model-field'}}, 'model_name': 'FaceGetGradient', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}, 'type': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': 'face_get_gradient', 'schema': {'expected': ['face_get_gradient'], 'type': 'literal'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'OptionFaceGetGradient', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'definitions'}[source]: The core schema of the model.

__pydantic_custom_init__: ClassVar[bool] = False[source]: Whether the model has a custom __init__ method.

__pydantic_decorators__: ClassVar[_decorators.DecoratorInfos] = DecoratorInfos(validators={}, field_validators={}, root_validators={}, field_serializers={}, model_serializers={}, model_validators={}, computed_fields={})[source]: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_extra__: dict[str, Any] | None[source]: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to 'allow'.

__pydantic_fields_set__: set[str][source]: The names of fields explicitly set during instantiation.

__pydantic_generic_metadata__: ClassVar[_generics.PydanticGenericMetadata] = {'args': (), 'origin': None, 'parameters': ()}[source]: 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.

classmethod __pydantic_init_subclass__(**kwargs)[source]

This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.

This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.

This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.

Parameters:: **kwargs (Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.
Return type:: None

__pydantic_parent_namespace__: ClassVar[Dict[str, Any] | None] = None[source]: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__: ClassVar[None | Literal['model_post_init']] = None[source]: The name of the post-init method for the model, if defined.

__pydantic_private__: dict[str, Any] | None[source]: Values of private attributes set on the model instance.

__pydantic_root_model__: ClassVar[bool] = False[source]: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__: ClassVar[SchemaSerializer] = SchemaSerializer(serializer=Model( ModelSerializer { class: Py( 0x000056196da7c0b0, ), serializer: Fields( GeneralFieldsSerializer { fields: { "type": SerField { key_py: Py( 0x00007f903823d958, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f90347d6630, ), ), serializer: Literal( LiteralSerializer { expected_int: {}, expected_str: { "face_get_gradient", }, expected_py: None, name: "literal['face_get_gradient']", }, ), }, ), ), required: true, }, "data": SerField { key_py: Py( 0x00007f9038238fa0, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196d377450, ), serializer: Fields( GeneralFieldsSerializer { fields: { "df_du": SerField { key_py: Py( 0x00007f90339509c0, ), alias: None, alias_py: None, serializer: Some( Recursive( DefinitionRefSerializer { definition: "...", retry_with_lax_check: true, }, ), ), required: true, }, "normal": SerField { key_py: Py( 0x00007f9036ac2a00, ), alias: None, alias_py: None, serializer: Some( Recursive( DefinitionRefSerializer { definition: "...", retry_with_lax_check: true, }, ), ), required: true, }, "df_dv": SerField { key_py: Py( 0x00007f9033950a50, ), alias: None, alias_py: None, serializer: Some( Recursive( DefinitionRefSerializer { definition: "...", retry_with_lax_check: true, }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 3, }, ), has_extra: false, root_model: false, name: "FaceGetGradient", }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "OptionFaceGetGradient", }, ), definitions=[Model(ModelSerializer { class: Py(0x56196c7ee400), serializer: Fields(GeneralFieldsSerializer { fields: {"x": SerField { key_py: Py(0x7f903823de18), alias: None, alias_py: None, serializer: Some(Float(FloatSerializer { inf_nan_mode: Null })), required: true }, "z": SerField { key_py: Py(0x7f903823f588), alias: None, alias_py: None, serializer: Some(Float(FloatSerializer { inf_nan_mode: Null })), required: true }, "y": SerField { key_py: Py(0x7f903823f558), alias: None, alias_py: None, serializer: Some(Float(FloatSerializer { inf_nan_mode: Null })), required: true }}, computed_fields: Some(ComputedFields([])), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None }, required_fields: 3 }), has_extra: false, root_model: false, name: "Point3d" })])[source]: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__: ClassVar[SchemaValidator | PluggableSchemaValidator] = SchemaValidator(title="OptionFaceGetGradient", validator=Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "data", lookup_key: Simple { key: "data", py_key: Py( 0x00007f90333a95f0, ), path: LookupPath( [ S( "data", Py( 0x00007f90333a9620, ), ), ], ), }, name_py: Py( 0x00007f9038238fa0, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "df_du", lookup_key: Simple { key: "df_du", py_key: Py( 0x00007f90333a94d0, ), path: LookupPath( [ S( "df_du", Py( 0x00007f90333a9500, ), ), ], ), }, name_py: Py( 0x00007f90339509c0, ), validator: DefinitionRef( DefinitionRefValidator { definition: "...", }, ), frozen: false, }, Field { name: "df_dv", lookup_key: Simple { key: "df_dv", py_key: Py( 0x00007f90333a9530, ), path: LookupPath( [ S( "df_dv", Py( 0x00007f90333a9560, ), ), ], ), }, name_py: Py( 0x00007f9033950a50, ), validator: DefinitionRef( DefinitionRefValidator { definition: "...", }, ), frozen: false, }, Field { name: "normal", lookup_key: Simple { key: "normal", py_key: Py( 0x00007f90333a9590, ), path: LookupPath( [ S( "normal", Py( 0x00007f90333a95c0, ), ), ], ), }, name_py: Py( 0x00007f9036ac2a00, ), validator: DefinitionRef( DefinitionRefValidator { definition: "...", }, ), frozen: false, }, ], model_name: "FaceGetGradient", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d377450, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "FaceGetGradient", }, ), frozen: false, }, Field { name: "type", lookup_key: Simple { key: "type", py_key: Py( 0x00007f90333a9650, ), path: LookupPath( [ S( "type", Py( 0x00007f90333a9680, ), ), ], ), }, name_py: Py( 0x00007f903823d958, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f90347d6630, ), ), on_error: Raise, validator: Literal( LiteralValidator { lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "face_get_gradient": 0, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f90347d6630, ), ], }, expected_repr: "'face_get_gradient'", name: "literal['face_get_gradient']", }, ), validate_default: false, copy_default: false, name: "default[literal['face_get_gradient']]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "OptionFaceGetGradient", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196da7c0b0, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "OptionFaceGetGradient", }, ), definitions=[Model(ModelValidator { revalidate: Never, validator: ModelFields(ModelFieldsValidator { fields: [Field { name: "x", lookup_key: Simple { key: "x", py_key: Py(0x7f903823f528), path: LookupPath([S("x", Py(0x7f903823f528))]) }, name_py: Py(0x7f903823de18), validator: Float(FloatValidator { strict: false, allow_inf_nan: true }), frozen: false }, Field { name: "y", lookup_key: Simple { key: "y", py_key: Py(0x7f903823f558), path: LookupPath([S("y", Py(0x7f903823f558))]) }, name_py: Py(0x7f903823f558), validator: Float(FloatValidator { strict: false, allow_inf_nan: true }), frozen: false }, Field { name: "z", lookup_key: Simple { key: "z", py_key: Py(0x7f903823f588), path: LookupPath([S("z", Py(0x7f903823f588))]) }, name_py: Py(0x7f903823f588), validator: Float(FloatValidator { strict: false, allow_inf_nan: true }), frozen: false }], model_name: "Point3d", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true }), class: Py(0x56196c7ee400), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py(0x7f903629a320), name: "Point3d" })], cache_strings=True)[source]: The pydantic-core SchemaValidator used to validate instances of the model.

__repr__()[source]

Return repr(self).

Return type:: str

__repr_args__()[source]

Return type:: Iterable[tuple[str | None, Any]]

__repr_name__()[source]

Name of the instance’s class, used in __repr__.

Return type:: str

__repr_str__(join_str)[source]

Return type:: str

__rich_repr__()[source]

Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.

Return type:: Iterable[Any | tuple[Any] | tuple[str, Any] | tuple[str, Any, Any]]

__setattr__(name, value)[source]

Implement setattr(self, name, value).

Return type:: None

__setstate__(state)[source]

Return type:: None

__signature__: ClassVar[Signature] = <Signature (*, data: kittycad.models.face_get_gradient.FaceGetGradient, type: Literal['face_get_gradient'] = 'face_get_gradient') -> None>[source]: The synthesized __init__ [Signature][inspect.Signature] of the model.

__slots__ = ('__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__')[source]

__str__()[source]

Return str(self).

Return type:: str

_abc_impl = <_abc._abc_data object>[source]

_calculate_keys(*args, **kwargs)[source]

Return type:: Any

_check_frozen(name, value)[source]

Return type:: None

_copy_and_set_values(*args, **kwargs)[source]

Return type:: Any

classmethod _get_value(*args, **kwargs)[source]

Return type:: Any

_iter(*args, **kwargs)[source]

Return type:: Any

classmethod construct(_fields_set=None, **values)[source]

Return type:: Self

copy(*, include=None, exclude=None, update=None, deep=False)[source]

Returns a copy of the model.

!!! warning “Deprecated”: This method is now deprecated; use model_copy instead.

If you need include or exclude, use:

`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `

Parameters:

include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.

Returns:

A copy of the model with included, excluded and updated fields as specified.

data: FaceGetGradient[source]

dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)[source]

Return type:: Dict[str, Any]

classmethod from_orm(obj)[source]

Return type:: Self

json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)[source]

Return type:: str

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}[source]: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'protected_namespaces': ()}[source]: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod model_construct(_fields_set=None, **values)[source]

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note: model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == 'allow', then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == 'ignore' (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == 'forbid' does not result in an error if extra values are passed, but they will be ignored.

Parameters:

_fields_set (set[str] | None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.
values (Any) – Trusted or pre-validated data dictionary.

Return type:

Self

Returns:

A new instance of the Model class with validated data.

model_copy(*, update=None, deep=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy

Returns a copy of the model.

Parameters:

update (dict[str, Any] | None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.
deep (bool) – Set to True to make a deep copy of the model.

Return type:

Self

Returns:

New model instance.

model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters:

mode (Union[Literal['json', 'python'], str]) – The mode in which to_python 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.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to include in the output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to exclude from the output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to use the field’s alias in the dictionary key if defined.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A dictionary representation of the model.

model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

Generates a JSON representation of the model using Pydantic’s to_json method.

Parameters:

indent (int | None) – Indentation to use in the JSON output. If None is passed, the output will be compact.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to include in the JSON output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to exclude from the JSON output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to serialize using field aliases.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A JSON string representation of the model.

property model_extra: dict[str, Any] | None[source]

Get extra fields set during validation.

Returns:: A dictionary of extra fields, or None if config.extra is not set to "allow".

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=FaceGetGradient, required=True), 'type': FieldInfo(annotation=Literal['face_get_gradient'], required=False, default='face_get_gradient')}[source]

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

property model_fields_set: set[str][source]

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,: i.e. that were not filled from defaults.

classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')[source]

Generates a JSON schema for a model class.

Parameters:

by_alias (bool) – Whether to use attribute aliases or not.
ref_template (str) – The reference template.
schema_generator (type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modifications
mode (Literal['validation', 'serialization']) – The mode in which to generate the schema.

Return type:

Returns:

The JSON schema for the given model class.

classmethod model_parametrized_name(params)[source]

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

Parameters:: params (tuple[type[Any], ...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.
Return type:: str
Returns:: String representing the new class where params are passed to cls as type variables.
Raises:: TypeError – Raised when trying to generate concrete names for non-generic models.

model_post_init(_BaseModel__context)[source]

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

Return type:: None

classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)[source]

Try to rebuild the pydantic-core schema for the model.

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.

Parameters:

force (bool) – Whether to force the rebuilding of the model schema, defaults to False.
raise_errors (bool) – Whether to raise errors, defaults to True.
_parent_namespace_depth (int) – The depth level of the parent namespace, defaults to 2.
_types_namespace (dict[str, Any] | None) – The types namespace, defaults to None.

Return type:

Returns:

Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.

classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)[source]

Validate a pydantic model instance.

Parameters:

obj (Any) – The object to validate.
strict (bool | None) – Whether to enforce types strictly.
from_attributes (bool | None) – Whether to extract data from object attributes.
context (Any | None) – Additional context to pass to the validator.

Raises:

ValidationError – If the object could not be validated.

Return type:

Self

Returns:

The validated model instance.

classmethod model_validate_json(json_data, *, strict=None, context=None)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing

Validate the given JSON data against the Pydantic model.

Parameters:

json_data (str | bytes | bytearray) – The JSON data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

Raises:

ValidationError – If json_data is not a JSON string or the object could not be validated.

classmethod model_validate_strings(obj, *, strict=None, context=None)[source]

Validate the given object with string data against the Pydantic model.

Parameters:

obj (Any) – The object containing string data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod parse_obj(obj)[source]

Return type:: Self

classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod schema(by_alias=True, ref_template='#/$defs/{model}')[source]

Return type:: Dict[str, Any]

classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)[source]

Return type:: str

type: Literal['face_get_gradient'][source]

classmethod update_forward_refs(**localns)[source]

Return type:: None

classmethod validate(value)[source]

Return type:: Self

class kittycad.models.ok_modeling_cmd_response.OptionFaceGetPosition(**data)[source][source]

The response to the ‘FaceGetPosition’ endpoint

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__abstractmethods__ = frozenset({})[source]

__annotations__ = {'__class_vars__': 'ClassVar[set[str]]', '__private_attributes__': 'ClassVar[Dict[str, ModelPrivateAttr]]', '__pydantic_complete__': 'ClassVar[bool]', '__pydantic_core_schema__': 'ClassVar[CoreSchema]', '__pydantic_custom_init__': 'ClassVar[bool]', '__pydantic_decorators__': 'ClassVar[_decorators.DecoratorInfos]', '__pydantic_extra__': 'dict[str, Any] | None', '__pydantic_fields_set__': 'set[str]', '__pydantic_generic_metadata__': 'ClassVar[_generics.PydanticGenericMetadata]', '__pydantic_parent_namespace__': 'ClassVar[Dict[str, Any] | None]', '__pydantic_post_init__': "ClassVar[None | Literal['model_post_init']]", '__pydantic_private__': 'dict[str, Any] | None', '__pydantic_root_model__': 'ClassVar[bool]', '__pydantic_serializer__': 'ClassVar[SchemaSerializer]', '__pydantic_validator__': 'ClassVar[SchemaValidator | PluggableSchemaValidator]', '__signature__': 'ClassVar[Signature]', 'data': <class 'kittycad.models.face_get_position.FaceGetPosition'>, 'model_computed_fields': 'ClassVar[Dict[str, ComputedFieldInfo]]', 'model_config': 'ClassVar[ConfigDict]', 'model_fields': 'ClassVar[Dict[str, FieldInfo]]', 'type': typing.Literal['face_get_position']}[source]

classmethod __class_getitem__(typevar_values)[source]

Return type:: type[BaseModel] | PydanticRecursiveRef

__class_vars__: ClassVar[set[str]] = {}[source]: The names of the class variables defined on the model.

__copy__()[source]

Returns a shallow copy of the model.

Return type:: Self

__deepcopy__(memo=None)[source]

Returns a deep copy of the model.

Return type:: Self

__delattr__(item)[source]

Implement delattr(self, name).

Return type:: Any

__dict__[source]

__eq__(other)[source]

Return self==value.

Return type:: bool

property __fields_set__: set[str][source]

classmethod __get_pydantic_core_schema__(source, handler, /)[source]

Hook into generating the model’s CoreSchema.

Parameters:

source (type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.
handler (GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.

Return type:

Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]

Returns:

A pydantic-core CoreSchema.

classmethod __get_pydantic_json_schema__(core_schema, handler, /)[source]

Hook into generating the model’s JSON schema.

Parameters:

core_schema (Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({'type': 'nullable', 'schema': current_schema}), or just call the handler with the original schema.
handler (GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.

Return type:

Returns:

A JSON schema, as a Python object.

__getattr__(item)[source]

Return type:: Any

__getstate__()[source]

Helper for pickle.

Return type:: dict[Any, Any]

__hash__ = None[source]

__init__(**data)[source]

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__iter__()[source]

So dict(model) works.

Return type:: Generator[Tuple[str, Any], None, None]

__module__ = 'kittycad.models.ok_modeling_cmd_response'[source]

__pretty__(fmt, **kwargs)[source]

Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.

Return type:: Generator[Any, None, None]

__private_attributes__: ClassVar[Dict[str, ModelPrivateAttr]] = {}[source]: Metadata about the private attributes of the model.

__pydantic_complete__: ClassVar[bool] = True[source]: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__: ClassVar[CoreSchema] = {'cls': <class 'kittycad.models.ok_modeling_cmd_response.OptionFaceGetPosition'>, 'config': {'title': 'OptionFaceGetPosition'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.ok_modeling_cmd_response.OptionFaceGetPosition'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.ok_modeling_cmd_response.OptionFaceGetPosition'>>]}, 'ref': 'kittycad.models.ok_modeling_cmd_response.OptionFaceGetPosition:94667213837456', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'data': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.face_get_position.FaceGetPosition'>, 'config': {'title': 'FaceGetPosition'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.face_get_position.FaceGetPosition'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.face_get_position.FaceGetPosition'>>]}, 'ref': 'kittycad.models.face_get_position.FaceGetPosition:94667206535472', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'pos': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.point3d.Point3d'>, 'config': {'title': 'Point3d'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.point3d.Point3d'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.point3d.Point3d'>>]}, 'ref': 'kittycad.models.point3d.Point3d:94667194426368', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'x': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'type': 'float'}, 'type': 'model-field'}, 'y': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'type': 'float'}, 'type': 'model-field'}, 'z': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'type': 'float'}, 'type': 'model-field'}}, 'model_name': 'Point3d', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}}, 'model_name': 'FaceGetPosition', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}, 'type': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': 'face_get_position', 'schema': {'expected': ['face_get_position'], 'type': 'literal'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'OptionFaceGetPosition', 'type': 'model-fields'}, 'type': 'model'}[source]: The core schema of the model.

__pydantic_custom_init__: ClassVar[bool] = False[source]: Whether the model has a custom __init__ method.

__pydantic_decorators__: ClassVar[_decorators.DecoratorInfos] = DecoratorInfos(validators={}, field_validators={}, root_validators={}, field_serializers={}, model_serializers={}, model_validators={}, computed_fields={})[source]: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_extra__: dict[str, Any] | None[source]: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to 'allow'.

__pydantic_fields_set__: set[str][source]: The names of fields explicitly set during instantiation.

__pydantic_generic_metadata__: ClassVar[_generics.PydanticGenericMetadata] = {'args': (), 'origin': None, 'parameters': ()}[source]: 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.

classmethod __pydantic_init_subclass__(**kwargs)[source]

This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.

This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.

This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.

Parameters:: **kwargs (Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.
Return type:: None

__pydantic_parent_namespace__: ClassVar[Dict[str, Any] | None] = None[source]: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__: ClassVar[None | Literal['model_post_init']] = None[source]: The name of the post-init method for the model, if defined.

__pydantic_private__: dict[str, Any] | None[source]: Values of private attributes set on the model instance.

__pydantic_root_model__: ClassVar[bool] = False[source]: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__: ClassVar[SchemaSerializer] = SchemaSerializer(serializer=Model( ModelSerializer { class: Py( 0x000056196da71490, ), serializer: Fields( GeneralFieldsSerializer { fields: { "data": SerField { key_py: Py( 0x00007f9038238fa0, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196d37a930, ), serializer: Fields( GeneralFieldsSerializer { fields: { "pos": SerField { key_py: Py( 0x00007f903823c150, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196c7ee400, ), serializer: Fields( GeneralFieldsSerializer { fields: { "x": SerField { key_py: Py( 0x00007f903823de18, ), alias: None, alias_py: None, serializer: Some( Float( FloatSerializer { inf_nan_mode: Null, }, ), ), required: true, }, "y": SerField { key_py: Py( 0x00007f903823f558, ), alias: None, alias_py: None, serializer: Some( Float( FloatSerializer { inf_nan_mode: Null, }, ), ), required: true, }, "z": SerField { key_py: Py( 0x00007f903823f588, ), alias: None, alias_py: None, serializer: Some( Float( FloatSerializer { inf_nan_mode: Null, }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 3, }, ), has_extra: false, root_model: false, name: "Point3d", }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 1, }, ), has_extra: false, root_model: false, name: "FaceGetPosition", }, ), ), required: true, }, "type": SerField { key_py: Py( 0x00007f903823d958, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f90347d43f0, ), ), serializer: Literal( LiteralSerializer { expected_int: {}, expected_str: { "face_get_position", }, expected_py: None, name: "literal['face_get_position']", }, ), }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "OptionFaceGetPosition", }, ), definitions=[])[source]: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__: ClassVar[SchemaValidator | PluggableSchemaValidator] = SchemaValidator(title="OptionFaceGetPosition", validator=Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "data", lookup_key: Simple { key: "data", py_key: Py( 0x00007f90333a91a0, ), path: LookupPath( [ S( "data", Py( 0x00007f90333a8e10, ), ), ], ), }, name_py: Py( 0x00007f9038238fa0, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "pos", lookup_key: Simple { key: "pos", py_key: Py( 0x00007f90333a8ea0, ), path: LookupPath( [ S( "pos", Py( 0x00007f90333a8fc0, ), ), ], ), }, name_py: Py( 0x00007f903823c150, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "x", lookup_key: Simple { key: "x", py_key: Py( 0x00007f903823f528, ), path: LookupPath( [ S( "x", Py( 0x00007f903823f528, ), ), ], ), }, name_py: Py( 0x00007f903823de18, ), validator: Float( FloatValidator { strict: false, allow_inf_nan: true, }, ), frozen: false, }, Field { name: "y", lookup_key: Simple { key: "y", py_key: Py( 0x00007f903823f558, ), path: LookupPath( [ S( "y", Py( 0x00007f903823f558, ), ), ], ), }, name_py: Py( 0x00007f903823f558, ), validator: Float( FloatValidator { strict: false, allow_inf_nan: true, }, ), frozen: false, }, Field { name: "z", lookup_key: Simple { key: "z", py_key: Py( 0x00007f903823f588, ), path: LookupPath( [ S( "z", Py( 0x00007f903823f588, ), ), ], ), }, name_py: Py( 0x00007f903823f588, ), validator: Float( FloatValidator { strict: false, allow_inf_nan: true, }, ), frozen: false, }, ], model_name: "Point3d", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196c7ee400, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "Point3d", }, ), frozen: false, }, ], model_name: "FaceGetPosition", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d37a930, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "FaceGetPosition", }, ), frozen: false, }, Field { name: "type", lookup_key: Simple { key: "type", py_key: Py( 0x00007f90333a8e70, ), path: LookupPath( [ S( "type", Py( 0x00007f90333a8e40, ), ), ], ), }, name_py: Py( 0x00007f903823d958, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f90347d43f0, ), ), on_error: Raise, validator: Literal( LiteralValidator { lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "face_get_position": 0, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f90347d43f0, ), ], }, expected_repr: "'face_get_position'", name: "literal['face_get_position']", }, ), validate_default: false, copy_default: false, name: "default[literal['face_get_position']]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "OptionFaceGetPosition", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196da71490, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "OptionFaceGetPosition", }, ), definitions=[], cache_strings=True)[source]: The pydantic-core SchemaValidator used to validate instances of the model.

__repr__()[source]

Return repr(self).

Return type:: str

__repr_args__()[source]

Return type:: Iterable[tuple[str | None, Any]]

__repr_name__()[source]

Name of the instance’s class, used in __repr__.

Return type:: str

__repr_str__(join_str)[source]

Return type:: str

__rich_repr__()[source]

Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.

Return type:: Iterable[Any | tuple[Any] | tuple[str, Any] | tuple[str, Any, Any]]

__setattr__(name, value)[source]

Implement setattr(self, name, value).

Return type:: None

__setstate__(state)[source]

Return type:: None

__signature__: ClassVar[Signature] = <Signature (*, data: kittycad.models.face_get_position.FaceGetPosition, type: Literal['face_get_position'] = 'face_get_position') -> None>[source]: The synthesized __init__ [Signature][inspect.Signature] of the model.

__slots__ = ('__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__')[source]

__str__()[source]

Return str(self).

Return type:: str

_abc_impl = <_abc._abc_data object>[source]

_calculate_keys(*args, **kwargs)[source]

Return type:: Any

_check_frozen(name, value)[source]

Return type:: None

_copy_and_set_values(*args, **kwargs)[source]

Return type:: Any

classmethod _get_value(*args, **kwargs)[source]

Return type:: Any

_iter(*args, **kwargs)[source]

Return type:: Any

classmethod construct(_fields_set=None, **values)[source]

Return type:: Self

copy(*, include=None, exclude=None, update=None, deep=False)[source]

Returns a copy of the model.

!!! warning “Deprecated”: This method is now deprecated; use model_copy instead.

If you need include or exclude, use:

`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `

Parameters:

include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.

Returns:

A copy of the model with included, excluded and updated fields as specified.

data: FaceGetPosition[source]

dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)[source]

Return type:: Dict[str, Any]

classmethod from_orm(obj)[source]

Return type:: Self

json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)[source]

Return type:: str

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}[source]: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'protected_namespaces': ()}[source]: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod model_construct(_fields_set=None, **values)[source]

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note: model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == 'allow', then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == 'ignore' (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == 'forbid' does not result in an error if extra values are passed, but they will be ignored.

Parameters:

_fields_set (set[str] | None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.
values (Any) – Trusted or pre-validated data dictionary.

Return type:

Self

Returns:

A new instance of the Model class with validated data.

model_copy(*, update=None, deep=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy

Returns a copy of the model.

Parameters:

update (dict[str, Any] | None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.
deep (bool) – Set to True to make a deep copy of the model.

Return type:

Self

Returns:

New model instance.

model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters:

mode (Union[Literal['json', 'python'], str]) – The mode in which to_python 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.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to include in the output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to exclude from the output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to use the field’s alias in the dictionary key if defined.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A dictionary representation of the model.

model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

Generates a JSON representation of the model using Pydantic’s to_json method.

Parameters:

indent (int | None) – Indentation to use in the JSON output. If None is passed, the output will be compact.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to include in the JSON output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to exclude from the JSON output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to serialize using field aliases.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A JSON string representation of the model.

property model_extra: dict[str, Any] | None[source]

Get extra fields set during validation.

Returns:: A dictionary of extra fields, or None if config.extra is not set to "allow".

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=FaceGetPosition, required=True), 'type': FieldInfo(annotation=Literal['face_get_position'], required=False, default='face_get_position')}[source]

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

property model_fields_set: set[str][source]

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,: i.e. that were not filled from defaults.

classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')[source]

Generates a JSON schema for a model class.

Parameters:

by_alias (bool) – Whether to use attribute aliases or not.
ref_template (str) – The reference template.
schema_generator (type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modifications
mode (Literal['validation', 'serialization']) – The mode in which to generate the schema.

Return type:

Returns:

The JSON schema for the given model class.

classmethod model_parametrized_name(params)[source]

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

Parameters:: params (tuple[type[Any], ...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.
Return type:: str
Returns:: String representing the new class where params are passed to cls as type variables.
Raises:: TypeError – Raised when trying to generate concrete names for non-generic models.

model_post_init(_BaseModel__context)[source]

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

Return type:: None

classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)[source]

Try to rebuild the pydantic-core schema for the model.

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.

Parameters:

force (bool) – Whether to force the rebuilding of the model schema, defaults to False.
raise_errors (bool) – Whether to raise errors, defaults to True.
_parent_namespace_depth (int) – The depth level of the parent namespace, defaults to 2.
_types_namespace (dict[str, Any] | None) – The types namespace, defaults to None.

Return type:

Returns:

Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.

classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)[source]

Validate a pydantic model instance.

Parameters:

obj (Any) – The object to validate.
strict (bool | None) – Whether to enforce types strictly.
from_attributes (bool | None) – Whether to extract data from object attributes.
context (Any | None) – Additional context to pass to the validator.

Raises:

ValidationError – If the object could not be validated.

Return type:

Self

Returns:

The validated model instance.

classmethod model_validate_json(json_data, *, strict=None, context=None)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing

Validate the given JSON data against the Pydantic model.

Parameters:

json_data (str | bytes | bytearray) – The JSON data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

Raises:

ValidationError – If json_data is not a JSON string or the object could not be validated.

classmethod model_validate_strings(obj, *, strict=None, context=None)[source]

Validate the given object with string data against the Pydantic model.

Parameters:

obj (Any) – The object containing string data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod parse_obj(obj)[source]

Return type:: Self

classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod schema(by_alias=True, ref_template='#/$defs/{model}')[source]

Return type:: Dict[str, Any]

classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)[source]

Return type:: str

type: Literal['face_get_position'][source]

classmethod update_forward_refs(**localns)[source]

Return type:: None

classmethod validate(value)[source]

Return type:: Self

class kittycad.models.ok_modeling_cmd_response.OptionFaceIsPlanar(**data)[source][source]

The response to the ‘FaceIsPlanar’ endpoint

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__abstractmethods__ = frozenset({})[source]

__annotations__ = {'__class_vars__': 'ClassVar[set[str]]', '__private_attributes__': 'ClassVar[Dict[str, ModelPrivateAttr]]', '__pydantic_complete__': 'ClassVar[bool]', '__pydantic_core_schema__': 'ClassVar[CoreSchema]', '__pydantic_custom_init__': 'ClassVar[bool]', '__pydantic_decorators__': 'ClassVar[_decorators.DecoratorInfos]', '__pydantic_extra__': 'dict[str, Any] | None', '__pydantic_fields_set__': 'set[str]', '__pydantic_generic_metadata__': 'ClassVar[_generics.PydanticGenericMetadata]', '__pydantic_parent_namespace__': 'ClassVar[Dict[str, Any] | None]', '__pydantic_post_init__': "ClassVar[None | Literal['model_post_init']]", '__pydantic_private__': 'dict[str, Any] | None', '__pydantic_root_model__': 'ClassVar[bool]', '__pydantic_serializer__': 'ClassVar[SchemaSerializer]', '__pydantic_validator__': 'ClassVar[SchemaValidator | PluggableSchemaValidator]', '__signature__': 'ClassVar[Signature]', 'data': <class 'kittycad.models.face_is_planar.FaceIsPlanar'>, 'model_computed_fields': 'ClassVar[Dict[str, ComputedFieldInfo]]', 'model_config': 'ClassVar[ConfigDict]', 'model_fields': 'ClassVar[Dict[str, FieldInfo]]', 'type': typing.Literal['face_is_planar']}[source]

classmethod __class_getitem__(typevar_values)[source]

Return type:: type[BaseModel] | PydanticRecursiveRef

__class_vars__: ClassVar[set[str]] = {}[source]: The names of the class variables defined on the model.

__copy__()[source]

Returns a shallow copy of the model.

Return type:: Self

__deepcopy__(memo=None)[source]

Returns a deep copy of the model.

Return type:: Self

__delattr__(item)[source]

Implement delattr(self, name).

Return type:: Any

__dict__[source]

__eq__(other)[source]

Return self==value.

Return type:: bool

property __fields_set__: set[str][source]

classmethod __get_pydantic_core_schema__(source, handler, /)[source]

Hook into generating the model’s CoreSchema.

Parameters:

source (type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.
handler (GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.

Return type:

Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]

Returns:

A pydantic-core CoreSchema.

classmethod __get_pydantic_json_schema__(core_schema, handler, /)[source]

Hook into generating the model’s JSON schema.

Parameters:

core_schema (Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({'type': 'nullable', 'schema': current_schema}), or just call the handler with the original schema.
handler (GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.

Return type:

Returns:

A JSON schema, as a Python object.

__getattr__(item)[source]

Return type:: Any

__getstate__()[source]

Helper for pickle.

Return type:: dict[Any, Any]

__hash__ = None[source]

__init__(**data)[source]

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__iter__()[source]

So dict(model) works.

Return type:: Generator[Tuple[str, Any], None, None]

__module__ = 'kittycad.models.ok_modeling_cmd_response'[source]

__pretty__(fmt, **kwargs)[source]

Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.

Return type:: Generator[Any, None, None]

__private_attributes__: ClassVar[Dict[str, ModelPrivateAttr]] = {}[source]: Metadata about the private attributes of the model.

__pydantic_complete__: ClassVar[bool] = True[source]: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__: ClassVar[CoreSchema] = {'definitions': [{'cls': <class 'kittycad.models.point3d.Point3d'>, 'config': {'title': 'Point3d'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.point3d.Point3d'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.point3d.Point3d'>>]}, 'ref': 'kittycad.models.point3d.Point3d:94667194426368', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'x': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'type': 'float'}, 'type': 'model-field'}, 'y': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'type': 'float'}, 'type': 'model-field'}, 'z': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'type': 'float'}, 'type': 'model-field'}}, 'model_name': 'Point3d', 'type': 'model-fields'}, 'type': 'model'}], 'schema': {'cls': <class 'kittycad.models.ok_modeling_cmd_response.OptionFaceIsPlanar'>, 'config': {'title': 'OptionFaceIsPlanar'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.ok_modeling_cmd_response.OptionFaceIsPlanar'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.ok_modeling_cmd_response.OptionFaceIsPlanar'>>]}, 'ref': 'kittycad.models.ok_modeling_cmd_response.OptionFaceIsPlanar:94667213819776', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'data': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.face_is_planar.FaceIsPlanar'>, 'config': {'title': 'FaceIsPlanar'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.face_is_planar.FaceIsPlanar'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.face_is_planar.FaceIsPlanar'>>]}, 'ref': 'kittycad.models.face_is_planar.FaceIsPlanar:94667206546000', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'origin': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': None, 'schema': {'schema': {'schema_ref': 'kittycad.models.point3d.Point3d:94667194426368', 'type': 'definition-ref'}, 'type': 'nullable'}, 'type': 'default'}, 'type': 'model-field'}, 'x_axis': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': None, 'schema': {'schema': {'schema_ref': 'kittycad.models.point3d.Point3d:94667194426368', 'type': 'definition-ref'}, 'type': 'nullable'}, 'type': 'default'}, 'type': 'model-field'}, 'y_axis': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': None, 'schema': {'schema': {'schema_ref': 'kittycad.models.point3d.Point3d:94667194426368', 'type': 'definition-ref'}, 'type': 'nullable'}, 'type': 'default'}, 'type': 'model-field'}, 'z_axis': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': None, 'schema': {'schema': {'schema_ref': 'kittycad.models.point3d.Point3d:94667194426368', 'type': 'definition-ref'}, 'type': 'nullable'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'FaceIsPlanar', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}, 'type': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': 'face_is_planar', 'schema': {'expected': ['face_is_planar'], 'type': 'literal'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'OptionFaceIsPlanar', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'definitions'}[source]: The core schema of the model.

__pydantic_custom_init__: ClassVar[bool] = False[source]: Whether the model has a custom __init__ method.

__pydantic_decorators__: ClassVar[_decorators.DecoratorInfos] = DecoratorInfos(validators={}, field_validators={}, root_validators={}, field_serializers={}, model_serializers={}, model_validators={}, computed_fields={})[source]: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_extra__: dict[str, Any] | None[source]: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to 'allow'.

__pydantic_fields_set__: set[str][source]: The names of fields explicitly set during instantiation.

__pydantic_generic_metadata__: ClassVar[_generics.PydanticGenericMetadata] = {'args': (), 'origin': None, 'parameters': ()}[source]: 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.

classmethod __pydantic_init_subclass__(**kwargs)[source]

This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.

This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.

This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.

Parameters:: **kwargs (Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.
Return type:: None

__pydantic_parent_namespace__: ClassVar[Dict[str, Any] | None] = None[source]: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__: ClassVar[None | Literal['model_post_init']] = None[source]: The name of the post-init method for the model, if defined.

__pydantic_private__: dict[str, Any] | None[source]: Values of private attributes set on the model instance.

__pydantic_root_model__: ClassVar[bool] = False[source]: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__: ClassVar[SchemaSerializer] = SchemaSerializer(serializer=Model( ModelSerializer { class: Py( 0x000056196da6cf80, ), serializer: Fields( GeneralFieldsSerializer { fields: { "type": SerField { key_py: Py( 0x00007f903823d958, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f90347f5ab0, ), ), serializer: Literal( LiteralSerializer { expected_int: {}, expected_str: { "face_is_planar", }, expected_py: None, name: "literal['face_is_planar']", }, ), }, ), ), required: true, }, "data": SerField { key_py: Py( 0x00007f9038238fa0, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196d37d250, ), serializer: Fields( GeneralFieldsSerializer { fields: { "origin": SerField { key_py: Py( 0x00007f903823bdc0, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f9038148100, ), ), serializer: Nullable( NullableSerializer { serializer: Recursive( DefinitionRefSerializer { definition: "...", retry_with_lax_check: true, }, ), }, ), }, ), ), required: true, }, "y_axis": SerField { key_py: Py( 0x00007f90339516b0, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f9038148100, ), ), serializer: Nullable( NullableSerializer { serializer: Recursive( DefinitionRefSerializer { definition: "...", retry_with_lax_check: true, }, ), }, ), }, ), ), required: true, }, "x_axis": SerField { key_py: Py( 0x00007f90339515c0, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f9038148100, ), ), serializer: Nullable( NullableSerializer { serializer: Recursive( DefinitionRefSerializer { definition: "...", retry_with_lax_check: true, }, ), }, ), }, ), ), required: true, }, "z_axis": SerField { key_py: Py( 0x00007f90339517a0, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f9038148100, ), ), serializer: Nullable( NullableSerializer { serializer: Recursive( DefinitionRefSerializer { definition: "...", retry_with_lax_check: true, }, ), }, ), }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 4, }, ), has_extra: false, root_model: false, name: "FaceIsPlanar", }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "OptionFaceIsPlanar", }, ), definitions=[Model(ModelSerializer { class: Py(0x56196c7ee400), serializer: Fields(GeneralFieldsSerializer { fields: {"y": SerField { key_py: Py(0x7f903823f558), alias: None, alias_py: None, serializer: Some(Float(FloatSerializer { inf_nan_mode: Null })), required: true }, "z": SerField { key_py: Py(0x7f903823f588), alias: None, alias_py: None, serializer: Some(Float(FloatSerializer { inf_nan_mode: Null })), required: true }, "x": SerField { key_py: Py(0x7f903823de18), alias: None, alias_py: None, serializer: Some(Float(FloatSerializer { inf_nan_mode: Null })), required: true }}, computed_fields: Some(ComputedFields([])), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None }, required_fields: 3 }), has_extra: false, root_model: false, name: "Point3d" })])[source]: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__: ClassVar[SchemaValidator | PluggableSchemaValidator] = SchemaValidator(title="OptionFaceIsPlanar", validator=Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "data", lookup_key: Simple { key: "data", py_key: Py( 0x00007f903336ebb0, ), path: LookupPath( [ S( "data", Py( 0x00007f903336c7e0, ), ), ], ), }, name_py: Py( 0x00007f9038238fa0, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "origin", lookup_key: Simple { key: "origin", py_key: Py( 0x00007f903336f030, ), path: LookupPath( [ S( "origin", Py( 0x00007f903336e5e0, ), ), ], ), }, name_py: Py( 0x00007f903823bdc0, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f9038148100, ), ), on_error: Raise, validator: Nullable( NullableValidator { validator: DefinitionRef( DefinitionRefValidator { definition: "Point3d", }, ), name: "nullable[Point3d]", }, ), validate_default: false, copy_default: false, name: "default[nullable[Point3d]]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, Field { name: "x_axis", lookup_key: Simple { key: "x_axis", py_key: Py( 0x00007f903336ea60, ), path: LookupPath( [ S( "x_axis", Py( 0x00007f903336edc0, ), ), ], ), }, name_py: Py( 0x00007f90339515c0, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f9038148100, ), ), on_error: Raise, validator: Nullable( NullableValidator { validator: DefinitionRef( DefinitionRefValidator { definition: "Point3d", }, ), name: "nullable[Point3d]", }, ), validate_default: false, copy_default: false, name: "default[nullable[Point3d]]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, Field { name: "y_axis", lookup_key: Simple { key: "y_axis", py_key: Py( 0x00007f903336ef40, ), path: LookupPath( [ S( "y_axis", Py( 0x00007f903336f0f0, ), ), ], ), }, name_py: Py( 0x00007f90339516b0, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f9038148100, ), ), on_error: Raise, validator: Nullable( NullableValidator { validator: DefinitionRef( DefinitionRefValidator { definition: "Point3d", }, ), name: "nullable[Point3d]", }, ), validate_default: false, copy_default: false, name: "default[nullable[Point3d]]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, Field { name: "z_axis", lookup_key: Simple { key: "z_axis", py_key: Py( 0x00007f903336f060, ), path: LookupPath( [ S( "z_axis", Py( 0x00007f903336ec40, ), ), ], ), }, name_py: Py( 0x00007f90339517a0, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f9038148100, ), ), on_error: Raise, validator: Nullable( NullableValidator { validator: DefinitionRef( DefinitionRefValidator { definition: "Point3d", }, ), name: "nullable[Point3d]", }, ), validate_default: false, copy_default: false, name: "default[nullable[Point3d]]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "FaceIsPlanar", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d37d250, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "FaceIsPlanar", }, ), frozen: false, }, Field { name: "type", lookup_key: Simple { key: "type", py_key: Py( 0x00007f903336e5b0, ), path: LookupPath( [ S( "type", Py( 0x00007f903336d200, ), ), ], ), }, name_py: Py( 0x00007f903823d958, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f90347f5ab0, ), ), on_error: Raise, validator: Literal( LiteralValidator { lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "face_is_planar": 0, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f90347f5ab0, ), ], }, expected_repr: "'face_is_planar'", name: "literal['face_is_planar']", }, ), validate_default: false, copy_default: false, name: "default[literal['face_is_planar']]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "OptionFaceIsPlanar", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196da6cf80, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "OptionFaceIsPlanar", }, ), definitions=[Model(ModelValidator { revalidate: Never, validator: ModelFields(ModelFieldsValidator { fields: [Field { name: "x", lookup_key: Simple { key: "x", py_key: Py(0x7f903823f528), path: LookupPath([S("x", Py(0x7f903823f528))]) }, name_py: Py(0x7f903823de18), validator: Float(FloatValidator { strict: false, allow_inf_nan: true }), frozen: false }, Field { name: "y", lookup_key: Simple { key: "y", py_key: Py(0x7f903823f558), path: LookupPath([S("y", Py(0x7f903823f558))]) }, name_py: Py(0x7f903823f558), validator: Float(FloatValidator { strict: false, allow_inf_nan: true }), frozen: false }, Field { name: "z", lookup_key: Simple { key: "z", py_key: Py(0x7f903823f588), path: LookupPath([S("z", Py(0x7f903823f588))]) }, name_py: Py(0x7f903823f588), validator: Float(FloatValidator { strict: false, allow_inf_nan: true }), frozen: false }], model_name: "Point3d", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true }), class: Py(0x56196c7ee400), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py(0x7f903629a320), name: "Point3d" })], cache_strings=True)[source]: The pydantic-core SchemaValidator used to validate instances of the model.

__repr__()[source]

Return repr(self).

Return type:: str

__repr_args__()[source]

Return type:: Iterable[tuple[str | None, Any]]

__repr_name__()[source]

Name of the instance’s class, used in __repr__.

Return type:: str

__repr_str__(join_str)[source]

Return type:: str

__rich_repr__()[source]

Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.

Return type:: Iterable[Any | tuple[Any] | tuple[str, Any] | tuple[str, Any, Any]]

__setattr__(name, value)[source]

Implement setattr(self, name, value).

Return type:: None

__setstate__(state)[source]

Return type:: None

__signature__: ClassVar[Signature] = <Signature (*, data: kittycad.models.face_is_planar.FaceIsPlanar, type: Literal['face_is_planar'] = 'face_is_planar') -> None>[source]: The synthesized __init__ [Signature][inspect.Signature] of the model.

__slots__ = ('__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__')[source]

__str__()[source]

Return str(self).

Return type:: str

_abc_impl = <_abc._abc_data object>[source]

_calculate_keys(*args, **kwargs)[source]

Return type:: Any

_check_frozen(name, value)[source]

Return type:: None

_copy_and_set_values(*args, **kwargs)[source]

Return type:: Any

classmethod _get_value(*args, **kwargs)[source]

Return type:: Any

_iter(*args, **kwargs)[source]

Return type:: Any

classmethod construct(_fields_set=None, **values)[source]

Return type:: Self

copy(*, include=None, exclude=None, update=None, deep=False)[source]

Returns a copy of the model.

!!! warning “Deprecated”: This method is now deprecated; use model_copy instead.

If you need include or exclude, use:

`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `

Parameters:

include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.

Returns:

A copy of the model with included, excluded and updated fields as specified.

data: FaceIsPlanar[source]

dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)[source]

Return type:: Dict[str, Any]

classmethod from_orm(obj)[source]

Return type:: Self

json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)[source]

Return type:: str

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}[source]: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'protected_namespaces': ()}[source]: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod model_construct(_fields_set=None, **values)[source]

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note: model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == 'allow', then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == 'ignore' (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == 'forbid' does not result in an error if extra values are passed, but they will be ignored.

Parameters:

_fields_set (set[str] | None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.
values (Any) – Trusted or pre-validated data dictionary.

Return type:

Self

Returns:

A new instance of the Model class with validated data.

model_copy(*, update=None, deep=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy

Returns a copy of the model.

Parameters:

update (dict[str, Any] | None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.
deep (bool) – Set to True to make a deep copy of the model.

Return type:

Self

Returns:

New model instance.

model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters:

mode (Union[Literal['json', 'python'], str]) – The mode in which to_python 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.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to include in the output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to exclude from the output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to use the field’s alias in the dictionary key if defined.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A dictionary representation of the model.

model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

Generates a JSON representation of the model using Pydantic’s to_json method.

Parameters:

indent (int | None) – Indentation to use in the JSON output. If None is passed, the output will be compact.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to include in the JSON output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to exclude from the JSON output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to serialize using field aliases.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A JSON string representation of the model.

property model_extra: dict[str, Any] | None[source]

Get extra fields set during validation.

Returns:: A dictionary of extra fields, or None if config.extra is not set to "allow".

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=FaceIsPlanar, required=True), 'type': FieldInfo(annotation=Literal['face_is_planar'], required=False, default='face_is_planar')}[source]

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

property model_fields_set: set[str][source]

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,: i.e. that were not filled from defaults.

classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')[source]

Generates a JSON schema for a model class.

Parameters:

by_alias (bool) – Whether to use attribute aliases or not.
ref_template (str) – The reference template.
schema_generator (type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modifications
mode (Literal['validation', 'serialization']) – The mode in which to generate the schema.

Return type:

Returns:

The JSON schema for the given model class.

classmethod model_parametrized_name(params)[source]

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

Parameters:: params (tuple[type[Any], ...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.
Return type:: str
Returns:: String representing the new class where params are passed to cls as type variables.
Raises:: TypeError – Raised when trying to generate concrete names for non-generic models.

model_post_init(_BaseModel__context)[source]

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

Return type:: None

classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)[source]

Try to rebuild the pydantic-core schema for the model.

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.

Parameters:

force (bool) – Whether to force the rebuilding of the model schema, defaults to False.
raise_errors (bool) – Whether to raise errors, defaults to True.
_parent_namespace_depth (int) – The depth level of the parent namespace, defaults to 2.
_types_namespace (dict[str, Any] | None) – The types namespace, defaults to None.

Return type:

Returns:

Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.

classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)[source]

Validate a pydantic model instance.

Parameters:

obj (Any) – The object to validate.
strict (bool | None) – Whether to enforce types strictly.
from_attributes (bool | None) – Whether to extract data from object attributes.
context (Any | None) – Additional context to pass to the validator.

Raises:

ValidationError – If the object could not be validated.

Return type:

Self

Returns:

The validated model instance.

classmethod model_validate_json(json_data, *, strict=None, context=None)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing

Validate the given JSON data against the Pydantic model.

Parameters:

json_data (str | bytes | bytearray) – The JSON data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

Raises:

ValidationError – If json_data is not a JSON string or the object could not be validated.

classmethod model_validate_strings(obj, *, strict=None, context=None)[source]

Validate the given object with string data against the Pydantic model.

Parameters:

obj (Any) – The object containing string data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod parse_obj(obj)[source]

Return type:: Self

classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod schema(by_alias=True, ref_template='#/$defs/{model}')[source]

Return type:: Dict[str, Any]

classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)[source]

Return type:: str

type: Literal['face_is_planar'][source]

classmethod update_forward_refs(**localns)[source]

Return type:: None

classmethod validate(value)[source]

Return type:: Self

class kittycad.models.ok_modeling_cmd_response.OptionGetEntityType(**data)[source][source]

The response to the ‘GetEntityType’ endpoint

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__abstractmethods__ = frozenset({})[source]

__annotations__ = {'__class_vars__': 'ClassVar[set[str]]', '__private_attributes__': 'ClassVar[Dict[str, ModelPrivateAttr]]', '__pydantic_complete__': 'ClassVar[bool]', '__pydantic_core_schema__': 'ClassVar[CoreSchema]', '__pydantic_custom_init__': 'ClassVar[bool]', '__pydantic_decorators__': 'ClassVar[_decorators.DecoratorInfos]', '__pydantic_extra__': 'dict[str, Any] | None', '__pydantic_fields_set__': 'set[str]', '__pydantic_generic_metadata__': 'ClassVar[_generics.PydanticGenericMetadata]', '__pydantic_parent_namespace__': 'ClassVar[Dict[str, Any] | None]', '__pydantic_post_init__': "ClassVar[None | Literal['model_post_init']]", '__pydantic_private__': 'dict[str, Any] | None', '__pydantic_root_model__': 'ClassVar[bool]', '__pydantic_serializer__': 'ClassVar[SchemaSerializer]', '__pydantic_validator__': 'ClassVar[SchemaValidator | PluggableSchemaValidator]', '__signature__': 'ClassVar[Signature]', 'data': <class 'kittycad.models.get_entity_type.GetEntityType'>, 'model_computed_fields': 'ClassVar[Dict[str, ComputedFieldInfo]]', 'model_config': 'ClassVar[ConfigDict]', 'model_fields': 'ClassVar[Dict[str, FieldInfo]]', 'type': typing.Literal['get_entity_type']}[source]

classmethod __class_getitem__(typevar_values)[source]

Return type:: type[BaseModel] | PydanticRecursiveRef

__class_vars__: ClassVar[set[str]] = {}[source]: The names of the class variables defined on the model.

__copy__()[source]

Returns a shallow copy of the model.

Return type:: Self

__deepcopy__(memo=None)[source]

Returns a deep copy of the model.

Return type:: Self

__delattr__(item)[source]

Implement delattr(self, name).

Return type:: Any

__dict__[source]

__eq__(other)[source]

Return self==value.

Return type:: bool

property __fields_set__: set[str][source]

classmethod __get_pydantic_core_schema__(source, handler, /)[source]

Hook into generating the model’s CoreSchema.

Parameters:

source (type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.
handler (GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.

Return type:

Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]

Returns:

A pydantic-core CoreSchema.

classmethod __get_pydantic_json_schema__(core_schema, handler, /)[source]

Hook into generating the model’s JSON schema.

Parameters:

core_schema (Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({'type': 'nullable', 'schema': current_schema}), or just call the handler with the original schema.
handler (GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.

Return type:

Returns:

A JSON schema, as a Python object.

__getattr__(item)[source]

Return type:: Any

__getstate__()[source]

Helper for pickle.

Return type:: dict[Any, Any]

__hash__ = None[source]

__init__(**data)[source]

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__iter__()[source]

So dict(model) works.

Return type:: Generator[Tuple[str, Any], None, None]

__module__ = 'kittycad.models.ok_modeling_cmd_response'[source]

__pretty__(fmt, **kwargs)[source]

Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.

Return type:: Generator[Any, None, None]

__private_attributes__: ClassVar[Dict[str, ModelPrivateAttr]] = {}[source]: Metadata about the private attributes of the model.

__pydantic_complete__: ClassVar[bool] = True[source]: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__: ClassVar[CoreSchema] = {'cls': <class 'kittycad.models.ok_modeling_cmd_response.OptionGetEntityType'>, 'config': {'title': 'OptionGetEntityType'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.ok_modeling_cmd_response.OptionGetEntityType'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.ok_modeling_cmd_response.OptionGetEntityType'>>]}, 'ref': 'kittycad.models.ok_modeling_cmd_response.OptionGetEntityType:94667213649888', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'data': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.get_entity_type.GetEntityType'>, 'config': {'title': 'GetEntityType'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.get_entity_type.GetEntityType'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.get_entity_type.GetEntityType'>>]}, 'ref': 'kittycad.models.get_entity_type.GetEntityType:94667206946032', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'entity_type': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <enum 'EntityType'>, 'members': [EntityType.ENTITY, EntityType.OBJECT, EntityType.PATH, EntityType.CURVE, EntityType.SOLID2D, EntityType.SOLID3D, EntityType.EDGE, EntityType.FACE, EntityType.PLANE, EntityType.VERTEX], 'metadata': {'pydantic_js_functions': [<function GenerateSchema._enum_schema.<locals>.get_json_schema>]}, 'ref': 'kittycad.models.entity_type.EntityType:94667206260016', 'sub_type': 'str', 'type': 'enum'}, 'type': 'model-field'}}, 'model_name': 'GetEntityType', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}, 'type': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': 'get_entity_type', 'schema': {'expected': ['get_entity_type'], 'type': 'literal'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'OptionGetEntityType', 'type': 'model-fields'}, 'type': 'model'}[source]: The core schema of the model.

__pydantic_custom_init__: ClassVar[bool] = False[source]: Whether the model has a custom __init__ method.

__pydantic_decorators__: ClassVar[_decorators.DecoratorInfos] = DecoratorInfos(validators={}, field_validators={}, root_validators={}, field_serializers={}, model_serializers={}, model_validators={}, computed_fields={})[source]: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_extra__: dict[str, Any] | None[source]: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to 'allow'.

__pydantic_fields_set__: set[str][source]: The names of fields explicitly set during instantiation.

__pydantic_generic_metadata__: ClassVar[_generics.PydanticGenericMetadata] = {'args': (), 'origin': None, 'parameters': ()}[source]: 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.

classmethod __pydantic_init_subclass__(**kwargs)[source]

This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.

This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.

This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.

Parameters:: **kwargs (Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.
Return type:: None

__pydantic_parent_namespace__: ClassVar[Dict[str, Any] | None] = None[source]: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__: ClassVar[None | Literal['model_post_init']] = None[source]: The name of the post-init method for the model, if defined.

__pydantic_private__: dict[str, Any] | None[source]: Values of private attributes set on the model instance.

__pydantic_root_model__: ClassVar[bool] = False[source]: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__: ClassVar[SchemaSerializer] = SchemaSerializer(serializer=Model( ModelSerializer { class: Py( 0x000056196da437e0, ), serializer: Fields( GeneralFieldsSerializer { fields: { "type": SerField { key_py: Py( 0x00007f903823d958, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f90347f7170, ), ), serializer: Literal( LiteralSerializer { expected_int: {}, expected_str: { "get_entity_type", }, expected_py: None, name: "literal['get_entity_type']", }, ), }, ), ), required: true, }, "data": SerField { key_py: Py( 0x00007f9038238fa0, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196d3decf0, ), serializer: Fields( GeneralFieldsSerializer { fields: { "entity_type": SerField { key_py: Py( 0x00007f90347d72b0, ), alias: None, alias_py: None, serializer: Some( Enum( EnumSerializer { class: Py( 0x000056196d337530, ), serializer: Some( Str( StrSerializer, ), ), }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 1, }, ), has_extra: false, root_model: false, name: "GetEntityType", }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "OptionGetEntityType", }, ), definitions=[])[source]: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__: ClassVar[SchemaValidator | PluggableSchemaValidator] = SchemaValidator(title="OptionGetEntityType", validator=Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "data", lookup_key: Simple { key: "data", py_key: Py( 0x00007f903336ee20, ), path: LookupPath( [ S( "data", Py( 0x00007f903336ee50, ), ), ], ), }, name_py: Py( 0x00007f9038238fa0, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "entity_type", lookup_key: Simple { key: "entity_type", py_key: Py( 0x00007f9033390a70, ), path: LookupPath( [ S( "entity_type", Py( 0x00007f9033390a30, ), ), ], ), }, name_py: Py( 0x00007f90347d72b0, ), validator: StrEnum( EnumValidator { phantom: PhantomData<_pydantic_core::validators::enum_::StrEnumValidator>, class: Py( 0x000056196d337530, ), lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "solid2d": 4, "vertex": 9, "curve": 3, "face": 7, "edge": 6, "plane": 8, "path": 2, "object": 1, "entity": 0, "solid3d": 5, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f903392c230, ), Py( 0x00007f903392c290, ), Py( 0x00007f903392c2f0, ), Py( 0x00007f903392c350, ), Py( 0x00007f903392c3b0, ), Py( 0x00007f903392c410, ), Py( 0x00007f903392c470, ), Py( 0x00007f903392c4d0, ), Py( 0x00007f903392c530, ), Py( 0x00007f903392c590, ), ], }, missing: None, expected_repr: "'entity', 'object', 'path', 'curve', 'solid2d', 'solid3d', 'edge', 'face', 'plane' or 'vertex'", strict: false, class_repr: "EntityType", name: "str-enum[EntityType]", }, ), frozen: false, }, ], model_name: "GetEntityType", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d3decf0, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "GetEntityType", }, ), frozen: false, }, Field { name: "type", lookup_key: Simple { key: "type", py_key: Py( 0x00007f903336ee80, ), path: LookupPath( [ S( "type", Py( 0x00007f903336eeb0, ), ), ], ), }, name_py: Py( 0x00007f903823d958, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f90347f7170, ), ), on_error: Raise, validator: Literal( LiteralValidator { lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "get_entity_type": 0, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f90347f7170, ), ], }, expected_repr: "'get_entity_type'", name: "literal['get_entity_type']", }, ), validate_default: false, copy_default: false, name: "default[literal['get_entity_type']]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "OptionGetEntityType", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196da437e0, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "OptionGetEntityType", }, ), definitions=[], cache_strings=True)[source]: The pydantic-core SchemaValidator used to validate instances of the model.

__repr__()[source]

Return repr(self).

Return type:: str

__repr_args__()[source]

Return type:: Iterable[tuple[str | None, Any]]

__repr_name__()[source]

Name of the instance’s class, used in __repr__.

Return type:: str

__repr_str__(join_str)[source]

Return type:: str

__rich_repr__()[source]

Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.

Return type:: Iterable[Any | tuple[Any] | tuple[str, Any] | tuple[str, Any, Any]]

__setattr__(name, value)[source]

Implement setattr(self, name, value).

Return type:: None

__setstate__(state)[source]

Return type:: None

__signature__: ClassVar[Signature] = <Signature (*, data: kittycad.models.get_entity_type.GetEntityType, type: Literal['get_entity_type'] = 'get_entity_type') -> None>[source]: The synthesized __init__ [Signature][inspect.Signature] of the model.

__slots__ = ('__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__')[source]

__str__()[source]

Return str(self).

Return type:: str

_abc_impl = <_abc._abc_data object>[source]

_calculate_keys(*args, **kwargs)[source]

Return type:: Any

_check_frozen(name, value)[source]

Return type:: None

_copy_and_set_values(*args, **kwargs)[source]

Return type:: Any

classmethod _get_value(*args, **kwargs)[source]

Return type:: Any

_iter(*args, **kwargs)[source]

Return type:: Any

classmethod construct(_fields_set=None, **values)[source]

Return type:: Self

copy(*, include=None, exclude=None, update=None, deep=False)[source]

Returns a copy of the model.

!!! warning “Deprecated”: This method is now deprecated; use model_copy instead.

If you need include or exclude, use:

`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `

Parameters:

include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.

Returns:

A copy of the model with included, excluded and updated fields as specified.

data: GetEntityType[source]

dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)[source]

Return type:: Dict[str, Any]

classmethod from_orm(obj)[source]

Return type:: Self

json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)[source]

Return type:: str

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}[source]: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'protected_namespaces': ()}[source]: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod model_construct(_fields_set=None, **values)[source]

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note: model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == 'allow', then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == 'ignore' (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == 'forbid' does not result in an error if extra values are passed, but they will be ignored.

Parameters:

_fields_set (set[str] | None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.
values (Any) – Trusted or pre-validated data dictionary.

Return type:

Self

Returns:

A new instance of the Model class with validated data.

model_copy(*, update=None, deep=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy

Returns a copy of the model.

Parameters:

update (dict[str, Any] | None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.
deep (bool) – Set to True to make a deep copy of the model.

Return type:

Self

Returns:

New model instance.

model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters:

mode (Union[Literal['json', 'python'], str]) – The mode in which to_python 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.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to include in the output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to exclude from the output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to use the field’s alias in the dictionary key if defined.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A dictionary representation of the model.

model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

Generates a JSON representation of the model using Pydantic’s to_json method.

Parameters:

indent (int | None) – Indentation to use in the JSON output. If None is passed, the output will be compact.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to include in the JSON output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to exclude from the JSON output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to serialize using field aliases.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A JSON string representation of the model.

property model_extra: dict[str, Any] | None[source]

Get extra fields set during validation.

Returns:: A dictionary of extra fields, or None if config.extra is not set to "allow".

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=GetEntityType, required=True), 'type': FieldInfo(annotation=Literal['get_entity_type'], required=False, default='get_entity_type')}[source]

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

property model_fields_set: set[str][source]

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,: i.e. that were not filled from defaults.

classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')[source]

Generates a JSON schema for a model class.

Parameters:

by_alias (bool) – Whether to use attribute aliases or not.
ref_template (str) – The reference template.
schema_generator (type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modifications
mode (Literal['validation', 'serialization']) – The mode in which to generate the schema.

Return type:

Returns:

The JSON schema for the given model class.

classmethod model_parametrized_name(params)[source]

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

Parameters:: params (tuple[type[Any], ...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.
Return type:: str
Returns:: String representing the new class where params are passed to cls as type variables.
Raises:: TypeError – Raised when trying to generate concrete names for non-generic models.

model_post_init(_BaseModel__context)[source]

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

Return type:: None

classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)[source]

Try to rebuild the pydantic-core schema for the model.

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.

Parameters:

force (bool) – Whether to force the rebuilding of the model schema, defaults to False.
raise_errors (bool) – Whether to raise errors, defaults to True.
_parent_namespace_depth (int) – The depth level of the parent namespace, defaults to 2.
_types_namespace (dict[str, Any] | None) – The types namespace, defaults to None.

Return type:

Returns:

Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.

classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)[source]

Validate a pydantic model instance.

Parameters:

obj (Any) – The object to validate.
strict (bool | None) – Whether to enforce types strictly.
from_attributes (bool | None) – Whether to extract data from object attributes.
context (Any | None) – Additional context to pass to the validator.

Raises:

ValidationError – If the object could not be validated.

Return type:

Self

Returns:

The validated model instance.

classmethod model_validate_json(json_data, *, strict=None, context=None)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing

Validate the given JSON data against the Pydantic model.

Parameters:

json_data (str | bytes | bytearray) – The JSON data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

Raises:

ValidationError – If json_data is not a JSON string or the object could not be validated.

classmethod model_validate_strings(obj, *, strict=None, context=None)[source]

Validate the given object with string data against the Pydantic model.

Parameters:

obj (Any) – The object containing string data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod parse_obj(obj)[source]

Return type:: Self

classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod schema(by_alias=True, ref_template='#/$defs/{model}')[source]

Return type:: Dict[str, Any]

classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)[source]

Return type:: str

type: Literal['get_entity_type'][source]

classmethod update_forward_refs(**localns)[source]

Return type:: None

classmethod validate(value)[source]

Return type:: Self

class kittycad.models.ok_modeling_cmd_response.OptionGetNumObjects(**data)[source][source]

The response to the ‘GetNumObjects’ endpoint

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__abstractmethods__ = frozenset({})[source]

__annotations__ = {'__class_vars__': 'ClassVar[set[str]]', '__private_attributes__': 'ClassVar[Dict[str, ModelPrivateAttr]]', '__pydantic_complete__': 'ClassVar[bool]', '__pydantic_core_schema__': 'ClassVar[CoreSchema]', '__pydantic_custom_init__': 'ClassVar[bool]', '__pydantic_decorators__': 'ClassVar[_decorators.DecoratorInfos]', '__pydantic_extra__': 'dict[str, Any] | None', '__pydantic_fields_set__': 'set[str]', '__pydantic_generic_metadata__': 'ClassVar[_generics.PydanticGenericMetadata]', '__pydantic_parent_namespace__': 'ClassVar[Dict[str, Any] | None]', '__pydantic_post_init__': "ClassVar[None | Literal['model_post_init']]", '__pydantic_private__': 'dict[str, Any] | None', '__pydantic_root_model__': 'ClassVar[bool]', '__pydantic_serializer__': 'ClassVar[SchemaSerializer]', '__pydantic_validator__': 'ClassVar[SchemaValidator | PluggableSchemaValidator]', '__signature__': 'ClassVar[Signature]', 'data': <class 'kittycad.models.get_num_objects.GetNumObjects'>, 'model_computed_fields': 'ClassVar[Dict[str, ComputedFieldInfo]]', 'model_config': 'ClassVar[ConfigDict]', 'model_fields': 'ClassVar[Dict[str, FieldInfo]]', 'type': typing.Literal['get_num_objects']}[source]

classmethod __class_getitem__(typevar_values)[source]

Return type:: type[BaseModel] | PydanticRecursiveRef

__class_vars__: ClassVar[set[str]] = {}[source]: The names of the class variables defined on the model.

__copy__()[source]

Returns a shallow copy of the model.

Return type:: Self

__deepcopy__(memo=None)[source]

Returns a deep copy of the model.

Return type:: Self

__delattr__(item)[source]

Implement delattr(self, name).

Return type:: Any

__dict__[source]

__eq__(other)[source]

Return self==value.

Return type:: bool

property __fields_set__: set[str][source]

classmethod __get_pydantic_core_schema__(source, handler, /)[source]

Hook into generating the model’s CoreSchema.

Parameters:

source (type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.
handler (GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.

Return type:

Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]

Returns:

A pydantic-core CoreSchema.

classmethod __get_pydantic_json_schema__(core_schema, handler, /)[source]

Hook into generating the model’s JSON schema.

Parameters:

core_schema (Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({'type': 'nullable', 'schema': current_schema}), or just call the handler with the original schema.
handler (GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.

Return type:

Returns:

A JSON schema, as a Python object.

__getattr__(item)[source]

Return type:: Any

__getstate__()[source]

Helper for pickle.

Return type:: dict[Any, Any]

__hash__ = None[source]

__init__(**data)[source]

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__iter__()[source]

So dict(model) works.

Return type:: Generator[Tuple[str, Any], None, None]

__module__ = 'kittycad.models.ok_modeling_cmd_response'[source]

__pretty__(fmt, **kwargs)[source]

Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.

Return type:: Generator[Any, None, None]

__private_attributes__: ClassVar[Dict[str, ModelPrivateAttr]] = {}[source]: Metadata about the private attributes of the model.

__pydantic_complete__: ClassVar[bool] = True[source]: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__: ClassVar[CoreSchema] = {'cls': <class 'kittycad.models.ok_modeling_cmd_response.OptionGetNumObjects'>, 'config': {'title': 'OptionGetNumObjects'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.ok_modeling_cmd_response.OptionGetNumObjects'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.ok_modeling_cmd_response.OptionGetNumObjects'>>]}, 'ref': 'kittycad.models.ok_modeling_cmd_response.OptionGetNumObjects:94667213528448', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'data': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.get_num_objects.GetNumObjects'>, 'config': {'title': 'GetNumObjects'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.get_num_objects.GetNumObjects'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.get_num_objects.GetNumObjects'>>]}, 'ref': 'kittycad.models.get_num_objects.GetNumObjects:94667206955344', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'num_objects': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'type': 'int'}, 'type': 'model-field'}}, 'model_name': 'GetNumObjects', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}, 'type': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': 'get_num_objects', 'schema': {'expected': ['get_num_objects'], 'type': 'literal'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'OptionGetNumObjects', 'type': 'model-fields'}, 'type': 'model'}[source]: The core schema of the model.

__pydantic_custom_init__: ClassVar[bool] = False[source]: Whether the model has a custom __init__ method.

__pydantic_decorators__: ClassVar[_decorators.DecoratorInfos] = DecoratorInfos(validators={}, field_validators={}, root_validators={}, field_serializers={}, model_serializers={}, model_validators={}, computed_fields={})[source]: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_extra__: dict[str, Any] | None[source]: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to 'allow'.

__pydantic_fields_set__: set[str][source]: The names of fields explicitly set during instantiation.

__pydantic_generic_metadata__: ClassVar[_generics.PydanticGenericMetadata] = {'args': (), 'origin': None, 'parameters': ()}[source]: 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.

classmethod __pydantic_init_subclass__(**kwargs)[source]

This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.

This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.

This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.

Parameters:: **kwargs (Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.
Return type:: None

__pydantic_parent_namespace__: ClassVar[Dict[str, Any] | None] = None[source]: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__: ClassVar[None | Literal['model_post_init']] = None[source]: The name of the post-init method for the model, if defined.

__pydantic_private__: dict[str, Any] | None[source]: Values of private attributes set on the model instance.

__pydantic_root_model__: ClassVar[bool] = False[source]: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__: ClassVar[SchemaSerializer] = SchemaSerializer(serializer=Model( ModelSerializer { class: Py( 0x000056196da25d80, ), serializer: Fields( GeneralFieldsSerializer { fields: { "type": SerField { key_py: Py( 0x00007f903823d958, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f90347f72f0, ), ), serializer: Literal( LiteralSerializer { expected_int: {}, expected_str: { "get_num_objects", }, expected_py: None, name: "literal['get_num_objects']", }, ), }, ), ), required: true, }, "data": SerField { key_py: Py( 0x00007f9038238fa0, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196d3e1150, ), serializer: Fields( GeneralFieldsSerializer { fields: { "num_objects": SerField { key_py: Py( 0x00007f9034f43f70, ), alias: None, alias_py: None, serializer: Some( Int( IntSerializer, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 1, }, ), has_extra: false, root_model: false, name: "GetNumObjects", }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "OptionGetNumObjects", }, ), definitions=[])[source]: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__: ClassVar[SchemaValidator | PluggableSchemaValidator] = SchemaValidator(title="OptionGetNumObjects", validator=Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "data", lookup_key: Simple { key: "data", py_key: Py( 0x00007f903336d0b0, ), path: LookupPath( [ S( "data", Py( 0x00007f903336d0e0, ), ), ], ), }, name_py: Py( 0x00007f9038238fa0, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "num_objects", lookup_key: Simple { key: "num_objects", py_key: Py( 0x00007f9033a18670, ), path: LookupPath( [ S( "num_objects", Py( 0x00007f9033380170, ), ), ], ), }, name_py: Py( 0x00007f9034f43f70, ), validator: Int( IntValidator { strict: false, }, ), frozen: false, }, ], model_name: "GetNumObjects", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d3e1150, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "GetNumObjects", }, ), frozen: false, }, Field { name: "type", lookup_key: Simple { key: "type", py_key: Py( 0x00007f903336d110, ), path: LookupPath( [ S( "type", Py( 0x00007f903336d140, ), ), ], ), }, name_py: Py( 0x00007f903823d958, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f90347f72f0, ), ), on_error: Raise, validator: Literal( LiteralValidator { lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "get_num_objects": 0, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f90347f72f0, ), ], }, expected_repr: "'get_num_objects'", name: "literal['get_num_objects']", }, ), validate_default: false, copy_default: false, name: "default[literal['get_num_objects']]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "OptionGetNumObjects", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196da25d80, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "OptionGetNumObjects", }, ), definitions=[], cache_strings=True)[source]: The pydantic-core SchemaValidator used to validate instances of the model.

__repr__()[source]

Return repr(self).

Return type:: str

__repr_args__()[source]

Return type:: Iterable[tuple[str | None, Any]]

__repr_name__()[source]

Name of the instance’s class, used in __repr__.

Return type:: str

__repr_str__(join_str)[source]

Return type:: str

__rich_repr__()[source]

Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.

Return type:: Iterable[Any | tuple[Any] | tuple[str, Any] | tuple[str, Any, Any]]

__setattr__(name, value)[source]

Implement setattr(self, name, value).

Return type:: None

__setstate__(state)[source]

Return type:: None

__signature__: ClassVar[Signature] = <Signature (*, data: kittycad.models.get_num_objects.GetNumObjects, type: Literal['get_num_objects'] = 'get_num_objects') -> None>[source]: The synthesized __init__ [Signature][inspect.Signature] of the model.

__slots__ = ('__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__')[source]

__str__()[source]

Return str(self).

Return type:: str

_abc_impl = <_abc._abc_data object>[source]

_calculate_keys(*args, **kwargs)[source]

Return type:: Any

_check_frozen(name, value)[source]

Return type:: None

_copy_and_set_values(*args, **kwargs)[source]

Return type:: Any

classmethod _get_value(*args, **kwargs)[source]

Return type:: Any

_iter(*args, **kwargs)[source]

Return type:: Any

classmethod construct(_fields_set=None, **values)[source]

Return type:: Self

copy(*, include=None, exclude=None, update=None, deep=False)[source]

Returns a copy of the model.

!!! warning “Deprecated”: This method is now deprecated; use model_copy instead.

If you need include or exclude, use:

`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `

Parameters:

include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.

Returns:

A copy of the model with included, excluded and updated fields as specified.

data: GetNumObjects[source]

dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)[source]

Return type:: Dict[str, Any]

classmethod from_orm(obj)[source]

Return type:: Self

json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)[source]

Return type:: str

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}[source]: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'protected_namespaces': ()}[source]: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod model_construct(_fields_set=None, **values)[source]

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note: model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == 'allow', then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == 'ignore' (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == 'forbid' does not result in an error if extra values are passed, but they will be ignored.

Parameters:

_fields_set (set[str] | None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.
values (Any) – Trusted or pre-validated data dictionary.

Return type:

Self

Returns:

A new instance of the Model class with validated data.

model_copy(*, update=None, deep=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy

Returns a copy of the model.

Parameters:

update (dict[str, Any] | None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.
deep (bool) – Set to True to make a deep copy of the model.

Return type:

Self

Returns:

New model instance.

model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters:

mode (Union[Literal['json', 'python'], str]) – The mode in which to_python 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.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to include in the output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to exclude from the output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to use the field’s alias in the dictionary key if defined.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A dictionary representation of the model.

model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

Generates a JSON representation of the model using Pydantic’s to_json method.

Parameters:

indent (int | None) – Indentation to use in the JSON output. If None is passed, the output will be compact.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to include in the JSON output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to exclude from the JSON output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to serialize using field aliases.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A JSON string representation of the model.

property model_extra: dict[str, Any] | None[source]

Get extra fields set during validation.

Returns:: A dictionary of extra fields, or None if config.extra is not set to "allow".

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=GetNumObjects, required=True), 'type': FieldInfo(annotation=Literal['get_num_objects'], required=False, default='get_num_objects')}[source]

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

property model_fields_set: set[str][source]

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,: i.e. that were not filled from defaults.

classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')[source]

Generates a JSON schema for a model class.

Parameters:

by_alias (bool) – Whether to use attribute aliases or not.
ref_template (str) – The reference template.
schema_generator (type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modifications
mode (Literal['validation', 'serialization']) – The mode in which to generate the schema.

Return type:

Returns:

The JSON schema for the given model class.

classmethod model_parametrized_name(params)[source]

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

Parameters:: params (tuple[type[Any], ...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.
Return type:: str
Returns:: String representing the new class where params are passed to cls as type variables.
Raises:: TypeError – Raised when trying to generate concrete names for non-generic models.

model_post_init(_BaseModel__context)[source]

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

Return type:: None

classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)[source]

Try to rebuild the pydantic-core schema for the model.

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.

Parameters:

force (bool) – Whether to force the rebuilding of the model schema, defaults to False.
raise_errors (bool) – Whether to raise errors, defaults to True.
_parent_namespace_depth (int) – The depth level of the parent namespace, defaults to 2.
_types_namespace (dict[str, Any] | None) – The types namespace, defaults to None.

Return type:

Returns:

Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.

classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)[source]

Validate a pydantic model instance.

Parameters:

obj (Any) – The object to validate.
strict (bool | None) – Whether to enforce types strictly.
from_attributes (bool | None) – Whether to extract data from object attributes.
context (Any | None) – Additional context to pass to the validator.

Raises:

ValidationError – If the object could not be validated.

Return type:

Self

Returns:

The validated model instance.

classmethod model_validate_json(json_data, *, strict=None, context=None)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing

Validate the given JSON data against the Pydantic model.

Parameters:

json_data (str | bytes | bytearray) – The JSON data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

Raises:

ValidationError – If json_data is not a JSON string or the object could not be validated.

classmethod model_validate_strings(obj, *, strict=None, context=None)[source]

Validate the given object with string data against the Pydantic model.

Parameters:

obj (Any) – The object containing string data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod parse_obj(obj)[source]

Return type:: Self

classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod schema(by_alias=True, ref_template='#/$defs/{model}')[source]

Return type:: Dict[str, Any]

classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)[source]

Return type:: str

type: Literal['get_num_objects'][source]

classmethod update_forward_refs(**localns)[source]

Return type:: None

classmethod validate(value)[source]

Return type:: Self

class kittycad.models.ok_modeling_cmd_response.OptionGetSketchModePlane(**data)[source][source]

The response to the ‘GetSketchModePlane’ endpoint

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__abstractmethods__ = frozenset({})[source]

__annotations__ = {'__class_vars__': 'ClassVar[set[str]]', '__private_attributes__': 'ClassVar[Dict[str, ModelPrivateAttr]]', '__pydantic_complete__': 'ClassVar[bool]', '__pydantic_core_schema__': 'ClassVar[CoreSchema]', '__pydantic_custom_init__': 'ClassVar[bool]', '__pydantic_decorators__': 'ClassVar[_decorators.DecoratorInfos]', '__pydantic_extra__': 'dict[str, Any] | None', '__pydantic_fields_set__': 'set[str]', '__pydantic_generic_metadata__': 'ClassVar[_generics.PydanticGenericMetadata]', '__pydantic_parent_namespace__': 'ClassVar[Dict[str, Any] | None]', '__pydantic_post_init__': "ClassVar[None | Literal['model_post_init']]", '__pydantic_private__': 'dict[str, Any] | None', '__pydantic_root_model__': 'ClassVar[bool]', '__pydantic_serializer__': 'ClassVar[SchemaSerializer]', '__pydantic_validator__': 'ClassVar[SchemaValidator | PluggableSchemaValidator]', '__signature__': 'ClassVar[Signature]', 'data': <class 'kittycad.models.get_sketch_mode_plane.GetSketchModePlane'>, 'model_computed_fields': 'ClassVar[Dict[str, ComputedFieldInfo]]', 'model_config': 'ClassVar[ConfigDict]', 'model_fields': 'ClassVar[Dict[str, FieldInfo]]', 'type': typing.Literal['get_sketch_mode_plane']}[source]

classmethod __class_getitem__(typevar_values)[source]

Return type:: type[BaseModel] | PydanticRecursiveRef

__class_vars__: ClassVar[set[str]] = {}[source]: The names of the class variables defined on the model.

__copy__()[source]

Returns a shallow copy of the model.

Return type:: Self

__deepcopy__(memo=None)[source]

Returns a deep copy of the model.

Return type:: Self

__delattr__(item)[source]

Implement delattr(self, name).

Return type:: Any

__dict__[source]

__eq__(other)[source]

Return self==value.

Return type:: bool

property __fields_set__: set[str][source]

classmethod __get_pydantic_core_schema__(source, handler, /)[source]

Hook into generating the model’s CoreSchema.

Parameters:

source (type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.
handler (GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.

Return type:

Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]

Returns:

A pydantic-core CoreSchema.

classmethod __get_pydantic_json_schema__(core_schema, handler, /)[source]

Hook into generating the model’s JSON schema.

Parameters:

core_schema (Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({'type': 'nullable', 'schema': current_schema}), or just call the handler with the original schema.
handler (GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.

Return type:

Returns:

A JSON schema, as a Python object.

__getattr__(item)[source]

Return type:: Any

__getstate__()[source]

Helper for pickle.

Return type:: dict[Any, Any]

__hash__ = None[source]

__init__(**data)[source]

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__iter__()[source]

So dict(model) works.

Return type:: Generator[Tuple[str, Any], None, None]

__module__ = 'kittycad.models.ok_modeling_cmd_response'[source]

__pretty__(fmt, **kwargs)[source]

Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.

Return type:: Generator[Any, None, None]

__private_attributes__: ClassVar[Dict[str, ModelPrivateAttr]] = {}[source]: Metadata about the private attributes of the model.

__pydantic_complete__: ClassVar[bool] = True[source]: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__: ClassVar[CoreSchema] = {'definitions': [{'cls': <class 'kittycad.models.point3d.Point3d'>, 'config': {'title': 'Point3d'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.point3d.Point3d'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.point3d.Point3d'>>]}, 'ref': 'kittycad.models.point3d.Point3d:94667194426368', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'x': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'type': 'float'}, 'type': 'model-field'}, 'y': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'type': 'float'}, 'type': 'model-field'}, 'z': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'type': 'float'}, 'type': 'model-field'}}, 'model_name': 'Point3d', 'type': 'model-fields'}, 'type': 'model'}], 'schema': {'cls': <class 'kittycad.models.ok_modeling_cmd_response.OptionGetSketchModePlane'>, 'config': {'title': 'OptionGetSketchModePlane'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.ok_modeling_cmd_response.OptionGetSketchModePlane'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.ok_modeling_cmd_response.OptionGetSketchModePlane'>>]}, 'ref': 'kittycad.models.ok_modeling_cmd_response.OptionGetSketchModePlane:94667214011568', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'data': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.get_sketch_mode_plane.GetSketchModePlane'>, 'config': {'title': 'GetSketchModePlane'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.get_sketch_mode_plane.GetSketchModePlane'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.get_sketch_mode_plane.GetSketchModePlane'>>]}, 'ref': 'kittycad.models.get_sketch_mode_plane.GetSketchModePlane:94667206970480', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'origin': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'schema_ref': 'kittycad.models.point3d.Point3d:94667194426368', 'type': 'definition-ref'}, 'type': 'model-field'}, 'x_axis': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'schema_ref': 'kittycad.models.point3d.Point3d:94667194426368', 'type': 'definition-ref'}, 'type': 'model-field'}, 'y_axis': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'schema_ref': 'kittycad.models.point3d.Point3d:94667194426368', 'type': 'definition-ref'}, 'type': 'model-field'}, 'z_axis': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'schema_ref': 'kittycad.models.point3d.Point3d:94667194426368', 'type': 'definition-ref'}, 'type': 'model-field'}}, 'model_name': 'GetSketchModePlane', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}, 'type': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': 'get_sketch_mode_plane', 'schema': {'expected': ['get_sketch_mode_plane'], 'type': 'literal'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'OptionGetSketchModePlane', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'definitions'}[source]: The core schema of the model.

__pydantic_custom_init__: ClassVar[bool] = False[source]: Whether the model has a custom __init__ method.

__pydantic_decorators__: ClassVar[_decorators.DecoratorInfos] = DecoratorInfos(validators={}, field_validators={}, root_validators={}, field_serializers={}, model_serializers={}, model_validators={}, computed_fields={})[source]: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_extra__: dict[str, Any] | None[source]: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to 'allow'.

__pydantic_fields_set__: set[str][source]: The names of fields explicitly set during instantiation.

__pydantic_generic_metadata__: ClassVar[_generics.PydanticGenericMetadata] = {'args': (), 'origin': None, 'parameters': ()}[source]: 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.

classmethod __pydantic_init_subclass__(**kwargs)[source]

This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.

This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.

This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.

Parameters:: **kwargs (Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.
Return type:: None

__pydantic_parent_namespace__: ClassVar[Dict[str, Any] | None] = None[source]: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__: ClassVar[None | Literal['model_post_init']] = None[source]: The name of the post-init method for the model, if defined.

__pydantic_private__: dict[str, Any] | None[source]: Values of private attributes set on the model instance.

__pydantic_root_model__: ClassVar[bool] = False[source]: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__: ClassVar[SchemaSerializer] = SchemaSerializer(serializer=Model( ModelSerializer { class: Py( 0x000056196da9bcb0, ), serializer: Fields( GeneralFieldsSerializer { fields: { "data": SerField { key_py: Py( 0x00007f9038238fa0, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196d3e4c70, ), serializer: Fields( GeneralFieldsSerializer { fields: { "z_axis": SerField { key_py: Py( 0x00007f90339517a0, ), alias: None, alias_py: None, serializer: Some( Recursive( DefinitionRefSerializer { definition: "...", retry_with_lax_check: true, }, ), ), required: true, }, "x_axis": SerField { key_py: Py( 0x00007f90339515c0, ), alias: None, alias_py: None, serializer: Some( Recursive( DefinitionRefSerializer { definition: "...", retry_with_lax_check: true, }, ), ), required: true, }, "y_axis": SerField { key_py: Py( 0x00007f90339516b0, ), alias: None, alias_py: None, serializer: Some( Recursive( DefinitionRefSerializer { definition: "...", retry_with_lax_check: true, }, ), ), required: true, }, "origin": SerField { key_py: Py( 0x00007f903823bdc0, ), alias: None, alias_py: None, serializer: Some( Recursive( DefinitionRefSerializer { definition: "...", retry_with_lax_check: true, }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 4, }, ), has_extra: false, root_model: false, name: "GetSketchModePlane", }, ), ), required: true, }, "type": SerField { key_py: Py( 0x00007f903823d958, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f90347f73b0, ), ), serializer: Literal( LiteralSerializer { expected_int: {}, expected_str: { "get_sketch_mode_plane", }, expected_py: None, name: "literal['get_sketch_mode_plane']", }, ), }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "OptionGetSketchModePlane", }, ), definitions=[Model(ModelSerializer { class: Py(0x56196c7ee400), serializer: Fields(GeneralFieldsSerializer { fields: {"y": SerField { key_py: Py(0x7f903823f558), alias: None, alias_py: None, serializer: Some(Float(FloatSerializer { inf_nan_mode: Null })), required: true }, "z": SerField { key_py: Py(0x7f903823f588), alias: None, alias_py: None, serializer: Some(Float(FloatSerializer { inf_nan_mode: Null })), required: true }, "x": SerField { key_py: Py(0x7f903823de18), alias: None, alias_py: None, serializer: Some(Float(FloatSerializer { inf_nan_mode: Null })), required: true }}, computed_fields: Some(ComputedFields([])), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None }, required_fields: 3 }), has_extra: false, root_model: false, name: "Point3d" })])[source]: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__: ClassVar[SchemaValidator | PluggableSchemaValidator] = SchemaValidator(title="OptionGetSketchModePlane", validator=Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "data", lookup_key: Simple { key: "data", py_key: Py( 0x00007f90333aa190, ), path: LookupPath( [ S( "data", Py( 0x00007f90333a8ae0, ), ), ], ), }, name_py: Py( 0x00007f9038238fa0, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "origin", lookup_key: Simple { key: "origin", py_key: Py( 0x00007f90333aa400, ), path: LookupPath( [ S( "origin", Py( 0x00007f90333aa0d0, ), ), ], ), }, name_py: Py( 0x00007f903823bdc0, ), validator: DefinitionRef( DefinitionRefValidator { definition: "...", }, ), frozen: false, }, Field { name: "x_axis", lookup_key: Simple { key: "x_axis", py_key: Py( 0x00007f90333aa130, ), path: LookupPath( [ S( "x_axis", Py( 0x00007f90333aa100, ), ), ], ), }, name_py: Py( 0x00007f90339515c0, ), validator: DefinitionRef( DefinitionRefValidator { definition: "...", }, ), frozen: false, }, Field { name: "y_axis", lookup_key: Simple { key: "y_axis", py_key: Py( 0x00007f90333aa1f0, ), path: LookupPath( [ S( "y_axis", Py( 0x00007f90333aa1c0, ), ), ], ), }, name_py: Py( 0x00007f90339516b0, ), validator: DefinitionRef( DefinitionRefValidator { definition: "...", }, ), frozen: false, }, Field { name: "z_axis", lookup_key: Simple { key: "z_axis", py_key: Py( 0x00007f90333aa160, ), path: LookupPath( [ S( "z_axis", Py( 0x00007f90333aa0a0, ), ), ], ), }, name_py: Py( 0x00007f90339517a0, ), validator: DefinitionRef( DefinitionRefValidator { definition: "...", }, ), frozen: false, }, ], model_name: "GetSketchModePlane", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d3e4c70, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "GetSketchModePlane", }, ), frozen: false, }, Field { name: "type", lookup_key: Simple { key: "type", py_key: Py( 0x00007f90333a8ba0, ), path: LookupPath( [ S( "type", Py( 0x00007f90333a8990, ), ), ], ), }, name_py: Py( 0x00007f903823d958, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f90347f73b0, ), ), on_error: Raise, validator: Literal( LiteralValidator { lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "get_sketch_mode_plane": 0, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f90347f73b0, ), ], }, expected_repr: "'get_sketch_mode_plane'", name: "literal['get_sketch_mode_plane']", }, ), validate_default: false, copy_default: false, name: "default[literal['get_sketch_mode_plane']]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "OptionGetSketchModePlane", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196da9bcb0, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "OptionGetSketchModePlane", }, ), definitions=[Model(ModelValidator { revalidate: Never, validator: ModelFields(ModelFieldsValidator { fields: [Field { name: "x", lookup_key: Simple { key: "x", py_key: Py(0x7f903823f528), path: LookupPath([S("x", Py(0x7f903823f528))]) }, name_py: Py(0x7f903823de18), validator: Float(FloatValidator { strict: false, allow_inf_nan: true }), frozen: false }, Field { name: "y", lookup_key: Simple { key: "y", py_key: Py(0x7f903823f558), path: LookupPath([S("y", Py(0x7f903823f558))]) }, name_py: Py(0x7f903823f558), validator: Float(FloatValidator { strict: false, allow_inf_nan: true }), frozen: false }, Field { name: "z", lookup_key: Simple { key: "z", py_key: Py(0x7f903823f588), path: LookupPath([S("z", Py(0x7f903823f588))]) }, name_py: Py(0x7f903823f588), validator: Float(FloatValidator { strict: false, allow_inf_nan: true }), frozen: false }], model_name: "Point3d", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true }), class: Py(0x56196c7ee400), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py(0x7f903629a320), name: "Point3d" })], cache_strings=True)[source]: The pydantic-core SchemaValidator used to validate instances of the model.

__repr__()[source]

Return repr(self).

Return type:: str

__repr_args__()[source]

Return type:: Iterable[tuple[str | None, Any]]

__repr_name__()[source]

Name of the instance’s class, used in __repr__.

Return type:: str

__repr_str__(join_str)[source]

Return type:: str

__rich_repr__()[source]

Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.

Return type:: Iterable[Any | tuple[Any] | tuple[str, Any] | tuple[str, Any, Any]]

__setattr__(name, value)[source]

Implement setattr(self, name, value).

Return type:: None

__setstate__(state)[source]

Return type:: None

__signature__: ClassVar[Signature] = <Signature (*, data: kittycad.models.get_sketch_mode_plane.GetSketchModePlane, type: Literal['get_sketch_mode_plane'] = 'get_sketch_mode_plane') -> None>[source]: The synthesized __init__ [Signature][inspect.Signature] of the model.

__slots__ = ('__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__')[source]

__str__()[source]

Return str(self).

Return type:: str

_abc_impl = <_abc._abc_data object>[source]

_calculate_keys(*args, **kwargs)[source]

Return type:: Any

_check_frozen(name, value)[source]

Return type:: None

_copy_and_set_values(*args, **kwargs)[source]

Return type:: Any

classmethod _get_value(*args, **kwargs)[source]

Return type:: Any

_iter(*args, **kwargs)[source]

Return type:: Any

classmethod construct(_fields_set=None, **values)[source]

Return type:: Self

copy(*, include=None, exclude=None, update=None, deep=False)[source]

Returns a copy of the model.

!!! warning “Deprecated”: This method is now deprecated; use model_copy instead.

If you need include or exclude, use:

`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `

Parameters:

include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.

Returns:

A copy of the model with included, excluded and updated fields as specified.

data: GetSketchModePlane[source]

dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)[source]

Return type:: Dict[str, Any]

classmethod from_orm(obj)[source]

Return type:: Self

json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)[source]

Return type:: str

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}[source]: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'protected_namespaces': ()}[source]: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod model_construct(_fields_set=None, **values)[source]

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note: model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == 'allow', then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == 'ignore' (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == 'forbid' does not result in an error if extra values are passed, but they will be ignored.

Parameters:

_fields_set (set[str] | None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.
values (Any) – Trusted or pre-validated data dictionary.

Return type:

Self

Returns:

A new instance of the Model class with validated data.

model_copy(*, update=None, deep=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy

Returns a copy of the model.

Parameters:

update (dict[str, Any] | None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.
deep (bool) – Set to True to make a deep copy of the model.

Return type:

Self

Returns:

New model instance.

model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters:

mode (Union[Literal['json', 'python'], str]) – The mode in which to_python 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.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to include in the output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to exclude from the output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to use the field’s alias in the dictionary key if defined.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A dictionary representation of the model.

model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

Generates a JSON representation of the model using Pydantic’s to_json method.

Parameters:

indent (int | None) – Indentation to use in the JSON output. If None is passed, the output will be compact.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to include in the JSON output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to exclude from the JSON output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to serialize using field aliases.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A JSON string representation of the model.

property model_extra: dict[str, Any] | None[source]

Get extra fields set during validation.

Returns:: A dictionary of extra fields, or None if config.extra is not set to "allow".

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=GetSketchModePlane, required=True), 'type': FieldInfo(annotation=Literal['get_sketch_mode_plane'], required=False, default='get_sketch_mode_plane')}[source]

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

property model_fields_set: set[str][source]

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,: i.e. that were not filled from defaults.

classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')[source]

Generates a JSON schema for a model class.

Parameters:

by_alias (bool) – Whether to use attribute aliases or not.
ref_template (str) – The reference template.
schema_generator (type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modifications
mode (Literal['validation', 'serialization']) – The mode in which to generate the schema.

Return type:

Returns:

The JSON schema for the given model class.

classmethod model_parametrized_name(params)[source]

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

Parameters:: params (tuple[type[Any], ...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.
Return type:: str
Returns:: String representing the new class where params are passed to cls as type variables.
Raises:: TypeError – Raised when trying to generate concrete names for non-generic models.

model_post_init(_BaseModel__context)[source]

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

Return type:: None

classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)[source]

Try to rebuild the pydantic-core schema for the model.

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.

Parameters:

force (bool) – Whether to force the rebuilding of the model schema, defaults to False.
raise_errors (bool) – Whether to raise errors, defaults to True.
_parent_namespace_depth (int) – The depth level of the parent namespace, defaults to 2.
_types_namespace (dict[str, Any] | None) – The types namespace, defaults to None.

Return type:

Returns:

Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.

classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)[source]

Validate a pydantic model instance.

Parameters:

obj (Any) – The object to validate.
strict (bool | None) – Whether to enforce types strictly.
from_attributes (bool | None) – Whether to extract data from object attributes.
context (Any | None) – Additional context to pass to the validator.

Raises:

ValidationError – If the object could not be validated.

Return type:

Self

Returns:

The validated model instance.

classmethod model_validate_json(json_data, *, strict=None, context=None)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing

Validate the given JSON data against the Pydantic model.

Parameters:

json_data (str | bytes | bytearray) – The JSON data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

Raises:

ValidationError – If json_data is not a JSON string or the object could not be validated.

classmethod model_validate_strings(obj, *, strict=None, context=None)[source]

Validate the given object with string data against the Pydantic model.

Parameters:

obj (Any) – The object containing string data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod parse_obj(obj)[source]

Return type:: Self

classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod schema(by_alias=True, ref_template='#/$defs/{model}')[source]

Return type:: Dict[str, Any]

classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)[source]

Return type:: str

type: Literal['get_sketch_mode_plane'][source]

classmethod update_forward_refs(**localns)[source]

Return type:: None

classmethod validate(value)[source]

Return type:: Self

class kittycad.models.ok_modeling_cmd_response.OptionHandleMouseDragEnd(**data)[source][source]

The response to the ‘HandleMouseDragEnd’ endpoint

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__abstractmethods__ = frozenset({})[source]

__annotations__ = {'__class_vars__': 'ClassVar[set[str]]', '__private_attributes__': 'ClassVar[Dict[str, ModelPrivateAttr]]', '__pydantic_complete__': 'ClassVar[bool]', '__pydantic_core_schema__': 'ClassVar[CoreSchema]', '__pydantic_custom_init__': 'ClassVar[bool]', '__pydantic_decorators__': 'ClassVar[_decorators.DecoratorInfos]', '__pydantic_extra__': 'dict[str, Any] | None', '__pydantic_fields_set__': 'set[str]', '__pydantic_generic_metadata__': 'ClassVar[_generics.PydanticGenericMetadata]', '__pydantic_parent_namespace__': 'ClassVar[Dict[str, Any] | None]', '__pydantic_post_init__': "ClassVar[None | Literal['model_post_init']]", '__pydantic_private__': 'dict[str, Any] | None', '__pydantic_root_model__': 'ClassVar[bool]', '__pydantic_serializer__': 'ClassVar[SchemaSerializer]', '__pydantic_validator__': 'ClassVar[SchemaValidator | PluggableSchemaValidator]', '__signature__': 'ClassVar[Signature]', 'data': <class 'kittycad.models.handle_mouse_drag_end.HandleMouseDragEnd'>, 'model_computed_fields': 'ClassVar[Dict[str, ComputedFieldInfo]]', 'model_config': 'ClassVar[ConfigDict]', 'model_fields': 'ClassVar[Dict[str, FieldInfo]]', 'type': typing.Literal['handle_mouse_drag_end']}[source]

classmethod __class_getitem__(typevar_values)[source]

Return type:: type[BaseModel] | PydanticRecursiveRef

__class_vars__: ClassVar[set[str]] = {}[source]: The names of the class variables defined on the model.

__copy__()[source]

Returns a shallow copy of the model.

Return type:: Self

__deepcopy__(memo=None)[source]

Returns a deep copy of the model.

Return type:: Self

__delattr__(item)[source]

Implement delattr(self, name).

Return type:: Any

__dict__[source]

__eq__(other)[source]

Return self==value.

Return type:: bool

property __fields_set__: set[str][source]

classmethod __get_pydantic_core_schema__(source, handler, /)[source]

Hook into generating the model’s CoreSchema.

Parameters:

source (type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.
handler (GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.

Return type:

Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]

Returns:

A pydantic-core CoreSchema.

classmethod __get_pydantic_json_schema__(core_schema, handler, /)[source]

Hook into generating the model’s JSON schema.

Parameters:

core_schema (Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({'type': 'nullable', 'schema': current_schema}), or just call the handler with the original schema.
handler (GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.

Return type:

Returns:

A JSON schema, as a Python object.

__getattr__(item)[source]

Return type:: Any

__getstate__()[source]

Helper for pickle.

Return type:: dict[Any, Any]

__hash__ = None[source]

__init__(**data)[source]

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__iter__()[source]

So dict(model) works.

Return type:: Generator[Tuple[str, Any], None, None]

__module__ = 'kittycad.models.ok_modeling_cmd_response'[source]

__pretty__(fmt, **kwargs)[source]

Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.

Return type:: Generator[Any, None, None]

__private_attributes__: ClassVar[Dict[str, ModelPrivateAttr]] = {}[source]: Metadata about the private attributes of the model.

__pydantic_complete__: ClassVar[bool] = True[source]: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__: ClassVar[CoreSchema] = {'cls': <class 'kittycad.models.ok_modeling_cmd_response.OptionHandleMouseDragEnd'>, 'config': {'title': 'OptionHandleMouseDragEnd'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.ok_modeling_cmd_response.OptionHandleMouseDragEnd'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.ok_modeling_cmd_response.OptionHandleMouseDragEnd'>>]}, 'ref': 'kittycad.models.ok_modeling_cmd_response.OptionHandleMouseDragEnd:94667213105296', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'data': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.handle_mouse_drag_end.HandleMouseDragEnd'>, 'config': {'title': 'HandleMouseDragEnd'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.handle_mouse_drag_end.HandleMouseDragEnd'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.handle_mouse_drag_end.HandleMouseDragEnd'>>]}, 'ref': 'kittycad.models.handle_mouse_drag_end.HandleMouseDragEnd:94667206976640', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {}, 'model_name': 'HandleMouseDragEnd', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}, 'type': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': 'handle_mouse_drag_end', 'schema': {'expected': ['handle_mouse_drag_end'], 'type': 'literal'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'OptionHandleMouseDragEnd', 'type': 'model-fields'}, 'type': 'model'}[source]: The core schema of the model.

__pydantic_custom_init__: ClassVar[bool] = False[source]: Whether the model has a custom __init__ method.

__pydantic_decorators__: ClassVar[_decorators.DecoratorInfos] = DecoratorInfos(validators={}, field_validators={}, root_validators={}, field_serializers={}, model_serializers={}, model_validators={}, computed_fields={})[source]: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_extra__: dict[str, Any] | None[source]: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to 'allow'.

__pydantic_fields_set__: set[str][source]: The names of fields explicitly set during instantiation.

__pydantic_generic_metadata__: ClassVar[_generics.PydanticGenericMetadata] = {'args': (), 'origin': None, 'parameters': ()}[source]: 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.

classmethod __pydantic_init_subclass__(**kwargs)[source]

This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.

This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.

This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.

Parameters:: **kwargs (Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.
Return type:: None

__pydantic_parent_namespace__: ClassVar[Dict[str, Any] | None] = None[source]: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__: ClassVar[None | Literal['model_post_init']] = None[source]: The name of the post-init method for the model, if defined.

__pydantic_private__: dict[str, Any] | None[source]: Values of private attributes set on the model instance.

__pydantic_root_model__: ClassVar[bool] = False[source]: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__: ClassVar[SchemaSerializer] = SchemaSerializer(serializer=Model( ModelSerializer { class: Py( 0x000056196d9be890, ), serializer: Fields( GeneralFieldsSerializer { fields: { "data": SerField { key_py: Py( 0x00007f9038238fa0, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196d3e6480, ), serializer: Fields( GeneralFieldsSerializer { fields: {}, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 0, }, ), has_extra: false, root_model: false, name: "HandleMouseDragEnd", }, ), ), required: true, }, "type": SerField { key_py: Py( 0x00007f903823d958, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f90347f76b0, ), ), serializer: Literal( LiteralSerializer { expected_int: {}, expected_str: { "handle_mouse_drag_end", }, expected_py: None, name: "literal['handle_mouse_drag_end']", }, ), }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "OptionHandleMouseDragEnd", }, ), definitions=[])[source]: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__: ClassVar[SchemaValidator | PluggableSchemaValidator] = SchemaValidator(title="OptionHandleMouseDragEnd", validator=Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "data", lookup_key: Simple { key: "data", py_key: Py( 0x00007f90334d7600, ), path: LookupPath( [ S( "data", Py( 0x00007f90334d74b0, ), ), ], ), }, name_py: Py( 0x00007f9038238fa0, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [], model_name: "HandleMouseDragEnd", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d3e6480, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "HandleMouseDragEnd", }, ), frozen: false, }, Field { name: "type", lookup_key: Simple { key: "type", py_key: Py( 0x00007f90334d74e0, ), path: LookupPath( [ S( "type", Py( 0x00007f90334d7570, ), ), ], ), }, name_py: Py( 0x00007f903823d958, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f90347f76b0, ), ), on_error: Raise, validator: Literal( LiteralValidator { lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "handle_mouse_drag_end": 0, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f90347f76b0, ), ], }, expected_repr: "'handle_mouse_drag_end'", name: "literal['handle_mouse_drag_end']", }, ), validate_default: false, copy_default: false, name: "default[literal['handle_mouse_drag_end']]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "OptionHandleMouseDragEnd", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d9be890, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "OptionHandleMouseDragEnd", }, ), definitions=[], cache_strings=True)[source]: The pydantic-core SchemaValidator used to validate instances of the model.

__repr__()[source]

Return repr(self).

Return type:: str

__repr_args__()[source]

Return type:: Iterable[tuple[str | None, Any]]

__repr_name__()[source]

Name of the instance’s class, used in __repr__.

Return type:: str

__repr_str__(join_str)[source]

Return type:: str

__rich_repr__()[source]

Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.

Return type:: Iterable[Any | tuple[Any] | tuple[str, Any] | tuple[str, Any, Any]]

__setattr__(name, value)[source]

Implement setattr(self, name, value).

Return type:: None

__setstate__(state)[source]

Return type:: None

__signature__: ClassVar[Signature] = <Signature (*, data: kittycad.models.handle_mouse_drag_end.HandleMouseDragEnd, type: Literal['handle_mouse_drag_end'] = 'handle_mouse_drag_end') -> None>[source]: The synthesized __init__ [Signature][inspect.Signature] of the model.

__slots__ = ('__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__')[source]

__str__()[source]

Return str(self).

Return type:: str

_abc_impl = <_abc._abc_data object>[source]

_calculate_keys(*args, **kwargs)[source]

Return type:: Any

_check_frozen(name, value)[source]

Return type:: None

_copy_and_set_values(*args, **kwargs)[source]

Return type:: Any

classmethod _get_value(*args, **kwargs)[source]

Return type:: Any

_iter(*args, **kwargs)[source]

Return type:: Any

classmethod construct(_fields_set=None, **values)[source]

Return type:: Self

copy(*, include=None, exclude=None, update=None, deep=False)[source]

Returns a copy of the model.

!!! warning “Deprecated”: This method is now deprecated; use model_copy instead.

If you need include or exclude, use:

`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `

Parameters:

include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.

Returns:

A copy of the model with included, excluded and updated fields as specified.

data: HandleMouseDragEnd[source]

dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)[source]

Return type:: Dict[str, Any]

classmethod from_orm(obj)[source]

Return type:: Self

json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)[source]

Return type:: str

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}[source]: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'protected_namespaces': ()}[source]: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod model_construct(_fields_set=None, **values)[source]

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note: model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == 'allow', then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == 'ignore' (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == 'forbid' does not result in an error if extra values are passed, but they will be ignored.

Parameters:

_fields_set (set[str] | None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.
values (Any) – Trusted or pre-validated data dictionary.

Return type:

Self

Returns:

A new instance of the Model class with validated data.

model_copy(*, update=None, deep=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy

Returns a copy of the model.

Parameters:

update (dict[str, Any] | None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.
deep (bool) – Set to True to make a deep copy of the model.

Return type:

Self

Returns:

New model instance.

model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters:

mode (Union[Literal['json', 'python'], str]) – The mode in which to_python 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.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to include in the output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to exclude from the output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to use the field’s alias in the dictionary key if defined.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A dictionary representation of the model.

model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

Generates a JSON representation of the model using Pydantic’s to_json method.

Parameters:

indent (int | None) – Indentation to use in the JSON output. If None is passed, the output will be compact.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to include in the JSON output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to exclude from the JSON output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to serialize using field aliases.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A JSON string representation of the model.

property model_extra: dict[str, Any] | None[source]

Get extra fields set during validation.

Returns:: A dictionary of extra fields, or None if config.extra is not set to "allow".

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=HandleMouseDragEnd, required=True), 'type': FieldInfo(annotation=Literal['handle_mouse_drag_end'], required=False, default='handle_mouse_drag_end')}[source]

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

property model_fields_set: set[str][source]

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,: i.e. that were not filled from defaults.

classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')[source]

Generates a JSON schema for a model class.

Parameters:

by_alias (bool) – Whether to use attribute aliases or not.
ref_template (str) – The reference template.
schema_generator (type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modifications
mode (Literal['validation', 'serialization']) – The mode in which to generate the schema.

Return type:

Returns:

The JSON schema for the given model class.

classmethod model_parametrized_name(params)[source]

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

Parameters:: params (tuple[type[Any], ...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.
Return type:: str
Returns:: String representing the new class where params are passed to cls as type variables.
Raises:: TypeError – Raised when trying to generate concrete names for non-generic models.

model_post_init(_BaseModel__context)[source]

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

Return type:: None

classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)[source]

Try to rebuild the pydantic-core schema for the model.

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.

Parameters:

force (bool) – Whether to force the rebuilding of the model schema, defaults to False.
raise_errors (bool) – Whether to raise errors, defaults to True.
_parent_namespace_depth (int) – The depth level of the parent namespace, defaults to 2.
_types_namespace (dict[str, Any] | None) – The types namespace, defaults to None.

Return type:

Returns:

Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.

classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)[source]

Validate a pydantic model instance.

Parameters:

obj (Any) – The object to validate.
strict (bool | None) – Whether to enforce types strictly.
from_attributes (bool | None) – Whether to extract data from object attributes.
context (Any | None) – Additional context to pass to the validator.

Raises:

ValidationError – If the object could not be validated.

Return type:

Self

Returns:

The validated model instance.

classmethod model_validate_json(json_data, *, strict=None, context=None)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing

Validate the given JSON data against the Pydantic model.

Parameters:

json_data (str | bytes | bytearray) – The JSON data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

Raises:

ValidationError – If json_data is not a JSON string or the object could not be validated.

classmethod model_validate_strings(obj, *, strict=None, context=None)[source]

Validate the given object with string data against the Pydantic model.

Parameters:

obj (Any) – The object containing string data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod parse_obj(obj)[source]

Return type:: Self

classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod schema(by_alias=True, ref_template='#/$defs/{model}')[source]

Return type:: Dict[str, Any]

classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)[source]

Return type:: str

type: Literal['handle_mouse_drag_end'][source]

classmethod update_forward_refs(**localns)[source]

Return type:: None

classmethod validate(value)[source]

Return type:: Self

class kittycad.models.ok_modeling_cmd_response.OptionHandleMouseDragMove(**data)[source][source]

The response to the ‘HandleMouseDragMove’ endpoint

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__abstractmethods__ = frozenset({})[source]

__annotations__ = {'__class_vars__': 'ClassVar[set[str]]', '__private_attributes__': 'ClassVar[Dict[str, ModelPrivateAttr]]', '__pydantic_complete__': 'ClassVar[bool]', '__pydantic_core_schema__': 'ClassVar[CoreSchema]', '__pydantic_custom_init__': 'ClassVar[bool]', '__pydantic_decorators__': 'ClassVar[_decorators.DecoratorInfos]', '__pydantic_extra__': 'dict[str, Any] | None', '__pydantic_fields_set__': 'set[str]', '__pydantic_generic_metadata__': 'ClassVar[_generics.PydanticGenericMetadata]', '__pydantic_parent_namespace__': 'ClassVar[Dict[str, Any] | None]', '__pydantic_post_init__': "ClassVar[None | Literal['model_post_init']]", '__pydantic_private__': 'dict[str, Any] | None', '__pydantic_root_model__': 'ClassVar[bool]', '__pydantic_serializer__': 'ClassVar[SchemaSerializer]', '__pydantic_validator__': 'ClassVar[SchemaValidator | PluggableSchemaValidator]', '__signature__': 'ClassVar[Signature]', 'data': <class 'kittycad.models.handle_mouse_drag_move.HandleMouseDragMove'>, 'model_computed_fields': 'ClassVar[Dict[str, ComputedFieldInfo]]', 'model_config': 'ClassVar[ConfigDict]', 'model_fields': 'ClassVar[Dict[str, FieldInfo]]', 'type': typing.Literal['handle_mouse_drag_move']}[source]

classmethod __class_getitem__(typevar_values)[source]

Return type:: type[BaseModel] | PydanticRecursiveRef

__class_vars__: ClassVar[set[str]] = {}[source]: The names of the class variables defined on the model.

__copy__()[source]

Returns a shallow copy of the model.

Return type:: Self

__deepcopy__(memo=None)[source]

Returns a deep copy of the model.

Return type:: Self

__delattr__(item)[source]

Implement delattr(self, name).

Return type:: Any

__dict__[source]

__eq__(other)[source]

Return self==value.

Return type:: bool

property __fields_set__: set[str][source]

classmethod __get_pydantic_core_schema__(source, handler, /)[source]

Hook into generating the model’s CoreSchema.

Parameters:

source (type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.
handler (GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.

Return type:

Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]

Returns:

A pydantic-core CoreSchema.

classmethod __get_pydantic_json_schema__(core_schema, handler, /)[source]

Hook into generating the model’s JSON schema.

Parameters:

core_schema (Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({'type': 'nullable', 'schema': current_schema}), or just call the handler with the original schema.
handler (GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.

Return type:

Returns:

A JSON schema, as a Python object.

__getattr__(item)[source]

Return type:: Any

__getstate__()[source]

Helper for pickle.

Return type:: dict[Any, Any]

__hash__ = None[source]

__init__(**data)[source]

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__iter__()[source]

So dict(model) works.

Return type:: Generator[Tuple[str, Any], None, None]

__module__ = 'kittycad.models.ok_modeling_cmd_response'[source]

__pretty__(fmt, **kwargs)[source]

Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.

Return type:: Generator[Any, None, None]

__private_attributes__: ClassVar[Dict[str, ModelPrivateAttr]] = {}[source]: Metadata about the private attributes of the model.

__pydantic_complete__: ClassVar[bool] = True[source]: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__: ClassVar[CoreSchema] = {'cls': <class 'kittycad.models.ok_modeling_cmd_response.OptionHandleMouseDragMove'>, 'config': {'title': 'OptionHandleMouseDragMove'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.ok_modeling_cmd_response.OptionHandleMouseDragMove'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.ok_modeling_cmd_response.OptionHandleMouseDragMove'>>]}, 'ref': 'kittycad.models.ok_modeling_cmd_response.OptionHandleMouseDragMove:94667213095696', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'data': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.handle_mouse_drag_move.HandleMouseDragMove'>, 'config': {'title': 'HandleMouseDragMove'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.handle_mouse_drag_move.HandleMouseDragMove'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.handle_mouse_drag_move.HandleMouseDragMove'>>]}, 'ref': 'kittycad.models.handle_mouse_drag_move.HandleMouseDragMove:94667206980224', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {}, 'model_name': 'HandleMouseDragMove', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}, 'type': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': 'handle_mouse_drag_move', 'schema': {'expected': ['handle_mouse_drag_move'], 'type': 'literal'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'OptionHandleMouseDragMove', 'type': 'model-fields'}, 'type': 'model'}[source]: The core schema of the model.

__pydantic_custom_init__: ClassVar[bool] = False[source]: Whether the model has a custom __init__ method.

__pydantic_decorators__: ClassVar[_decorators.DecoratorInfos] = DecoratorInfos(validators={}, field_validators={}, root_validators={}, field_serializers={}, model_serializers={}, model_validators={}, computed_fields={})[source]: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_extra__: dict[str, Any] | None[source]: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to 'allow'.

__pydantic_fields_set__: set[str][source]: The names of fields explicitly set during instantiation.

__pydantic_generic_metadata__: ClassVar[_generics.PydanticGenericMetadata] = {'args': (), 'origin': None, 'parameters': ()}[source]: 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.

classmethod __pydantic_init_subclass__(**kwargs)[source]

This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.

This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.

This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.

Parameters:: **kwargs (Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.
Return type:: None

__pydantic_parent_namespace__: ClassVar[Dict[str, Any] | None] = None[source]: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__: ClassVar[None | Literal['model_post_init']] = None[source]: The name of the post-init method for the model, if defined.

__pydantic_private__: dict[str, Any] | None[source]: Values of private attributes set on the model instance.

__pydantic_root_model__: ClassVar[bool] = False[source]: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__: ClassVar[SchemaSerializer] = SchemaSerializer(serializer=Model( ModelSerializer { class: Py( 0x000056196d9bc310, ), serializer: Fields( GeneralFieldsSerializer { fields: { "data": SerField { key_py: Py( 0x00007f9038238fa0, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196d3e7280, ), serializer: Fields( GeneralFieldsSerializer { fields: {}, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 0, }, ), has_extra: false, root_model: false, name: "HandleMouseDragMove", }, ), ), required: true, }, "type": SerField { key_py: Py( 0x00007f903823d958, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f90347f77b0, ), ), serializer: Literal( LiteralSerializer { expected_int: {}, expected_str: { "handle_mouse_drag_move", }, expected_py: None, name: "literal['handle_mouse_drag_move']", }, ), }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "OptionHandleMouseDragMove", }, ), definitions=[])[source]: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__: ClassVar[SchemaValidator | PluggableSchemaValidator] = SchemaValidator(title="OptionHandleMouseDragMove", validator=Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "data", lookup_key: Simple { key: "data", py_key: Py( 0x00007f90334d4570, ), path: LookupPath( [ S( "data", Py( 0x00007f90334d5ad0, ), ), ], ), }, name_py: Py( 0x00007f9038238fa0, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [], model_name: "HandleMouseDragMove", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d3e7280, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "HandleMouseDragMove", }, ), frozen: false, }, Field { name: "type", lookup_key: Simple { key: "type", py_key: Py( 0x00007f90334d57d0, ), path: LookupPath( [ S( "type", Py( 0x00007f90334d5650, ), ), ], ), }, name_py: Py( 0x00007f903823d958, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f90347f77b0, ), ), on_error: Raise, validator: Literal( LiteralValidator { lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "handle_mouse_drag_move": 0, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f90347f77b0, ), ], }, expected_repr: "'handle_mouse_drag_move'", name: "literal['handle_mouse_drag_move']", }, ), validate_default: false, copy_default: false, name: "default[literal['handle_mouse_drag_move']]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "OptionHandleMouseDragMove", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d9bc310, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "OptionHandleMouseDragMove", }, ), definitions=[], cache_strings=True)[source]: The pydantic-core SchemaValidator used to validate instances of the model.

__repr__()[source]

Return repr(self).

Return type:: str

__repr_args__()[source]

Return type:: Iterable[tuple[str | None, Any]]

__repr_name__()[source]

Name of the instance’s class, used in __repr__.

Return type:: str

__repr_str__(join_str)[source]

Return type:: str

__rich_repr__()[source]

Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.

Return type:: Iterable[Any | tuple[Any] | tuple[str, Any] | tuple[str, Any, Any]]

__setattr__(name, value)[source]

Implement setattr(self, name, value).

Return type:: None

__setstate__(state)[source]

Return type:: None

__signature__: ClassVar[Signature] = <Signature (*, data: kittycad.models.handle_mouse_drag_move.HandleMouseDragMove, type: Literal['handle_mouse_drag_move'] = 'handle_mouse_drag_move') -> None>[source]: The synthesized __init__ [Signature][inspect.Signature] of the model.

__slots__ = ('__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__')[source]

__str__()[source]

Return str(self).

Return type:: str

_abc_impl = <_abc._abc_data object>[source]

_calculate_keys(*args, **kwargs)[source]

Return type:: Any

_check_frozen(name, value)[source]

Return type:: None

_copy_and_set_values(*args, **kwargs)[source]

Return type:: Any

classmethod _get_value(*args, **kwargs)[source]

Return type:: Any

_iter(*args, **kwargs)[source]

Return type:: Any

classmethod construct(_fields_set=None, **values)[source]

Return type:: Self

copy(*, include=None, exclude=None, update=None, deep=False)[source]

Returns a copy of the model.

!!! warning “Deprecated”: This method is now deprecated; use model_copy instead.

If you need include or exclude, use:

`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `

Parameters:

include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.

Returns:

A copy of the model with included, excluded and updated fields as specified.

data: HandleMouseDragMove[source]

dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)[source]

Return type:: Dict[str, Any]

classmethod from_orm(obj)[source]

Return type:: Self

json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)[source]

Return type:: str

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}[source]: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'protected_namespaces': ()}[source]: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod model_construct(_fields_set=None, **values)[source]

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note: model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == 'allow', then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == 'ignore' (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == 'forbid' does not result in an error if extra values are passed, but they will be ignored.

Parameters:

_fields_set (set[str] | None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.
values (Any) – Trusted or pre-validated data dictionary.

Return type:

Self

Returns:

A new instance of the Model class with validated data.

model_copy(*, update=None, deep=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy

Returns a copy of the model.

Parameters:

update (dict[str, Any] | None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.
deep (bool) – Set to True to make a deep copy of the model.

Return type:

Self

Returns:

New model instance.

model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters:

mode (Union[Literal['json', 'python'], str]) – The mode in which to_python 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.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to include in the output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to exclude from the output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to use the field’s alias in the dictionary key if defined.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A dictionary representation of the model.

model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

Generates a JSON representation of the model using Pydantic’s to_json method.

Parameters:

indent (int | None) – Indentation to use in the JSON output. If None is passed, the output will be compact.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to include in the JSON output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to exclude from the JSON output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to serialize using field aliases.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A JSON string representation of the model.

property model_extra: dict[str, Any] | None[source]

Get extra fields set during validation.

Returns:: A dictionary of extra fields, or None if config.extra is not set to "allow".

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=HandleMouseDragMove, required=True), 'type': FieldInfo(annotation=Literal['handle_mouse_drag_move'], required=False, default='handle_mouse_drag_move')}[source]

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

property model_fields_set: set[str][source]

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,: i.e. that were not filled from defaults.

classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')[source]

Generates a JSON schema for a model class.

Parameters:

by_alias (bool) – Whether to use attribute aliases or not.
ref_template (str) – The reference template.
schema_generator (type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modifications
mode (Literal['validation', 'serialization']) – The mode in which to generate the schema.

Return type:

Returns:

The JSON schema for the given model class.

classmethod model_parametrized_name(params)[source]

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

Parameters:: params (tuple[type[Any], ...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.
Return type:: str
Returns:: String representing the new class where params are passed to cls as type variables.
Raises:: TypeError – Raised when trying to generate concrete names for non-generic models.

model_post_init(_BaseModel__context)[source]

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

Return type:: None

classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)[source]

Try to rebuild the pydantic-core schema for the model.

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.

Parameters:

force (bool) – Whether to force the rebuilding of the model schema, defaults to False.
raise_errors (bool) – Whether to raise errors, defaults to True.
_parent_namespace_depth (int) – The depth level of the parent namespace, defaults to 2.
_types_namespace (dict[str, Any] | None) – The types namespace, defaults to None.

Return type:

Returns:

Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.

classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)[source]

Validate a pydantic model instance.

Parameters:

obj (Any) – The object to validate.
strict (bool | None) – Whether to enforce types strictly.
from_attributes (bool | None) – Whether to extract data from object attributes.
context (Any | None) – Additional context to pass to the validator.

Raises:

ValidationError – If the object could not be validated.

Return type:

Self

Returns:

The validated model instance.

classmethod model_validate_json(json_data, *, strict=None, context=None)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing

Validate the given JSON data against the Pydantic model.

Parameters:

json_data (str | bytes | bytearray) – The JSON data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

Raises:

ValidationError – If json_data is not a JSON string or the object could not be validated.

classmethod model_validate_strings(obj, *, strict=None, context=None)[source]

Validate the given object with string data against the Pydantic model.

Parameters:

obj (Any) – The object containing string data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod parse_obj(obj)[source]

Return type:: Self

classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod schema(by_alias=True, ref_template='#/$defs/{model}')[source]

Return type:: Dict[str, Any]

classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)[source]

Return type:: str

type: Literal['handle_mouse_drag_move'][source]

classmethod update_forward_refs(**localns)[source]

Return type:: None

classmethod validate(value)[source]

Return type:: Self

class kittycad.models.ok_modeling_cmd_response.OptionHandleMouseDragStart(**data)[source][source]

The response to the ‘HandleMouseDragStart’ endpoint

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__abstractmethods__ = frozenset({})[source]

__annotations__ = {'__class_vars__': 'ClassVar[set[str]]', '__private_attributes__': 'ClassVar[Dict[str, ModelPrivateAttr]]', '__pydantic_complete__': 'ClassVar[bool]', '__pydantic_core_schema__': 'ClassVar[CoreSchema]', '__pydantic_custom_init__': 'ClassVar[bool]', '__pydantic_decorators__': 'ClassVar[_decorators.DecoratorInfos]', '__pydantic_extra__': 'dict[str, Any] | None', '__pydantic_fields_set__': 'set[str]', '__pydantic_generic_metadata__': 'ClassVar[_generics.PydanticGenericMetadata]', '__pydantic_parent_namespace__': 'ClassVar[Dict[str, Any] | None]', '__pydantic_post_init__': "ClassVar[None | Literal['model_post_init']]", '__pydantic_private__': 'dict[str, Any] | None', '__pydantic_root_model__': 'ClassVar[bool]', '__pydantic_serializer__': 'ClassVar[SchemaSerializer]', '__pydantic_validator__': 'ClassVar[SchemaValidator | PluggableSchemaValidator]', '__signature__': 'ClassVar[Signature]', 'data': <class 'kittycad.models.handle_mouse_drag_start.HandleMouseDragStart'>, 'model_computed_fields': 'ClassVar[Dict[str, ComputedFieldInfo]]', 'model_config': 'ClassVar[ConfigDict]', 'model_fields': 'ClassVar[Dict[str, FieldInfo]]', 'type': typing.Literal['handle_mouse_drag_start']}[source]

classmethod __class_getitem__(typevar_values)[source]

Return type:: type[BaseModel] | PydanticRecursiveRef

__class_vars__: ClassVar[set[str]] = {}[source]: The names of the class variables defined on the model.

__copy__()[source]

Returns a shallow copy of the model.

Return type:: Self

__deepcopy__(memo=None)[source]

Returns a deep copy of the model.

Return type:: Self

__delattr__(item)[source]

Implement delattr(self, name).

Return type:: Any

__dict__[source]

__eq__(other)[source]

Return self==value.

Return type:: bool

property __fields_set__: set[str][source]

classmethod __get_pydantic_core_schema__(source, handler, /)[source]

Hook into generating the model’s CoreSchema.

Parameters:

source (type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.
handler (GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.

Return type:

Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]

Returns:

A pydantic-core CoreSchema.

classmethod __get_pydantic_json_schema__(core_schema, handler, /)[source]

Hook into generating the model’s JSON schema.

Parameters:

core_schema (Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({'type': 'nullable', 'schema': current_schema}), or just call the handler with the original schema.
handler (GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.

Return type:

Returns:

A JSON schema, as a Python object.

__getattr__(item)[source]

Return type:: Any

__getstate__()[source]

Helper for pickle.

Return type:: dict[Any, Any]

__hash__ = None[source]

__init__(**data)[source]

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__iter__()[source]

So dict(model) works.

Return type:: Generator[Tuple[str, Any], None, None]

__module__ = 'kittycad.models.ok_modeling_cmd_response'[source]

__pretty__(fmt, **kwargs)[source]

Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.

Return type:: Generator[Any, None, None]

__private_attributes__: ClassVar[Dict[str, ModelPrivateAttr]] = {}[source]: Metadata about the private attributes of the model.

__pydantic_complete__: ClassVar[bool] = True[source]: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__: ClassVar[CoreSchema] = {'cls': <class 'kittycad.models.ok_modeling_cmd_response.OptionHandleMouseDragStart'>, 'config': {'title': 'OptionHandleMouseDragStart'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.ok_modeling_cmd_response.OptionHandleMouseDragStart'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.ok_modeling_cmd_response.OptionHandleMouseDragStart'>>]}, 'ref': 'kittycad.models.ok_modeling_cmd_response.OptionHandleMouseDragStart:94667213083168', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'data': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.handle_mouse_drag_start.HandleMouseDragStart'>, 'config': {'title': 'HandleMouseDragStart'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.handle_mouse_drag_start.HandleMouseDragStart'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.handle_mouse_drag_start.HandleMouseDragStart'>>]}, 'ref': 'kittycad.models.handle_mouse_drag_start.HandleMouseDragStart:94667206984064', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {}, 'model_name': 'HandleMouseDragStart', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}, 'type': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': 'handle_mouse_drag_start', 'schema': {'expected': ['handle_mouse_drag_start'], 'type': 'literal'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'OptionHandleMouseDragStart', 'type': 'model-fields'}, 'type': 'model'}[source]: The core schema of the model.

__pydantic_custom_init__: ClassVar[bool] = False[source]: Whether the model has a custom __init__ method.

__pydantic_decorators__: ClassVar[_decorators.DecoratorInfos] = DecoratorInfos(validators={}, field_validators={}, root_validators={}, field_serializers={}, model_serializers={}, model_validators={}, computed_fields={})[source]: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_extra__: dict[str, Any] | None[source]: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to 'allow'.

__pydantic_fields_set__: set[str][source]: The names of fields explicitly set during instantiation.

__pydantic_generic_metadata__: ClassVar[_generics.PydanticGenericMetadata] = {'args': (), 'origin': None, 'parameters': ()}[source]: 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.

classmethod __pydantic_init_subclass__(**kwargs)[source]

This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.

This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.

This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.

Parameters:: **kwargs (Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.
Return type:: None

__pydantic_parent_namespace__: ClassVar[Dict[str, Any] | None] = None[source]: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__: ClassVar[None | Literal['model_post_init']] = None[source]: The name of the post-init method for the model, if defined.

__pydantic_private__: dict[str, Any] | None[source]: Values of private attributes set on the model instance.

__pydantic_root_model__: ClassVar[bool] = False[source]: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__: ClassVar[SchemaSerializer] = SchemaSerializer(serializer=Model( ModelSerializer { class: Py( 0x000056196d9b9220, ), serializer: Fields( GeneralFieldsSerializer { fields: { "type": SerField { key_py: Py( 0x00007f903823d958, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f90347f7b70, ), ), serializer: Literal( LiteralSerializer { expected_int: {}, expected_str: { "handle_mouse_drag_start", }, expected_py: None, name: "literal['handle_mouse_drag_start']", }, ), }, ), ), required: true, }, "data": SerField { key_py: Py( 0x00007f9038238fa0, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196d3e8180, ), serializer: Fields( GeneralFieldsSerializer { fields: {}, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 0, }, ), has_extra: false, root_model: false, name: "HandleMouseDragStart", }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "OptionHandleMouseDragStart", }, ), definitions=[])[source]: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__: ClassVar[SchemaValidator | PluggableSchemaValidator] = SchemaValidator(title="OptionHandleMouseDragStart", validator=Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "data", lookup_key: Simple { key: "data", py_key: Py( 0x00007f90334d79c0, ), path: LookupPath( [ S( "data", Py( 0x00007f90334d7a50, ), ), ], ), }, name_py: Py( 0x00007f9038238fa0, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [], model_name: "HandleMouseDragStart", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d3e8180, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "HandleMouseDragStart", }, ), frozen: false, }, Field { name: "type", lookup_key: Simple { key: "type", py_key: Py( 0x00007f90334d7900, ), path: LookupPath( [ S( "type", Py( 0x00007f90334d7930, ), ), ], ), }, name_py: Py( 0x00007f903823d958, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f90347f7b70, ), ), on_error: Raise, validator: Literal( LiteralValidator { lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "handle_mouse_drag_start": 0, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f90347f7b70, ), ], }, expected_repr: "'handle_mouse_drag_start'", name: "literal['handle_mouse_drag_start']", }, ), validate_default: false, copy_default: false, name: "default[literal['handle_mouse_drag_start']]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "OptionHandleMouseDragStart", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d9b9220, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "OptionHandleMouseDragStart", }, ), definitions=[], cache_strings=True)[source]: The pydantic-core SchemaValidator used to validate instances of the model.

__repr__()[source]

Return repr(self).

Return type:: str

__repr_args__()[source]

Return type:: Iterable[tuple[str | None, Any]]

__repr_name__()[source]

Name of the instance’s class, used in __repr__.

Return type:: str

__repr_str__(join_str)[source]

Return type:: str

__rich_repr__()[source]

Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.

Return type:: Iterable[Any | tuple[Any] | tuple[str, Any] | tuple[str, Any, Any]]

__setattr__(name, value)[source]

Implement setattr(self, name, value).

Return type:: None

__setstate__(state)[source]

Return type:: None

__signature__: ClassVar[Signature] = <Signature (*, data: kittycad.models.handle_mouse_drag_start.HandleMouseDragStart, type: Literal['handle_mouse_drag_start'] = 'handle_mouse_drag_start') -> None>[source]: The synthesized __init__ [Signature][inspect.Signature] of the model.

__slots__ = ('__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__')[source]

__str__()[source]

Return str(self).

Return type:: str

_abc_impl = <_abc._abc_data object>[source]

_calculate_keys(*args, **kwargs)[source]

Return type:: Any

_check_frozen(name, value)[source]

Return type:: None

_copy_and_set_values(*args, **kwargs)[source]

Return type:: Any

classmethod _get_value(*args, **kwargs)[source]

Return type:: Any

_iter(*args, **kwargs)[source]

Return type:: Any

classmethod construct(_fields_set=None, **values)[source]

Return type:: Self

copy(*, include=None, exclude=None, update=None, deep=False)[source]

Returns a copy of the model.

!!! warning “Deprecated”: This method is now deprecated; use model_copy instead.

If you need include or exclude, use:

`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `

Parameters:

include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.

Returns:

A copy of the model with included, excluded and updated fields as specified.

data: HandleMouseDragStart[source]

dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)[source]

Return type:: Dict[str, Any]

classmethod from_orm(obj)[source]

Return type:: Self

json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)[source]

Return type:: str

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}[source]: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'protected_namespaces': ()}[source]: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod model_construct(_fields_set=None, **values)[source]

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note: model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == 'allow', then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == 'ignore' (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == 'forbid' does not result in an error if extra values are passed, but they will be ignored.

Parameters:

_fields_set (set[str] | None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.
values (Any) – Trusted or pre-validated data dictionary.

Return type:

Self

Returns:

A new instance of the Model class with validated data.

model_copy(*, update=None, deep=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy

Returns a copy of the model.

Parameters:

update (dict[str, Any] | None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.
deep (bool) – Set to True to make a deep copy of the model.

Return type:

Self

Returns:

New model instance.

model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters:

mode (Union[Literal['json', 'python'], str]) – The mode in which to_python 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.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to include in the output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to exclude from the output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to use the field’s alias in the dictionary key if defined.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A dictionary representation of the model.

model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

Generates a JSON representation of the model using Pydantic’s to_json method.

Parameters:

indent (int | None) – Indentation to use in the JSON output. If None is passed, the output will be compact.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to include in the JSON output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to exclude from the JSON output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to serialize using field aliases.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A JSON string representation of the model.

property model_extra: dict[str, Any] | None[source]

Get extra fields set during validation.

Returns:: A dictionary of extra fields, or None if config.extra is not set to "allow".

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=HandleMouseDragStart, required=True), 'type': FieldInfo(annotation=Literal['handle_mouse_drag_start'], required=False, default='handle_mouse_drag_start')}[source]

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

property model_fields_set: set[str][source]

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,: i.e. that were not filled from defaults.

classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')[source]

Generates a JSON schema for a model class.

Parameters:

by_alias (bool) – Whether to use attribute aliases or not.
ref_template (str) – The reference template.
schema_generator (type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modifications
mode (Literal['validation', 'serialization']) – The mode in which to generate the schema.

Return type:

Returns:

The JSON schema for the given model class.

classmethod model_parametrized_name(params)[source]

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

Parameters:: params (tuple[type[Any], ...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.
Return type:: str
Returns:: String representing the new class where params are passed to cls as type variables.
Raises:: TypeError – Raised when trying to generate concrete names for non-generic models.

model_post_init(_BaseModel__context)[source]

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

Return type:: None

classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)[source]

Try to rebuild the pydantic-core schema for the model.

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.

Parameters:

force (bool) – Whether to force the rebuilding of the model schema, defaults to False.
raise_errors (bool) – Whether to raise errors, defaults to True.
_parent_namespace_depth (int) – The depth level of the parent namespace, defaults to 2.
_types_namespace (dict[str, Any] | None) – The types namespace, defaults to None.

Return type:

Returns:

Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.

classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)[source]

Validate a pydantic model instance.

Parameters:

obj (Any) – The object to validate.
strict (bool | None) – Whether to enforce types strictly.
from_attributes (bool | None) – Whether to extract data from object attributes.
context (Any | None) – Additional context to pass to the validator.

Raises:

ValidationError – If the object could not be validated.

Return type:

Self

Returns:

The validated model instance.

classmethod model_validate_json(json_data, *, strict=None, context=None)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing

Validate the given JSON data against the Pydantic model.

Parameters:

json_data (str | bytes | bytearray) – The JSON data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

Raises:

ValidationError – If json_data is not a JSON string or the object could not be validated.

classmethod model_validate_strings(obj, *, strict=None, context=None)[source]

Validate the given object with string data against the Pydantic model.

Parameters:

obj (Any) – The object containing string data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod parse_obj(obj)[source]

Return type:: Self

classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod schema(by_alias=True, ref_template='#/$defs/{model}')[source]

Return type:: Dict[str, Any]

classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)[source]

Return type:: str

type: Literal['handle_mouse_drag_start'][source]

classmethod update_forward_refs(**localns)[source]

Return type:: None

classmethod validate(value)[source]

Return type:: Self

class kittycad.models.ok_modeling_cmd_response.OptionHighlightSetEntities(**data)[source][source]

The response to the ‘HighlightSetEntities’ endpoint

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__abstractmethods__ = frozenset({})[source]

__annotations__ = {'__class_vars__': 'ClassVar[set[str]]', '__private_attributes__': 'ClassVar[Dict[str, ModelPrivateAttr]]', '__pydantic_complete__': 'ClassVar[bool]', '__pydantic_core_schema__': 'ClassVar[CoreSchema]', '__pydantic_custom_init__': 'ClassVar[bool]', '__pydantic_decorators__': 'ClassVar[_decorators.DecoratorInfos]', '__pydantic_extra__': 'dict[str, Any] | None', '__pydantic_fields_set__': 'set[str]', '__pydantic_generic_metadata__': 'ClassVar[_generics.PydanticGenericMetadata]', '__pydantic_parent_namespace__': 'ClassVar[Dict[str, Any] | None]', '__pydantic_post_init__': "ClassVar[None | Literal['model_post_init']]", '__pydantic_private__': 'dict[str, Any] | None', '__pydantic_root_model__': 'ClassVar[bool]', '__pydantic_serializer__': 'ClassVar[SchemaSerializer]', '__pydantic_validator__': 'ClassVar[SchemaValidator | PluggableSchemaValidator]', '__signature__': 'ClassVar[Signature]', 'data': <class 'kittycad.models.highlight_set_entities.HighlightSetEntities'>, 'model_computed_fields': 'ClassVar[Dict[str, ComputedFieldInfo]]', 'model_config': 'ClassVar[ConfigDict]', 'model_fields': 'ClassVar[Dict[str, FieldInfo]]', 'type': typing.Literal['highlight_set_entities']}[source]

classmethod __class_getitem__(typevar_values)[source]

Return type:: type[BaseModel] | PydanticRecursiveRef

__class_vars__: ClassVar[set[str]] = {}[source]: The names of the class variables defined on the model.

__copy__()[source]

Returns a shallow copy of the model.

Return type:: Self

__deepcopy__(memo=None)[source]

Returns a deep copy of the model.

Return type:: Self

__delattr__(item)[source]

Implement delattr(self, name).

Return type:: Any

__dict__[source]

__eq__(other)[source]

Return self==value.

Return type:: bool

property __fields_set__: set[str][source]

classmethod __get_pydantic_core_schema__(source, handler, /)[source]

Hook into generating the model’s CoreSchema.

Parameters:

source (type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.
handler (GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.

Return type:

Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]

Returns:

A pydantic-core CoreSchema.

classmethod __get_pydantic_json_schema__(core_schema, handler, /)[source]

Hook into generating the model’s JSON schema.

Parameters:

core_schema (Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({'type': 'nullable', 'schema': current_schema}), or just call the handler with the original schema.
handler (GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.

Return type:

Returns:

A JSON schema, as a Python object.

__getattr__(item)[source]

Return type:: Any

__getstate__()[source]

Helper for pickle.

Return type:: dict[Any, Any]

__hash__ = None[source]

__init__(**data)[source]

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__iter__()[source]

So dict(model) works.

Return type:: Generator[Tuple[str, Any], None, None]

__module__ = 'kittycad.models.ok_modeling_cmd_response'[source]

__pretty__(fmt, **kwargs)[source]

Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.

Return type:: Generator[Any, None, None]

__private_attributes__: ClassVar[Dict[str, ModelPrivateAttr]] = {}[source]: Metadata about the private attributes of the model.

__pydantic_complete__: ClassVar[bool] = True[source]: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__: ClassVar[CoreSchema] = {'cls': <class 'kittycad.models.ok_modeling_cmd_response.OptionHighlightSetEntities'>, 'config': {'title': 'OptionHighlightSetEntities'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.ok_modeling_cmd_response.OptionHighlightSetEntities'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.ok_modeling_cmd_response.OptionHighlightSetEntities'>>]}, 'ref': 'kittycad.models.ok_modeling_cmd_response.OptionHighlightSetEntities:94667212868976', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'data': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.highlight_set_entities.HighlightSetEntities'>, 'config': {'title': 'HighlightSetEntities'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.highlight_set_entities.HighlightSetEntities'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.highlight_set_entities.HighlightSetEntities'>>]}, 'ref': 'kittycad.models.highlight_set_entities.HighlightSetEntities:94667206987904', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {}, 'model_name': 'HighlightSetEntities', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}, 'type': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': 'highlight_set_entities', 'schema': {'expected': ['highlight_set_entities'], 'type': 'literal'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'OptionHighlightSetEntities', 'type': 'model-fields'}, 'type': 'model'}[source]: The core schema of the model.

__pydantic_custom_init__: ClassVar[bool] = False[source]: Whether the model has a custom __init__ method.

__pydantic_decorators__: ClassVar[_decorators.DecoratorInfos] = DecoratorInfos(validators={}, field_validators={}, root_validators={}, field_serializers={}, model_serializers={}, model_validators={}, computed_fields={})[source]: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_extra__: dict[str, Any] | None[source]: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to 'allow'.

__pydantic_fields_set__: set[str][source]: The names of fields explicitly set during instantiation.

__pydantic_generic_metadata__: ClassVar[_generics.PydanticGenericMetadata] = {'args': (), 'origin': None, 'parameters': ()}[source]: 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.

classmethod __pydantic_init_subclass__(**kwargs)[source]

This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.

This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.

This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.

Parameters:: **kwargs (Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.
Return type:: None

__pydantic_parent_namespace__: ClassVar[Dict[str, Any] | None] = None[source]: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__: ClassVar[None | Literal['model_post_init']] = None[source]: The name of the post-init method for the model, if defined.

__pydantic_private__: dict[str, Any] | None[source]: Values of private attributes set on the model instance.

__pydantic_root_model__: ClassVar[bool] = False[source]: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__: ClassVar[SchemaSerializer] = SchemaSerializer(serializer=Model( ModelSerializer { class: Py( 0x000056196d984d70, ), serializer: Fields( GeneralFieldsSerializer { fields: { "type": SerField { key_py: Py( 0x00007f903823d958, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f90347f7c70, ), ), serializer: Literal( LiteralSerializer { expected_int: {}, expected_str: { "highlight_set_entities", }, expected_py: None, name: "literal['highlight_set_entities']", }, ), }, ), ), required: true, }, "data": SerField { key_py: Py( 0x00007f9038238fa0, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196d3e9080, ), serializer: Fields( GeneralFieldsSerializer { fields: {}, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 0, }, ), has_extra: false, root_model: false, name: "HighlightSetEntities", }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "OptionHighlightSetEntities", }, ), definitions=[])[source]: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__: ClassVar[SchemaValidator | PluggableSchemaValidator] = SchemaValidator(title="OptionHighlightSetEntities", validator=Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "data", lookup_key: Simple { key: "data", py_key: Py( 0x00007f90334d4780, ), path: LookupPath( [ S( "data", Py( 0x00007f90334d47b0, ), ), ], ), }, name_py: Py( 0x00007f9038238fa0, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [], model_name: "HighlightSetEntities", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d3e9080, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "HighlightSetEntities", }, ), frozen: false, }, Field { name: "type", lookup_key: Simple { key: "type", py_key: Py( 0x00007f90334d47e0, ), path: LookupPath( [ S( "type", Py( 0x00007f90334d4810, ), ), ], ), }, name_py: Py( 0x00007f903823d958, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f90347f7c70, ), ), on_error: Raise, validator: Literal( LiteralValidator { lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "highlight_set_entities": 0, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f90347f7c70, ), ], }, expected_repr: "'highlight_set_entities'", name: "literal['highlight_set_entities']", }, ), validate_default: false, copy_default: false, name: "default[literal['highlight_set_entities']]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "OptionHighlightSetEntities", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d984d70, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "OptionHighlightSetEntities", }, ), definitions=[], cache_strings=True)[source]: The pydantic-core SchemaValidator used to validate instances of the model.

__repr__()[source]

Return repr(self).

Return type:: str

__repr_args__()[source]

Return type:: Iterable[tuple[str | None, Any]]

__repr_name__()[source]

Name of the instance’s class, used in __repr__.

Return type:: str

__repr_str__(join_str)[source]

Return type:: str

__rich_repr__()[source]

Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.

Return type:: Iterable[Any | tuple[Any] | tuple[str, Any] | tuple[str, Any, Any]]

__setattr__(name, value)[source]

Implement setattr(self, name, value).

Return type:: None

__setstate__(state)[source]

Return type:: None

__signature__: ClassVar[Signature] = <Signature (*, data: kittycad.models.highlight_set_entities.HighlightSetEntities, type: Literal['highlight_set_entities'] = 'highlight_set_entities') -> None>[source]: The synthesized __init__ [Signature][inspect.Signature] of the model.

__slots__ = ('__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__')[source]

__str__()[source]

Return str(self).

Return type:: str

_abc_impl = <_abc._abc_data object>[source]

_calculate_keys(*args, **kwargs)[source]

Return type:: Any

_check_frozen(name, value)[source]

Return type:: None

_copy_and_set_values(*args, **kwargs)[source]

Return type:: Any

classmethod _get_value(*args, **kwargs)[source]

Return type:: Any

_iter(*args, **kwargs)[source]

Return type:: Any

classmethod construct(_fields_set=None, **values)[source]

Return type:: Self

copy(*, include=None, exclude=None, update=None, deep=False)[source]

Returns a copy of the model.

!!! warning “Deprecated”: This method is now deprecated; use model_copy instead.

If you need include or exclude, use:

`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `

Parameters:

include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.

Returns:

A copy of the model with included, excluded and updated fields as specified.

data: HighlightSetEntities[source]

dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)[source]

Return type:: Dict[str, Any]

classmethod from_orm(obj)[source]

Return type:: Self

json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)[source]

Return type:: str

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}[source]: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'protected_namespaces': ()}[source]: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod model_construct(_fields_set=None, **values)[source]

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note: model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == 'allow', then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == 'ignore' (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == 'forbid' does not result in an error if extra values are passed, but they will be ignored.

Parameters:

_fields_set (set[str] | None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.
values (Any) – Trusted or pre-validated data dictionary.

Return type:

Self

Returns:

A new instance of the Model class with validated data.

model_copy(*, update=None, deep=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy

Returns a copy of the model.

Parameters:

update (dict[str, Any] | None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.
deep (bool) – Set to True to make a deep copy of the model.

Return type:

Self

Returns:

New model instance.

model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters:

mode (Union[Literal['json', 'python'], str]) – The mode in which to_python 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.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to include in the output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to exclude from the output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to use the field’s alias in the dictionary key if defined.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A dictionary representation of the model.

model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

Generates a JSON representation of the model using Pydantic’s to_json method.

Parameters:

indent (int | None) – Indentation to use in the JSON output. If None is passed, the output will be compact.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to include in the JSON output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to exclude from the JSON output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to serialize using field aliases.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A JSON string representation of the model.

property model_extra: dict[str, Any] | None[source]

Get extra fields set during validation.

Returns:: A dictionary of extra fields, or None if config.extra is not set to "allow".

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=HighlightSetEntities, required=True), 'type': FieldInfo(annotation=Literal['highlight_set_entities'], required=False, default='highlight_set_entities')}[source]

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

property model_fields_set: set[str][source]

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,: i.e. that were not filled from defaults.

classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')[source]

Generates a JSON schema for a model class.

Parameters:

by_alias (bool) – Whether to use attribute aliases or not.
ref_template (str) – The reference template.
schema_generator (type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modifications
mode (Literal['validation', 'serialization']) – The mode in which to generate the schema.

Return type:

Returns:

The JSON schema for the given model class.

classmethod model_parametrized_name(params)[source]

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

Parameters:: params (tuple[type[Any], ...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.
Return type:: str
Returns:: String representing the new class where params are passed to cls as type variables.
Raises:: TypeError – Raised when trying to generate concrete names for non-generic models.

model_post_init(_BaseModel__context)[source]

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

Return type:: None

classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)[source]

Try to rebuild the pydantic-core schema for the model.

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.

Parameters:

force (bool) – Whether to force the rebuilding of the model schema, defaults to False.
raise_errors (bool) – Whether to raise errors, defaults to True.
_parent_namespace_depth (int) – The depth level of the parent namespace, defaults to 2.
_types_namespace (dict[str, Any] | None) – The types namespace, defaults to None.

Return type:

Returns:

Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.

classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)[source]

Validate a pydantic model instance.

Parameters:

obj (Any) – The object to validate.
strict (bool | None) – Whether to enforce types strictly.
from_attributes (bool | None) – Whether to extract data from object attributes.
context (Any | None) – Additional context to pass to the validator.

Raises:

ValidationError – If the object could not be validated.

Return type:

Self

Returns:

The validated model instance.

classmethod model_validate_json(json_data, *, strict=None, context=None)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing

Validate the given JSON data against the Pydantic model.

Parameters:

json_data (str | bytes | bytearray) – The JSON data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

Raises:

ValidationError – If json_data is not a JSON string or the object could not be validated.

classmethod model_validate_strings(obj, *, strict=None, context=None)[source]

Validate the given object with string data against the Pydantic model.

Parameters:

obj (Any) – The object containing string data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod parse_obj(obj)[source]

Return type:: Self

classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod schema(by_alias=True, ref_template='#/$defs/{model}')[source]

Return type:: Dict[str, Any]

classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)[source]

Return type:: str

type: Literal['highlight_set_entities'][source]

classmethod update_forward_refs(**localns)[source]

Return type:: None

classmethod validate(value)[source]

Return type:: Self

class kittycad.models.ok_modeling_cmd_response.OptionHighlightSetEntity(**data)[source][source]

The response to the ‘HighlightSetEntity’ endpoint

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__abstractmethods__ = frozenset({})[source]

__annotations__ = {'__class_vars__': 'ClassVar[set[str]]', '__private_attributes__': 'ClassVar[Dict[str, ModelPrivateAttr]]', '__pydantic_complete__': 'ClassVar[bool]', '__pydantic_core_schema__': 'ClassVar[CoreSchema]', '__pydantic_custom_init__': 'ClassVar[bool]', '__pydantic_decorators__': 'ClassVar[_decorators.DecoratorInfos]', '__pydantic_extra__': 'dict[str, Any] | None', '__pydantic_fields_set__': 'set[str]', '__pydantic_generic_metadata__': 'ClassVar[_generics.PydanticGenericMetadata]', '__pydantic_parent_namespace__': 'ClassVar[Dict[str, Any] | None]', '__pydantic_post_init__': "ClassVar[None | Literal['model_post_init']]", '__pydantic_private__': 'dict[str, Any] | None', '__pydantic_root_model__': 'ClassVar[bool]', '__pydantic_serializer__': 'ClassVar[SchemaSerializer]', '__pydantic_validator__': 'ClassVar[SchemaValidator | PluggableSchemaValidator]', '__signature__': 'ClassVar[Signature]', 'data': <class 'kittycad.models.highlight_set_entity.HighlightSetEntity'>, 'model_computed_fields': 'ClassVar[Dict[str, ComputedFieldInfo]]', 'model_config': 'ClassVar[ConfigDict]', 'model_fields': 'ClassVar[Dict[str, FieldInfo]]', 'type': typing.Literal['highlight_set_entity']}[source]

classmethod __class_getitem__(typevar_values)[source]

Return type:: type[BaseModel] | PydanticRecursiveRef

__class_vars__: ClassVar[set[str]] = {}[source]: The names of the class variables defined on the model.

__copy__()[source]

Returns a shallow copy of the model.

Return type:: Self

__deepcopy__(memo=None)[source]

Returns a deep copy of the model.

Return type:: Self

__delattr__(item)[source]

Implement delattr(self, name).

Return type:: Any

__dict__[source]

__eq__(other)[source]

Return self==value.

Return type:: bool

property __fields_set__: set[str][source]

classmethod __get_pydantic_core_schema__(source, handler, /)[source]

Hook into generating the model’s CoreSchema.

Parameters:

source (type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.
handler (GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.

Return type:

Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]

Returns:

A pydantic-core CoreSchema.

classmethod __get_pydantic_json_schema__(core_schema, handler, /)[source]

Hook into generating the model’s JSON schema.

Parameters:

core_schema (Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({'type': 'nullable', 'schema': current_schema}), or just call the handler with the original schema.
handler (GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.

Return type:

Returns:

A JSON schema, as a Python object.

__getattr__(item)[source]

Return type:: Any

__getstate__()[source]

Helper for pickle.

Return type:: dict[Any, Any]

__hash__ = None[source]

__init__(**data)[source]

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__iter__()[source]

So dict(model) works.

Return type:: Generator[Tuple[str, Any], None, None]

__module__ = 'kittycad.models.ok_modeling_cmd_response'[source]

__pretty__(fmt, **kwargs)[source]

Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.

Return type:: Generator[Any, None, None]

__private_attributes__: ClassVar[Dict[str, ModelPrivateAttr]] = {}[source]: Metadata about the private attributes of the model.

__pydantic_complete__: ClassVar[bool] = True[source]: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__: ClassVar[CoreSchema] = {'cls': <class 'kittycad.models.ok_modeling_cmd_response.OptionHighlightSetEntity'>, 'config': {'title': 'OptionHighlightSetEntity'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.ok_modeling_cmd_response.OptionHighlightSetEntity'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.ok_modeling_cmd_response.OptionHighlightSetEntity'>>]}, 'ref': 'kittycad.models.ok_modeling_cmd_response.OptionHighlightSetEntity:94667213234864', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'data': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.highlight_set_entity.HighlightSetEntity'>, 'config': {'title': 'HighlightSetEntity'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.highlight_set_entity.HighlightSetEntity'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.highlight_set_entity.HighlightSetEntity'>>]}, 'ref': 'kittycad.models.highlight_set_entity.HighlightSetEntity:94667206991360', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'entity_id': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': None, 'schema': {'schema': {'type': 'str'}, 'type': 'nullable'}, 'type': 'default'}, 'type': 'model-field'}, 'sequence': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': None, 'schema': {'schema': {'type': 'int'}, 'type': 'nullable'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'HighlightSetEntity', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}, 'type': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': 'highlight_set_entity', 'schema': {'expected': ['highlight_set_entity'], 'type': 'literal'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'OptionHighlightSetEntity', 'type': 'model-fields'}, 'type': 'model'}[source]: The core schema of the model.

__pydantic_custom_init__: ClassVar[bool] = False[source]: Whether the model has a custom __init__ method.

__pydantic_decorators__: ClassVar[_decorators.DecoratorInfos] = DecoratorInfos(validators={}, field_validators={}, root_validators={}, field_serializers={}, model_serializers={}, model_validators={}, computed_fields={})[source]: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_extra__: dict[str, Any] | None[source]: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to 'allow'.

__pydantic_fields_set__: set[str][source]: The names of fields explicitly set during instantiation.

__pydantic_generic_metadata__: ClassVar[_generics.PydanticGenericMetadata] = {'args': (), 'origin': None, 'parameters': ()}[source]: 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.

classmethod __pydantic_init_subclass__(**kwargs)[source]

This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.

This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.

This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.

Parameters:: **kwargs (Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.
Return type:: None

__pydantic_parent_namespace__: ClassVar[Dict[str, Any] | None] = None[source]: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__: ClassVar[None | Literal['model_post_init']] = None[source]: The name of the post-init method for the model, if defined.

__pydantic_private__: dict[str, Any] | None[source]: Values of private attributes set on the model instance.

__pydantic_root_model__: ClassVar[bool] = False[source]: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__: ClassVar[SchemaSerializer] = SchemaSerializer(serializer=Model( ModelSerializer { class: Py( 0x000056196d9de2b0, ), serializer: Fields( GeneralFieldsSerializer { fields: { "data": SerField { key_py: Py( 0x00007f9038238fa0, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196d3e9e00, ), serializer: Fields( GeneralFieldsSerializer { fields: { "entity_id": SerField { key_py: Py( 0x00007f9033b11430, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f9038148100, ), ), serializer: Nullable( NullableSerializer { serializer: Str( StrSerializer, ), }, ), }, ), ), required: true, }, "sequence": SerField { key_py: Py( 0x00007f903823cb48, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f9038148100, ), ), serializer: Nullable( NullableSerializer { serializer: Int( IntSerializer, ), }, ), }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "HighlightSetEntity", }, ), ), required: true, }, "type": SerField { key_py: Py( 0x00007f903823d958, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f90347f7d70, ), ), serializer: Literal( LiteralSerializer { expected_int: {}, expected_str: { "highlight_set_entity", }, expected_py: None, name: "literal['highlight_set_entity']", }, ), }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "OptionHighlightSetEntity", }, ), definitions=[])[source]: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__: ClassVar[SchemaValidator | PluggableSchemaValidator] = SchemaValidator(title="OptionHighlightSetEntity", validator=Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "data", lookup_key: Simple { key: "data", py_key: Py( 0x00007f9033520810, ), path: LookupPath( [ S( "data", Py( 0x00007f9033520270, ), ), ], ), }, name_py: Py( 0x00007f9038238fa0, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "entity_id", lookup_key: Simple { key: "entity_id", py_key: Py( 0x00007f90333426b0, ), path: LookupPath( [ S( "entity_id", Py( 0x00007f9033342670, ), ), ], ), }, name_py: Py( 0x00007f9033b11430, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f9038148100, ), ), on_error: Raise, validator: Nullable( NullableValidator { validator: Str( StrValidator { strict: false, coerce_numbers_to_str: false, }, ), name: "nullable[str]", }, ), validate_default: false, copy_default: false, name: "default[nullable[str]]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, Field { name: "sequence", lookup_key: Simple { key: "sequence", py_key: Py( 0x00007f9033342730, ), path: LookupPath( [ S( "sequence", Py( 0x00007f90333426f0, ), ), ], ), }, name_py: Py( 0x00007f903823cb48, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f9038148100, ), ), on_error: Raise, validator: Nullable( NullableValidator { validator: Int( IntValidator { strict: false, }, ), name: "nullable[int]", }, ), validate_default: false, copy_default: false, name: "default[nullable[int]]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "HighlightSetEntity", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d3e9e00, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "HighlightSetEntity", }, ), frozen: false, }, Field { name: "type", lookup_key: Simple { key: "type", py_key: Py( 0x00007f90335208d0, ), path: LookupPath( [ S( "type", Py( 0x00007f90335208a0, ), ), ], ), }, name_py: Py( 0x00007f903823d958, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f90347f7d70, ), ), on_error: Raise, validator: Literal( LiteralValidator { lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "highlight_set_entity": 0, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f90347f7d70, ), ], }, expected_repr: "'highlight_set_entity'", name: "literal['highlight_set_entity']", }, ), validate_default: false, copy_default: false, name: "default[literal['highlight_set_entity']]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "OptionHighlightSetEntity", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d9de2b0, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "OptionHighlightSetEntity", }, ), definitions=[], cache_strings=True)[source]: The pydantic-core SchemaValidator used to validate instances of the model.

__repr__()[source]

Return repr(self).

Return type:: str

__repr_args__()[source]

Return type:: Iterable[tuple[str | None, Any]]

__repr_name__()[source]

Name of the instance’s class, used in __repr__.

Return type:: str

__repr_str__(join_str)[source]

Return type:: str

__rich_repr__()[source]

Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.

Return type:: Iterable[Any | tuple[Any] | tuple[str, Any] | tuple[str, Any, Any]]

__setattr__(name, value)[source]

Implement setattr(self, name, value).

Return type:: None

__setstate__(state)[source]

Return type:: None

__signature__: ClassVar[Signature] = <Signature (*, data: kittycad.models.highlight_set_entity.HighlightSetEntity, type: Literal['highlight_set_entity'] = 'highlight_set_entity') -> None>[source]: The synthesized __init__ [Signature][inspect.Signature] of the model.

__slots__ = ('__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__')[source]

__str__()[source]

Return str(self).

Return type:: str

_abc_impl = <_abc._abc_data object>[source]

_calculate_keys(*args, **kwargs)[source]

Return type:: Any

_check_frozen(name, value)[source]

Return type:: None

_copy_and_set_values(*args, **kwargs)[source]

Return type:: Any

classmethod _get_value(*args, **kwargs)[source]

Return type:: Any

_iter(*args, **kwargs)[source]

Return type:: Any

classmethod construct(_fields_set=None, **values)[source]

Return type:: Self

copy(*, include=None, exclude=None, update=None, deep=False)[source]

Returns a copy of the model.

!!! warning “Deprecated”: This method is now deprecated; use model_copy instead.

If you need include or exclude, use:

`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `

Parameters:

include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.

Returns:

A copy of the model with included, excluded and updated fields as specified.

data: HighlightSetEntity[source]

dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)[source]

Return type:: Dict[str, Any]

classmethod from_orm(obj)[source]

Return type:: Self

json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)[source]

Return type:: str

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}[source]: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'protected_namespaces': ()}[source]: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod model_construct(_fields_set=None, **values)[source]

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note: model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == 'allow', then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == 'ignore' (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == 'forbid' does not result in an error if extra values are passed, but they will be ignored.

Parameters:

_fields_set (set[str] | None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.
values (Any) – Trusted or pre-validated data dictionary.

Return type:

Self

Returns:

A new instance of the Model class with validated data.

model_copy(*, update=None, deep=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy

Returns a copy of the model.

Parameters:

update (dict[str, Any] | None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.
deep (bool) – Set to True to make a deep copy of the model.

Return type:

Self

Returns:

New model instance.

model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters:

mode (Union[Literal['json', 'python'], str]) – The mode in which to_python 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.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to include in the output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to exclude from the output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to use the field’s alias in the dictionary key if defined.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A dictionary representation of the model.

model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

Generates a JSON representation of the model using Pydantic’s to_json method.

Parameters:

indent (int | None) – Indentation to use in the JSON output. If None is passed, the output will be compact.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to include in the JSON output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to exclude from the JSON output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to serialize using field aliases.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A JSON string representation of the model.

property model_extra: dict[str, Any] | None[source]

Get extra fields set during validation.

Returns:: A dictionary of extra fields, or None if config.extra is not set to "allow".

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=HighlightSetEntity, required=True), 'type': FieldInfo(annotation=Literal['highlight_set_entity'], required=False, default='highlight_set_entity')}[source]

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

property model_fields_set: set[str][source]

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,: i.e. that were not filled from defaults.

classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')[source]

Generates a JSON schema for a model class.

Parameters:

by_alias (bool) – Whether to use attribute aliases or not.
ref_template (str) – The reference template.
schema_generator (type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modifications
mode (Literal['validation', 'serialization']) – The mode in which to generate the schema.

Return type:

Returns:

The JSON schema for the given model class.

classmethod model_parametrized_name(params)[source]

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

Parameters:: params (tuple[type[Any], ...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.
Return type:: str
Returns:: String representing the new class where params are passed to cls as type variables.
Raises:: TypeError – Raised when trying to generate concrete names for non-generic models.

model_post_init(_BaseModel__context)[source]

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

Return type:: None

classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)[source]

Try to rebuild the pydantic-core schema for the model.

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.

Parameters:

force (bool) – Whether to force the rebuilding of the model schema, defaults to False.
raise_errors (bool) – Whether to raise errors, defaults to True.
_parent_namespace_depth (int) – The depth level of the parent namespace, defaults to 2.
_types_namespace (dict[str, Any] | None) – The types namespace, defaults to None.

Return type:

Returns:

Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.

classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)[source]

Validate a pydantic model instance.

Parameters:

obj (Any) – The object to validate.
strict (bool | None) – Whether to enforce types strictly.
from_attributes (bool | None) – Whether to extract data from object attributes.
context (Any | None) – Additional context to pass to the validator.

Raises:

ValidationError – If the object could not be validated.

Return type:

Self

Returns:

The validated model instance.

classmethod model_validate_json(json_data, *, strict=None, context=None)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing

Validate the given JSON data against the Pydantic model.

Parameters:

json_data (str | bytes | bytearray) – The JSON data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

Raises:

ValidationError – If json_data is not a JSON string or the object could not be validated.

classmethod model_validate_strings(obj, *, strict=None, context=None)[source]

Validate the given object with string data against the Pydantic model.

Parameters:

obj (Any) – The object containing string data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod parse_obj(obj)[source]

Return type:: Self

classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod schema(by_alias=True, ref_template='#/$defs/{model}')[source]

Return type:: Dict[str, Any]

classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)[source]

Return type:: str

type: Literal['highlight_set_entity'][source]

classmethod update_forward_refs(**localns)[source]

Return type:: None

classmethod validate(value)[source]

Return type:: Self

class kittycad.models.ok_modeling_cmd_response.OptionImportFiles(**data)[source][source]

The response to the ‘ImportFiles’ endpoint

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__abstractmethods__ = frozenset({})[source]

__annotations__ = {'__class_vars__': 'ClassVar[set[str]]', '__private_attributes__': 'ClassVar[Dict[str, ModelPrivateAttr]]', '__pydantic_complete__': 'ClassVar[bool]', '__pydantic_core_schema__': 'ClassVar[CoreSchema]', '__pydantic_custom_init__': 'ClassVar[bool]', '__pydantic_decorators__': 'ClassVar[_decorators.DecoratorInfos]', '__pydantic_extra__': 'dict[str, Any] | None', '__pydantic_fields_set__': 'set[str]', '__pydantic_generic_metadata__': 'ClassVar[_generics.PydanticGenericMetadata]', '__pydantic_parent_namespace__': 'ClassVar[Dict[str, Any] | None]', '__pydantic_post_init__': "ClassVar[None | Literal['model_post_init']]", '__pydantic_private__': 'dict[str, Any] | None', '__pydantic_root_model__': 'ClassVar[bool]', '__pydantic_serializer__': 'ClassVar[SchemaSerializer]', '__pydantic_validator__': 'ClassVar[SchemaValidator | PluggableSchemaValidator]', '__signature__': 'ClassVar[Signature]', 'data': <class 'kittycad.models.import_files.ImportFiles'>, 'model_computed_fields': 'ClassVar[Dict[str, ComputedFieldInfo]]', 'model_config': 'ClassVar[ConfigDict]', 'model_fields': 'ClassVar[Dict[str, FieldInfo]]', 'type': typing.Literal['import_files']}[source]

classmethod __class_getitem__(typevar_values)[source]

Return type:: type[BaseModel] | PydanticRecursiveRef

__class_vars__: ClassVar[set[str]] = {}[source]: The names of the class variables defined on the model.

__copy__()[source]

Returns a shallow copy of the model.

Return type:: Self

__deepcopy__(memo=None)[source]

Returns a deep copy of the model.

Return type:: Self

__delattr__(item)[source]

Implement delattr(self, name).

Return type:: Any

__dict__[source]

__eq__(other)[source]

Return self==value.

Return type:: bool

property __fields_set__: set[str][source]

classmethod __get_pydantic_core_schema__(source, handler, /)[source]

Hook into generating the model’s CoreSchema.

Parameters:

source (type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.
handler (GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.

Return type:

Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]

Returns:

A pydantic-core CoreSchema.

classmethod __get_pydantic_json_schema__(core_schema, handler, /)[source]

Hook into generating the model’s JSON schema.

Parameters:

core_schema (Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({'type': 'nullable', 'schema': current_schema}), or just call the handler with the original schema.
handler (GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.

Return type:

Returns:

A JSON schema, as a Python object.

__getattr__(item)[source]

Return type:: Any

__getstate__()[source]

Helper for pickle.

Return type:: dict[Any, Any]

__hash__ = None[source]

__init__(**data)[source]

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__iter__()[source]

So dict(model) works.

Return type:: Generator[Tuple[str, Any], None, None]

__module__ = 'kittycad.models.ok_modeling_cmd_response'[source]

__pretty__(fmt, **kwargs)[source]

Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.

Return type:: Generator[Any, None, None]

__private_attributes__: ClassVar[Dict[str, ModelPrivateAttr]] = {}[source]: Metadata about the private attributes of the model.

__pydantic_complete__: ClassVar[bool] = True[source]: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__: ClassVar[CoreSchema] = {'cls': <class 'kittycad.models.ok_modeling_cmd_response.OptionImportFiles'>, 'config': {'title': 'OptionImportFiles'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.ok_modeling_cmd_response.OptionImportFiles'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.ok_modeling_cmd_response.OptionImportFiles'>>]}, 'ref': 'kittycad.models.ok_modeling_cmd_response.OptionImportFiles:94667213916864', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'data': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.import_files.ImportFiles'>, 'config': {'title': 'ImportFiles'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.import_files.ImportFiles'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.import_files.ImportFiles'>>]}, 'ref': 'kittycad.models.import_files.ImportFiles:94667207073952', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'object_id': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'type': 'str'}, 'type': 'model-field'}}, 'model_name': 'ImportFiles', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}, 'type': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': 'import_files', 'schema': {'expected': ['import_files'], 'type': 'literal'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'OptionImportFiles', 'type': 'model-fields'}, 'type': 'model'}[source]: The core schema of the model.

__pydantic_custom_init__: ClassVar[bool] = False[source]: Whether the model has a custom __init__ method.

__pydantic_decorators__: ClassVar[_decorators.DecoratorInfos] = DecoratorInfos(validators={}, field_validators={}, root_validators={}, field_serializers={}, model_serializers={}, model_validators={}, computed_fields={})[source]: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_extra__: dict[str, Any] | None[source]: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to 'allow'.

__pydantic_fields_set__: set[str][source]: The names of fields explicitly set during instantiation.

__pydantic_generic_metadata__: ClassVar[_generics.PydanticGenericMetadata] = {'args': (), 'origin': None, 'parameters': ()}[source]: 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.

classmethod __pydantic_init_subclass__(**kwargs)[source]

This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.

This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.

This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.

Parameters:: **kwargs (Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.
Return type:: None

__pydantic_parent_namespace__: ClassVar[Dict[str, Any] | None] = None[source]: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__: ClassVar[None | Literal['model_post_init']] = None[source]: The name of the post-init method for the model, if defined.

__pydantic_private__: dict[str, Any] | None[source]: Values of private attributes set on the model instance.

__pydantic_root_model__: ClassVar[bool] = False[source]: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__: ClassVar[SchemaSerializer] = SchemaSerializer(serializer=Model( ModelSerializer { class: Py( 0x000056196da84ac0, ), serializer: Fields( GeneralFieldsSerializer { fields: { "data": SerField { key_py: Py( 0x00007f9038238fa0, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196d3fe0a0, ), serializer: Fields( GeneralFieldsSerializer { fields: { "object_id": SerField { key_py: Py( 0x00007f9036303530, ), alias: None, alias_py: None, serializer: Some( Str( StrSerializer, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 1, }, ), has_extra: false, root_model: false, name: "ImportFiles", }, ), ), required: true, }, "type": SerField { key_py: Py( 0x00007f903823d958, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f90347f6df0, ), ), serializer: Literal( LiteralSerializer { expected_int: {}, expected_str: { "import_files", }, expected_py: None, name: "literal['import_files']", }, ), }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "OptionImportFiles", }, ), definitions=[])[source]: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__: ClassVar[SchemaValidator | PluggableSchemaValidator] = SchemaValidator(title="OptionImportFiles", validator=Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "data", lookup_key: Simple { key: "data", py_key: Py( 0x00007f903336f690, ), path: LookupPath( [ S( "data", Py( 0x00007f903336fdb0, ), ), ], ), }, name_py: Py( 0x00007f9038238fa0, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "object_id", lookup_key: Simple { key: "object_id", py_key: Py( 0x00007f90333a2a30, ), path: LookupPath( [ S( "object_id", Py( 0x00007f90333a0fb0, ), ), ], ), }, name_py: Py( 0x00007f9036303530, ), validator: Str( StrValidator { strict: false, coerce_numbers_to_str: false, }, ), frozen: false, }, ], model_name: "ImportFiles", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d3fe0a0, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "ImportFiles", }, ), frozen: false, }, Field { name: "type", lookup_key: Simple { key: "type", py_key: Py( 0x00007f903336fb10, ), path: LookupPath( [ S( "type", Py( 0x00007f903336fe70, ), ), ], ), }, name_py: Py( 0x00007f903823d958, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f90347f6df0, ), ), on_error: Raise, validator: Literal( LiteralValidator { lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "import_files": 0, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f90347f6df0, ), ], }, expected_repr: "'import_files'", name: "literal['import_files']", }, ), validate_default: false, copy_default: false, name: "default[literal['import_files']]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "OptionImportFiles", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196da84ac0, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "OptionImportFiles", }, ), definitions=[], cache_strings=True)[source]: The pydantic-core SchemaValidator used to validate instances of the model.

__repr__()[source]

Return repr(self).

Return type:: str

__repr_args__()[source]

Return type:: Iterable[tuple[str | None, Any]]

__repr_name__()[source]

Name of the instance’s class, used in __repr__.

Return type:: str

__repr_str__(join_str)[source]

Return type:: str

__rich_repr__()[source]

Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.

Return type:: Iterable[Any | tuple[Any] | tuple[str, Any] | tuple[str, Any, Any]]

__setattr__(name, value)[source]

Implement setattr(self, name, value).

Return type:: None

__setstate__(state)[source]

Return type:: None

__signature__: ClassVar[Signature] = <Signature (*, data: kittycad.models.import_files.ImportFiles, type: Literal['import_files'] = 'import_files') -> None>[source]: The synthesized __init__ [Signature][inspect.Signature] of the model.

__slots__ = ('__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__')[source]

__str__()[source]

Return str(self).

Return type:: str

_abc_impl = <_abc._abc_data object>[source]

_calculate_keys(*args, **kwargs)[source]

Return type:: Any

_check_frozen(name, value)[source]

Return type:: None

_copy_and_set_values(*args, **kwargs)[source]

Return type:: Any

classmethod _get_value(*args, **kwargs)[source]

Return type:: Any

_iter(*args, **kwargs)[source]

Return type:: Any

classmethod construct(_fields_set=None, **values)[source]

Return type:: Self

copy(*, include=None, exclude=None, update=None, deep=False)[source]

Returns a copy of the model.

!!! warning “Deprecated”: This method is now deprecated; use model_copy instead.

If you need include or exclude, use:

`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `

Parameters:

include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.

Returns:

A copy of the model with included, excluded and updated fields as specified.

data: ImportFiles[source]

dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)[source]

Return type:: Dict[str, Any]

classmethod from_orm(obj)[source]

Return type:: Self

json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)[source]

Return type:: str

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}[source]: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'protected_namespaces': ()}[source]: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod model_construct(_fields_set=None, **values)[source]

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note: model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == 'allow', then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == 'ignore' (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == 'forbid' does not result in an error if extra values are passed, but they will be ignored.

Parameters:

_fields_set (set[str] | None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.
values (Any) – Trusted or pre-validated data dictionary.

Return type:

Self

Returns:

A new instance of the Model class with validated data.

model_copy(*, update=None, deep=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy

Returns a copy of the model.

Parameters:

update (dict[str, Any] | None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.
deep (bool) – Set to True to make a deep copy of the model.

Return type:

Self

Returns:

New model instance.

model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters:

mode (Union[Literal['json', 'python'], str]) – The mode in which to_python 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.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to include in the output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to exclude from the output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to use the field’s alias in the dictionary key if defined.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A dictionary representation of the model.

model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

Generates a JSON representation of the model using Pydantic’s to_json method.

Parameters:

indent (int | None) – Indentation to use in the JSON output. If None is passed, the output will be compact.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to include in the JSON output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to exclude from the JSON output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to serialize using field aliases.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A JSON string representation of the model.

property model_extra: dict[str, Any] | None[source]

Get extra fields set during validation.

Returns:: A dictionary of extra fields, or None if config.extra is not set to "allow".

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=ImportFiles, required=True), 'type': FieldInfo(annotation=Literal['import_files'], required=False, default='import_files')}[source]

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

property model_fields_set: set[str][source]

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,: i.e. that were not filled from defaults.

classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')[source]

Generates a JSON schema for a model class.

Parameters:

by_alias (bool) – Whether to use attribute aliases or not.
ref_template (str) – The reference template.
schema_generator (type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modifications
mode (Literal['validation', 'serialization']) – The mode in which to generate the schema.

Return type:

Returns:

The JSON schema for the given model class.

classmethod model_parametrized_name(params)[source]

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

Parameters:: params (tuple[type[Any], ...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.
Return type:: str
Returns:: String representing the new class where params are passed to cls as type variables.
Raises:: TypeError – Raised when trying to generate concrete names for non-generic models.

model_post_init(_BaseModel__context)[source]

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

Return type:: None

classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)[source]

Try to rebuild the pydantic-core schema for the model.

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.

Parameters:

force (bool) – Whether to force the rebuilding of the model schema, defaults to False.
raise_errors (bool) – Whether to raise errors, defaults to True.
_parent_namespace_depth (int) – The depth level of the parent namespace, defaults to 2.
_types_namespace (dict[str, Any] | None) – The types namespace, defaults to None.

Return type:

Returns:

Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.

classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)[source]

Validate a pydantic model instance.

Parameters:

obj (Any) – The object to validate.
strict (bool | None) – Whether to enforce types strictly.
from_attributes (bool | None) – Whether to extract data from object attributes.
context (Any | None) – Additional context to pass to the validator.

Raises:

ValidationError – If the object could not be validated.

Return type:

Self

Returns:

The validated model instance.

classmethod model_validate_json(json_data, *, strict=None, context=None)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing

Validate the given JSON data against the Pydantic model.

Parameters:

json_data (str | bytes | bytearray) – The JSON data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

Raises:

ValidationError – If json_data is not a JSON string or the object could not be validated.

classmethod model_validate_strings(obj, *, strict=None, context=None)[source]

Validate the given object with string data against the Pydantic model.

Parameters:

obj (Any) – The object containing string data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod parse_obj(obj)[source]

Return type:: Self

classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod schema(by_alias=True, ref_template='#/$defs/{model}')[source]

Return type:: Dict[str, Any]

classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)[source]

Return type:: str

type: Literal['import_files'][source]

classmethod update_forward_refs(**localns)[source]

Return type:: None

classmethod validate(value)[source]

Return type:: Self

class kittycad.models.ok_modeling_cmd_response.OptionImportedGeometry(**data)[source][source]

The response to the ‘ImportedGeometry’ endpoint

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__abstractmethods__ = frozenset({})[source]

__annotations__ = {'__class_vars__': 'ClassVar[set[str]]', '__private_attributes__': 'ClassVar[Dict[str, ModelPrivateAttr]]', '__pydantic_complete__': 'ClassVar[bool]', '__pydantic_core_schema__': 'ClassVar[CoreSchema]', '__pydantic_custom_init__': 'ClassVar[bool]', '__pydantic_decorators__': 'ClassVar[_decorators.DecoratorInfos]', '__pydantic_extra__': 'dict[str, Any] | None', '__pydantic_fields_set__': 'set[str]', '__pydantic_generic_metadata__': 'ClassVar[_generics.PydanticGenericMetadata]', '__pydantic_parent_namespace__': 'ClassVar[Dict[str, Any] | None]', '__pydantic_post_init__': "ClassVar[None | Literal['model_post_init']]", '__pydantic_private__': 'dict[str, Any] | None', '__pydantic_root_model__': 'ClassVar[bool]', '__pydantic_serializer__': 'ClassVar[SchemaSerializer]', '__pydantic_validator__': 'ClassVar[SchemaValidator | PluggableSchemaValidator]', '__signature__': 'ClassVar[Signature]', 'data': <class 'kittycad.models.imported_geometry.ImportedGeometry'>, 'model_computed_fields': 'ClassVar[Dict[str, ComputedFieldInfo]]', 'model_config': 'ClassVar[ConfigDict]', 'model_fields': 'ClassVar[Dict[str, FieldInfo]]', 'type': typing.Literal['imported_geometry']}[source]

classmethod __class_getitem__(typevar_values)[source]

Return type:: type[BaseModel] | PydanticRecursiveRef

__class_vars__: ClassVar[set[str]] = {}[source]: The names of the class variables defined on the model.

__copy__()[source]

Returns a shallow copy of the model.

Return type:: Self

__deepcopy__(memo=None)[source]

Returns a deep copy of the model.

Return type:: Self

__delattr__(item)[source]

Implement delattr(self, name).

Return type:: Any

__dict__[source]

__eq__(other)[source]

Return self==value.

Return type:: bool

property __fields_set__: set[str][source]

classmethod __get_pydantic_core_schema__(source, handler, /)[source]

Hook into generating the model’s CoreSchema.

Parameters:

source (type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.
handler (GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.

Return type:

Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]

Returns:

A pydantic-core CoreSchema.

classmethod __get_pydantic_json_schema__(core_schema, handler, /)[source]

Hook into generating the model’s JSON schema.

Parameters:

core_schema (Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({'type': 'nullable', 'schema': current_schema}), or just call the handler with the original schema.
handler (GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.

Return type:

Returns:

A JSON schema, as a Python object.

__getattr__(item)[source]

Return type:: Any

__getstate__()[source]

Helper for pickle.

Return type:: dict[Any, Any]

__hash__ = None[source]

__init__(**data)[source]

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__iter__()[source]

So dict(model) works.

Return type:: Generator[Tuple[str, Any], None, None]

__module__ = 'kittycad.models.ok_modeling_cmd_response'[source]

__pretty__(fmt, **kwargs)[source]

Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.

Return type:: Generator[Any, None, None]

__private_attributes__: ClassVar[Dict[str, ModelPrivateAttr]] = {}[source]: Metadata about the private attributes of the model.

__pydantic_complete__: ClassVar[bool] = True[source]: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__: ClassVar[CoreSchema] = {'cls': <class 'kittycad.models.ok_modeling_cmd_response.OptionImportedGeometry'>, 'config': {'title': 'OptionImportedGeometry'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.ok_modeling_cmd_response.OptionImportedGeometry'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.ok_modeling_cmd_response.OptionImportedGeometry'>>]}, 'ref': 'kittycad.models.ok_modeling_cmd_response.OptionImportedGeometry:94667213935392', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'data': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.imported_geometry.ImportedGeometry'>, 'config': {'title': 'ImportedGeometry'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.imported_geometry.ImportedGeometry'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.imported_geometry.ImportedGeometry'>>]}, 'ref': 'kittycad.models.imported_geometry.ImportedGeometry:94667207068368', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'id': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'type': 'str'}, 'type': 'model-field'}, 'value': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'items_schema': {'type': 'str'}, 'type': 'list'}, 'type': 'model-field'}}, 'model_name': 'ImportedGeometry', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}, 'type': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': 'imported_geometry', 'schema': {'expected': ['imported_geometry'], 'type': 'literal'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'OptionImportedGeometry', 'type': 'model-fields'}, 'type': 'model'}[source]: The core schema of the model.

__pydantic_custom_init__: ClassVar[bool] = False[source]: Whether the model has a custom __init__ method.

__pydantic_decorators__: ClassVar[_decorators.DecoratorInfos] = DecoratorInfos(validators={}, field_validators={}, root_validators={}, field_serializers={}, model_serializers={}, model_validators={}, computed_fields={})[source]: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_extra__: dict[str, Any] | None[source]: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to 'allow'.

__pydantic_fields_set__: set[str][source]: The names of fields explicitly set during instantiation.

__pydantic_generic_metadata__: ClassVar[_generics.PydanticGenericMetadata] = {'args': (), 'origin': None, 'parameters': ()}[source]: 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.

classmethod __pydantic_init_subclass__(**kwargs)[source]

This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.

This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.

This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.

Parameters:: **kwargs (Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.
Return type:: None

__pydantic_parent_namespace__: ClassVar[Dict[str, Any] | None] = None[source]: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__: ClassVar[None | Literal['model_post_init']] = None[source]: The name of the post-init method for the model, if defined.

__pydantic_private__: dict[str, Any] | None[source]: Values of private attributes set on the model instance.

__pydantic_root_model__: ClassVar[bool] = False[source]: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__: ClassVar[SchemaSerializer] = SchemaSerializer(serializer=Model( ModelSerializer { class: Py( 0x000056196da89320, ), serializer: Fields( GeneralFieldsSerializer { fields: { "type": SerField { key_py: Py( 0x00007f903823d958, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f90347f6d30, ), ), serializer: Literal( LiteralSerializer { expected_int: {}, expected_str: { "imported_geometry", }, expected_py: None, name: "literal['imported_geometry']", }, ), }, ), ), required: true, }, "data": SerField { key_py: Py( 0x00007f9038238fa0, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196d3fcad0, ), serializer: Fields( GeneralFieldsSerializer { fields: { "id": SerField { key_py: Py( 0x00007f903823a3e8, ), alias: None, alias_py: None, serializer: Some( Str( StrSerializer, ), ), required: true, }, "value": SerField { key_py: Py( 0x00007f903823db20, ), alias: None, alias_py: None, serializer: Some( List( ListSerializer { item_serializer: Str( StrSerializer, ), filter: SchemaFilter { include: None, exclude: None, }, name: "list[str]", }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "ImportedGeometry", }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "OptionImportedGeometry", }, ), definitions=[])[source]: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__: ClassVar[SchemaValidator | PluggableSchemaValidator] = SchemaValidator(title="OptionImportedGeometry", validator=Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "data", lookup_key: Simple { key: "data", py_key: Py( 0x00007f90333a97a0, ), path: LookupPath( [ S( "data", Py( 0x00007f90333a9ce0, ), ), ], ), }, name_py: Py( 0x00007f9038238fa0, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "id", lookup_key: Simple { key: "id", py_key: Py( 0x00007f90335221f0, ), path: LookupPath( [ S( "id", Py( 0x00007f9033522190, ), ), ], ), }, name_py: Py( 0x00007f903823a3e8, ), validator: Str( StrValidator { strict: false, coerce_numbers_to_str: false, }, ), frozen: false, }, Field { name: "value", lookup_key: Simple { key: "value", py_key: Py( 0x00007f9033522160, ), path: LookupPath( [ S( "value", Py( 0x00007f90335221c0, ), ), ], ), }, name_py: Py( 0x00007f903823db20, ), validator: List( ListValidator { strict: false, item_validator: Some( Str( StrValidator { strict: false, coerce_numbers_to_str: false, }, ), ), min_length: None, max_length: None, name: OnceLock( <uninit>, ), fail_fast: false, }, ), frozen: false, }, ], model_name: "ImportedGeometry", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d3fcad0, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "ImportedGeometry", }, ), frozen: false, }, Field { name: "type", lookup_key: Simple { key: "type", py_key: Py( 0x00007f90333a8b70, ), path: LookupPath( [ S( "type", Py( 0x00007f90333a9ef0, ), ), ], ), }, name_py: Py( 0x00007f903823d958, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f90347f6d30, ), ), on_error: Raise, validator: Literal( LiteralValidator { lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "imported_geometry": 0, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f90347f6d30, ), ], }, expected_repr: "'imported_geometry'", name: "literal['imported_geometry']", }, ), validate_default: false, copy_default: false, name: "default[literal['imported_geometry']]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "OptionImportedGeometry", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196da89320, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "OptionImportedGeometry", }, ), definitions=[], cache_strings=True)[source]: The pydantic-core SchemaValidator used to validate instances of the model.

__repr__()[source]

Return repr(self).

Return type:: str

__repr_args__()[source]

Return type:: Iterable[tuple[str | None, Any]]

__repr_name__()[source]

Name of the instance’s class, used in __repr__.

Return type:: str

__repr_str__(join_str)[source]

Return type:: str

__rich_repr__()[source]

Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.

Return type:: Iterable[Any | tuple[Any] | tuple[str, Any] | tuple[str, Any, Any]]

__setattr__(name, value)[source]

Implement setattr(self, name, value).

Return type:: None

__setstate__(state)[source]

Return type:: None

__signature__: ClassVar[Signature] = <Signature (*, data: kittycad.models.imported_geometry.ImportedGeometry, type: Literal['imported_geometry'] = 'imported_geometry') -> None>[source]: The synthesized __init__ [Signature][inspect.Signature] of the model.

__slots__ = ('__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__')[source]

__str__()[source]

Return str(self).

Return type:: str

_abc_impl = <_abc._abc_data object>[source]

_calculate_keys(*args, **kwargs)[source]

Return type:: Any

_check_frozen(name, value)[source]

Return type:: None

_copy_and_set_values(*args, **kwargs)[source]

Return type:: Any

classmethod _get_value(*args, **kwargs)[source]

Return type:: Any

_iter(*args, **kwargs)[source]

Return type:: Any

classmethod construct(_fields_set=None, **values)[source]

Return type:: Self

copy(*, include=None, exclude=None, update=None, deep=False)[source]

Returns a copy of the model.

!!! warning “Deprecated”: This method is now deprecated; use model_copy instead.

If you need include or exclude, use:

`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `

Parameters:

include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.

Returns:

A copy of the model with included, excluded and updated fields as specified.

data: ImportedGeometry[source]

dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)[source]

Return type:: Dict[str, Any]

classmethod from_orm(obj)[source]

Return type:: Self

json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)[source]

Return type:: str

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}[source]: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'protected_namespaces': ()}[source]: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod model_construct(_fields_set=None, **values)[source]

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note: model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == 'allow', then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == 'ignore' (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == 'forbid' does not result in an error if extra values are passed, but they will be ignored.

Parameters:

_fields_set (set[str] | None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.
values (Any) – Trusted or pre-validated data dictionary.

Return type:

Self

Returns:

A new instance of the Model class with validated data.

model_copy(*, update=None, deep=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy

Returns a copy of the model.

Parameters:

update (dict[str, Any] | None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.
deep (bool) – Set to True to make a deep copy of the model.

Return type:

Self

Returns:

New model instance.

model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters:

mode (Union[Literal['json', 'python'], str]) – The mode in which to_python 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.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to include in the output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to exclude from the output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to use the field’s alias in the dictionary key if defined.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A dictionary representation of the model.

model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

Generates a JSON representation of the model using Pydantic’s to_json method.

Parameters:

indent (int | None) – Indentation to use in the JSON output. If None is passed, the output will be compact.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to include in the JSON output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to exclude from the JSON output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to serialize using field aliases.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A JSON string representation of the model.

property model_extra: dict[str, Any] | None[source]

Get extra fields set during validation.

Returns:: A dictionary of extra fields, or None if config.extra is not set to "allow".

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=ImportedGeometry, required=True), 'type': FieldInfo(annotation=Literal['imported_geometry'], required=False, default='imported_geometry')}[source]

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

property model_fields_set: set[str][source]

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,: i.e. that were not filled from defaults.

classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')[source]

Generates a JSON schema for a model class.

Parameters:

by_alias (bool) – Whether to use attribute aliases or not.
ref_template (str) – The reference template.
schema_generator (type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modifications
mode (Literal['validation', 'serialization']) – The mode in which to generate the schema.

Return type:

Returns:

The JSON schema for the given model class.

classmethod model_parametrized_name(params)[source]

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

Parameters:: params (tuple[type[Any], ...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.
Return type:: str
Returns:: String representing the new class where params are passed to cls as type variables.
Raises:: TypeError – Raised when trying to generate concrete names for non-generic models.

model_post_init(_BaseModel__context)[source]

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

Return type:: None

classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)[source]

Try to rebuild the pydantic-core schema for the model.

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.

Parameters:

force (bool) – Whether to force the rebuilding of the model schema, defaults to False.
raise_errors (bool) – Whether to raise errors, defaults to True.
_parent_namespace_depth (int) – The depth level of the parent namespace, defaults to 2.
_types_namespace (dict[str, Any] | None) – The types namespace, defaults to None.

Return type:

Returns:

Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.

classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)[source]

Validate a pydantic model instance.

Parameters:

obj (Any) – The object to validate.
strict (bool | None) – Whether to enforce types strictly.
from_attributes (bool | None) – Whether to extract data from object attributes.
context (Any | None) – Additional context to pass to the validator.

Raises:

ValidationError – If the object could not be validated.

Return type:

Self

Returns:

The validated model instance.

classmethod model_validate_json(json_data, *, strict=None, context=None)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing

Validate the given JSON data against the Pydantic model.

Parameters:

json_data (str | bytes | bytearray) – The JSON data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

Raises:

ValidationError – If json_data is not a JSON string or the object could not be validated.

classmethod model_validate_strings(obj, *, strict=None, context=None)[source]

Validate the given object with string data against the Pydantic model.

Parameters:

obj (Any) – The object containing string data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod parse_obj(obj)[source]

Return type:: Self

classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod schema(by_alias=True, ref_template='#/$defs/{model}')[source]

Return type:: Dict[str, Any]

classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)[source]

Return type:: str

type: Literal['imported_geometry'][source]

classmethod update_forward_refs(**localns)[source]

Return type:: None

classmethod validate(value)[source]

Return type:: Self

class kittycad.models.ok_modeling_cmd_response.OptionLoft(**data)[source][source]

The response to the ‘Loft’ endpoint

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__abstractmethods__ = frozenset({})[source]

__annotations__ = {'__class_vars__': 'ClassVar[set[str]]', '__private_attributes__': 'ClassVar[Dict[str, ModelPrivateAttr]]', '__pydantic_complete__': 'ClassVar[bool]', '__pydantic_core_schema__': 'ClassVar[CoreSchema]', '__pydantic_custom_init__': 'ClassVar[bool]', '__pydantic_decorators__': 'ClassVar[_decorators.DecoratorInfos]', '__pydantic_extra__': 'dict[str, Any] | None', '__pydantic_fields_set__': 'set[str]', '__pydantic_generic_metadata__': 'ClassVar[_generics.PydanticGenericMetadata]', '__pydantic_parent_namespace__': 'ClassVar[Dict[str, Any] | None]', '__pydantic_post_init__': "ClassVar[None | Literal['model_post_init']]", '__pydantic_private__': 'dict[str, Any] | None', '__pydantic_root_model__': 'ClassVar[bool]', '__pydantic_serializer__': 'ClassVar[SchemaSerializer]', '__pydantic_validator__': 'ClassVar[SchemaValidator | PluggableSchemaValidator]', '__signature__': 'ClassVar[Signature]', 'data': <class 'kittycad.models.loft.Loft'>, 'model_computed_fields': 'ClassVar[Dict[str, ComputedFieldInfo]]', 'model_config': 'ClassVar[ConfigDict]', 'model_fields': 'ClassVar[Dict[str, FieldInfo]]', 'type': typing.Literal['loft']}[source]

classmethod __class_getitem__(typevar_values)[source]

Return type:: type[BaseModel] | PydanticRecursiveRef

__class_vars__: ClassVar[set[str]] = {}[source]: The names of the class variables defined on the model.

__copy__()[source]

Returns a shallow copy of the model.

Return type:: Self

__deepcopy__(memo=None)[source]

Returns a deep copy of the model.

Return type:: Self

__delattr__(item)[source]

Implement delattr(self, name).

Return type:: Any

__dict__[source]

__eq__(other)[source]

Return self==value.

Return type:: bool

property __fields_set__: set[str][source]

classmethod __get_pydantic_core_schema__(source, handler, /)[source]

Hook into generating the model’s CoreSchema.

Parameters:

source (type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.
handler (GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.

Return type:

Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]

Returns:

A pydantic-core CoreSchema.

classmethod __get_pydantic_json_schema__(core_schema, handler, /)[source]

Hook into generating the model’s JSON schema.

Parameters:

core_schema (Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({'type': 'nullable', 'schema': current_schema}), or just call the handler with the original schema.
handler (GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.

Return type:

Returns:

A JSON schema, as a Python object.

__getattr__(item)[source]

Return type:: Any

__getstate__()[source]

Helper for pickle.

Return type:: dict[Any, Any]

__hash__ = None[source]

__init__(**data)[source]

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__iter__()[source]

So dict(model) works.

Return type:: Generator[Tuple[str, Any], None, None]

__module__ = 'kittycad.models.ok_modeling_cmd_response'[source]

__pretty__(fmt, **kwargs)[source]

Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.

Return type:: Generator[Any, None, None]

__private_attributes__: ClassVar[Dict[str, ModelPrivateAttr]] = {}[source]: Metadata about the private attributes of the model.

__pydantic_complete__: ClassVar[bool] = True[source]: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__: ClassVar[CoreSchema] = {'cls': <class 'kittycad.models.ok_modeling_cmd_response.OptionLoft'>, 'config': {'title': 'OptionLoft'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.ok_modeling_cmd_response.OptionLoft'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.ok_modeling_cmd_response.OptionLoft'>>]}, 'ref': 'kittycad.models.ok_modeling_cmd_response.OptionLoft:94667213306432', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'data': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.loft.Loft'>, 'config': {'title': 'Loft'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.loft.Loft'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.loft.Loft'>>]}, 'ref': 'kittycad.models.loft.Loft:94667207342768', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'solid_id': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'type': 'str'}, 'type': 'model-field'}}, 'model_name': 'Loft', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}, 'type': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': 'loft', 'schema': {'expected': ['loft'], 'type': 'literal'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'OptionLoft', 'type': 'model-fields'}, 'type': 'model'}[source]: The core schema of the model.

__pydantic_custom_init__: ClassVar[bool] = False[source]: Whether the model has a custom __init__ method.

__pydantic_decorators__: ClassVar[_decorators.DecoratorInfos] = DecoratorInfos(validators={}, field_validators={}, root_validators={}, field_serializers={}, model_serializers={}, model_validators={}, computed_fields={})[source]: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_extra__: dict[str, Any] | None[source]: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to 'allow'.

__pydantic_fields_set__: set[str][source]: The names of fields explicitly set during instantiation.

__pydantic_generic_metadata__: ClassVar[_generics.PydanticGenericMetadata] = {'args': (), 'origin': None, 'parameters': ()}[source]: 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.

classmethod __pydantic_init_subclass__(**kwargs)[source]

This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.

This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.

This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.

Parameters:: **kwargs (Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.
Return type:: None

__pydantic_parent_namespace__: ClassVar[Dict[str, Any] | None] = None[source]: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__: ClassVar[None | Literal['model_post_init']] = None[source]: The name of the post-init method for the model, if defined.

__pydantic_private__: dict[str, Any] | None[source]: Values of private attributes set on the model instance.

__pydantic_root_model__: ClassVar[bool] = False[source]: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__: ClassVar[SchemaSerializer] = SchemaSerializer(serializer=Model( ModelSerializer { class: Py( 0x000056196d9efa40, ), serializer: Fields( GeneralFieldsSerializer { fields: { "type": SerField { key_py: Py( 0x00007f903823d958, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f9034acf210, ), ), serializer: Literal( LiteralSerializer { expected_int: {}, expected_str: { "loft", }, expected_py: None, name: "literal['loft']", }, ), }, ), ), required: true, }, "data": SerField { key_py: Py( 0x00007f9038238fa0, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196d43fab0, ), serializer: Fields( GeneralFieldsSerializer { fields: { "solid_id": SerField { key_py: Py( 0x00007f9033844870, ), alias: None, alias_py: None, serializer: Some( Str( StrSerializer, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 1, }, ), has_extra: false, root_model: false, name: "Loft", }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "OptionLoft", }, ), definitions=[])[source]: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__: ClassVar[SchemaValidator | PluggableSchemaValidator] = SchemaValidator(title="OptionLoft", validator=Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "data", lookup_key: Simple { key: "data", py_key: Py( 0x00007f9033521890, ), path: LookupPath( [ S( "data", Py( 0x00007f90335217d0, ), ), ], ), }, name_py: Py( 0x00007f9038238fa0, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "solid_id", lookup_key: Simple { key: "solid_id", py_key: Py( 0x00007f903334b870, ), path: LookupPath( [ S( "solid_id", Py( 0x00007f903334b830, ), ), ], ), }, name_py: Py( 0x00007f9033844870, ), validator: Str( StrValidator { strict: false, coerce_numbers_to_str: false, }, ), frozen: false, }, ], model_name: "Loft", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d43fab0, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "Loft", }, ), frozen: false, }, Field { name: "type", lookup_key: Simple { key: "type", py_key: Py( 0x00007f9033521680, ), path: LookupPath( [ S( "type", Py( 0x00007f9033521650, ), ), ], ), }, name_py: Py( 0x00007f903823d958, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f9034acf210, ), ), on_error: Raise, validator: Literal( LiteralValidator { lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "loft": 0, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f9034acf210, ), ], }, expected_repr: "'loft'", name: "literal['loft']", }, ), validate_default: false, copy_default: false, name: "default[literal['loft']]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "OptionLoft", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d9efa40, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "OptionLoft", }, ), definitions=[], cache_strings=True)[source]: The pydantic-core SchemaValidator used to validate instances of the model.

__repr__()[source]

Return repr(self).

Return type:: str

__repr_args__()[source]

Return type:: Iterable[tuple[str | None, Any]]

__repr_name__()[source]

Name of the instance’s class, used in __repr__.

Return type:: str

__repr_str__(join_str)[source]

Return type:: str

__rich_repr__()[source]

Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.

Return type:: Iterable[Any | tuple[Any] | tuple[str, Any] | tuple[str, Any, Any]]

__setattr__(name, value)[source]

Implement setattr(self, name, value).

Return type:: None

__setstate__(state)[source]

Return type:: None

__signature__: ClassVar[Signature] = <Signature (*, data: kittycad.models.loft.Loft, type: Literal['loft'] = 'loft') -> None>[source]: The synthesized __init__ [Signature][inspect.Signature] of the model.

__slots__ = ('__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__')[source]

__str__()[source]

Return str(self).

Return type:: str

_abc_impl = <_abc._abc_data object>[source]

_calculate_keys(*args, **kwargs)[source]

Return type:: Any

_check_frozen(name, value)[source]

Return type:: None

_copy_and_set_values(*args, **kwargs)[source]

Return type:: Any

classmethod _get_value(*args, **kwargs)[source]

Return type:: Any

_iter(*args, **kwargs)[source]

Return type:: Any

classmethod construct(_fields_set=None, **values)[source]

Return type:: Self

copy(*, include=None, exclude=None, update=None, deep=False)[source]

Returns a copy of the model.

!!! warning “Deprecated”: This method is now deprecated; use model_copy instead.

If you need include or exclude, use:

`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `

Parameters:

include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.

Returns:

A copy of the model with included, excluded and updated fields as specified.

data: Loft[source]

dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)[source]

Return type:: Dict[str, Any]

classmethod from_orm(obj)[source]

Return type:: Self

json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)[source]

Return type:: str

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}[source]: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'protected_namespaces': ()}[source]: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod model_construct(_fields_set=None, **values)[source]

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note: model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == 'allow', then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == 'ignore' (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == 'forbid' does not result in an error if extra values are passed, but they will be ignored.

Parameters:

_fields_set (set[str] | None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.
values (Any) – Trusted or pre-validated data dictionary.

Return type:

Self

Returns:

A new instance of the Model class with validated data.

model_copy(*, update=None, deep=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy

Returns a copy of the model.

Parameters:

update (dict[str, Any] | None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.
deep (bool) – Set to True to make a deep copy of the model.

Return type:

Self

Returns:

New model instance.

model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters:

mode (Union[Literal['json', 'python'], str]) – The mode in which to_python 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.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to include in the output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to exclude from the output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to use the field’s alias in the dictionary key if defined.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A dictionary representation of the model.

model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

Generates a JSON representation of the model using Pydantic’s to_json method.

Parameters:

indent (int | None) – Indentation to use in the JSON output. If None is passed, the output will be compact.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to include in the JSON output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to exclude from the JSON output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to serialize using field aliases.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A JSON string representation of the model.

property model_extra: dict[str, Any] | None[source]

Get extra fields set during validation.

Returns:: A dictionary of extra fields, or None if config.extra is not set to "allow".

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=Loft, required=True), 'type': FieldInfo(annotation=Literal['loft'], required=False, default='loft')}[source]

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

property model_fields_set: set[str][source]

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,: i.e. that were not filled from defaults.

classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')[source]

Generates a JSON schema for a model class.

Parameters:

by_alias (bool) – Whether to use attribute aliases or not.
ref_template (str) – The reference template.
schema_generator (type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modifications
mode (Literal['validation', 'serialization']) – The mode in which to generate the schema.

Return type:

Returns:

The JSON schema for the given model class.

classmethod model_parametrized_name(params)[source]

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

Parameters:: params (tuple[type[Any], ...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.
Return type:: str
Returns:: String representing the new class where params are passed to cls as type variables.
Raises:: TypeError – Raised when trying to generate concrete names for non-generic models.

model_post_init(_BaseModel__context)[source]

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

Return type:: None

classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)[source]

Try to rebuild the pydantic-core schema for the model.

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.

Parameters:

force (bool) – Whether to force the rebuilding of the model schema, defaults to False.
raise_errors (bool) – Whether to raise errors, defaults to True.
_parent_namespace_depth (int) – The depth level of the parent namespace, defaults to 2.
_types_namespace (dict[str, Any] | None) – The types namespace, defaults to None.

Return type:

Returns:

Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.

classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)[source]

Validate a pydantic model instance.

Parameters:

obj (Any) – The object to validate.
strict (bool | None) – Whether to enforce types strictly.
from_attributes (bool | None) – Whether to extract data from object attributes.
context (Any | None) – Additional context to pass to the validator.

Raises:

ValidationError – If the object could not be validated.

Return type:

Self

Returns:

The validated model instance.

classmethod model_validate_json(json_data, *, strict=None, context=None)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing

Validate the given JSON data against the Pydantic model.

Parameters:

json_data (str | bytes | bytearray) – The JSON data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

Raises:

ValidationError – If json_data is not a JSON string or the object could not be validated.

classmethod model_validate_strings(obj, *, strict=None, context=None)[source]

Validate the given object with string data against the Pydantic model.

Parameters:

obj (Any) – The object containing string data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod parse_obj(obj)[source]

Return type:: Self

classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod schema(by_alias=True, ref_template='#/$defs/{model}')[source]

Return type:: Dict[str, Any]

classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)[source]

Return type:: str

type: Literal['loft'][source]

classmethod update_forward_refs(**localns)[source]

Return type:: None

classmethod validate(value)[source]

Return type:: Self

class kittycad.models.ok_modeling_cmd_response.OptionMakeAxesGizmo(**data)[source][source]

The response to the ‘MakeAxesGizmo’ endpoint

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__abstractmethods__ = frozenset({})[source]

__annotations__ = {'__class_vars__': 'ClassVar[set[str]]', '__private_attributes__': 'ClassVar[Dict[str, ModelPrivateAttr]]', '__pydantic_complete__': 'ClassVar[bool]', '__pydantic_core_schema__': 'ClassVar[CoreSchema]', '__pydantic_custom_init__': 'ClassVar[bool]', '__pydantic_decorators__': 'ClassVar[_decorators.DecoratorInfos]', '__pydantic_extra__': 'dict[str, Any] | None', '__pydantic_fields_set__': 'set[str]', '__pydantic_generic_metadata__': 'ClassVar[_generics.PydanticGenericMetadata]', '__pydantic_parent_namespace__': 'ClassVar[Dict[str, Any] | None]', '__pydantic_post_init__': "ClassVar[None | Literal['model_post_init']]", '__pydantic_private__': 'dict[str, Any] | None', '__pydantic_root_model__': 'ClassVar[bool]', '__pydantic_serializer__': 'ClassVar[SchemaSerializer]', '__pydantic_validator__': 'ClassVar[SchemaValidator | PluggableSchemaValidator]', '__signature__': 'ClassVar[Signature]', 'data': <class 'kittycad.models.make_axes_gizmo.MakeAxesGizmo'>, 'model_computed_fields': 'ClassVar[Dict[str, ComputedFieldInfo]]', 'model_config': 'ClassVar[ConfigDict]', 'model_fields': 'ClassVar[Dict[str, FieldInfo]]', 'type': typing.Literal['make_axes_gizmo']}[source]

classmethod __class_getitem__(typevar_values)[source]

Return type:: type[BaseModel] | PydanticRecursiveRef

__class_vars__: ClassVar[set[str]] = {}[source]: The names of the class variables defined on the model.

__copy__()[source]

Returns a shallow copy of the model.

Return type:: Self

__deepcopy__(memo=None)[source]

Returns a deep copy of the model.

Return type:: Self

__delattr__(item)[source]

Implement delattr(self, name).

Return type:: Any

__dict__[source]

__eq__(other)[source]

Return self==value.

Return type:: bool

property __fields_set__: set[str][source]

classmethod __get_pydantic_core_schema__(source, handler, /)[source]

Hook into generating the model’s CoreSchema.

Parameters:

source (type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.
handler (GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.

Return type:

Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]

Returns:

A pydantic-core CoreSchema.

classmethod __get_pydantic_json_schema__(core_schema, handler, /)[source]

Hook into generating the model’s JSON schema.

Parameters:

core_schema (Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({'type': 'nullable', 'schema': current_schema}), or just call the handler with the original schema.
handler (GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.

Return type:

Returns:

A JSON schema, as a Python object.

__getattr__(item)[source]

Return type:: Any

__getstate__()[source]

Helper for pickle.

Return type:: dict[Any, Any]

__hash__ = None[source]

__init__(**data)[source]

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__iter__()[source]

So dict(model) works.

Return type:: Generator[Tuple[str, Any], None, None]

__module__ = 'kittycad.models.ok_modeling_cmd_response'[source]

__pretty__(fmt, **kwargs)[source]

Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.

Return type:: Generator[Any, None, None]

__private_attributes__: ClassVar[Dict[str, ModelPrivateAttr]] = {}[source]: Metadata about the private attributes of the model.

__pydantic_complete__: ClassVar[bool] = True[source]: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__: ClassVar[CoreSchema] = {'cls': <class 'kittycad.models.ok_modeling_cmd_response.OptionMakeAxesGizmo'>, 'config': {'title': 'OptionMakeAxesGizmo'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.ok_modeling_cmd_response.OptionMakeAxesGizmo'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.ok_modeling_cmd_response.OptionMakeAxesGizmo'>>]}, 'ref': 'kittycad.models.ok_modeling_cmd_response.OptionMakeAxesGizmo:94667213074016', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'data': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.make_axes_gizmo.MakeAxesGizmo'>, 'config': {'title': 'MakeAxesGizmo'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.make_axes_gizmo.MakeAxesGizmo'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.make_axes_gizmo.MakeAxesGizmo'>>]}, 'ref': 'kittycad.models.make_axes_gizmo.MakeAxesGizmo:94667207360368', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {}, 'model_name': 'MakeAxesGizmo', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}, 'type': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': 'make_axes_gizmo', 'schema': {'expected': ['make_axes_gizmo'], 'type': 'literal'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'OptionMakeAxesGizmo', 'type': 'model-fields'}, 'type': 'model'}[source]: The core schema of the model.

__pydantic_custom_init__: ClassVar[bool] = False[source]: Whether the model has a custom __init__ method.

__pydantic_decorators__: ClassVar[_decorators.DecoratorInfos] = DecoratorInfos(validators={}, field_validators={}, root_validators={}, field_serializers={}, model_serializers={}, model_validators={}, computed_fields={})[source]: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_extra__: dict[str, Any] | None[source]: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to 'allow'.

__pydantic_fields_set__: set[str][source]: The names of fields explicitly set during instantiation.

__pydantic_generic_metadata__: ClassVar[_generics.PydanticGenericMetadata] = {'args': (), 'origin': None, 'parameters': ()}[source]: 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.

classmethod __pydantic_init_subclass__(**kwargs)[source]

This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.

This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.

This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.

Parameters:: **kwargs (Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.
Return type:: None

__pydantic_parent_namespace__: ClassVar[Dict[str, Any] | None] = None[source]: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__: ClassVar[None | Literal['model_post_init']] = None[source]: The name of the post-init method for the model, if defined.

__pydantic_private__: dict[str, Any] | None[source]: Values of private attributes set on the model instance.

__pydantic_root_model__: ClassVar[bool] = False[source]: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__: ClassVar[SchemaSerializer] = SchemaSerializer(serializer=Model( ModelSerializer { class: Py( 0x000056196d9b6e60, ), serializer: Fields( GeneralFieldsSerializer { fields: { "data": SerField { key_py: Py( 0x00007f9038238fa0, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196d443f70, ), serializer: Fields( GeneralFieldsSerializer { fields: {}, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 0, }, ), has_extra: false, root_model: false, name: "MakeAxesGizmo", }, ), ), required: true, }, "type": SerField { key_py: Py( 0x00007f903823d958, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f90347f5ff0, ), ), serializer: Literal( LiteralSerializer { expected_int: {}, expected_str: { "make_axes_gizmo", }, expected_py: None, name: "literal['make_axes_gizmo']", }, ), }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "OptionMakeAxesGizmo", }, ), definitions=[])[source]: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__: ClassVar[SchemaValidator | PluggableSchemaValidator] = SchemaValidator(title="OptionMakeAxesGizmo", validator=Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "data", lookup_key: Simple { key: "data", py_key: Py( 0x00007f9033520570, ), path: LookupPath( [ S( "data", Py( 0x00007f90335205a0, ), ), ], ), }, name_py: Py( 0x00007f9038238fa0, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [], model_name: "MakeAxesGizmo", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d443f70, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "MakeAxesGizmo", }, ), frozen: false, }, Field { name: "type", lookup_key: Simple { key: "type", py_key: Py( 0x00007f90335205d0, ), path: LookupPath( [ S( "type", Py( 0x00007f9033520600, ), ), ], ), }, name_py: Py( 0x00007f903823d958, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f90347f5ff0, ), ), on_error: Raise, validator: Literal( LiteralValidator { lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "make_axes_gizmo": 0, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f90347f5ff0, ), ], }, expected_repr: "'make_axes_gizmo'", name: "literal['make_axes_gizmo']", }, ), validate_default: false, copy_default: false, name: "default[literal['make_axes_gizmo']]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "OptionMakeAxesGizmo", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d9b6e60, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "OptionMakeAxesGizmo", }, ), definitions=[], cache_strings=True)[source]: The pydantic-core SchemaValidator used to validate instances of the model.

__repr__()[source]

Return repr(self).

Return type:: str

__repr_args__()[source]

Return type:: Iterable[tuple[str | None, Any]]

__repr_name__()[source]

Name of the instance’s class, used in __repr__.

Return type:: str

__repr_str__(join_str)[source]

Return type:: str

__rich_repr__()[source]

Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.

Return type:: Iterable[Any | tuple[Any] | tuple[str, Any] | tuple[str, Any, Any]]

__setattr__(name, value)[source]

Implement setattr(self, name, value).

Return type:: None

__setstate__(state)[source]

Return type:: None

__signature__: ClassVar[Signature] = <Signature (*, data: kittycad.models.make_axes_gizmo.MakeAxesGizmo, type: Literal['make_axes_gizmo'] = 'make_axes_gizmo') -> None>[source]: The synthesized __init__ [Signature][inspect.Signature] of the model.

__slots__ = ('__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__')[source]

__str__()[source]

Return str(self).

Return type:: str

_abc_impl = <_abc._abc_data object>[source]

_calculate_keys(*args, **kwargs)[source]

Return type:: Any

_check_frozen(name, value)[source]

Return type:: None

_copy_and_set_values(*args, **kwargs)[source]

Return type:: Any

classmethod _get_value(*args, **kwargs)[source]

Return type:: Any

_iter(*args, **kwargs)[source]

Return type:: Any

classmethod construct(_fields_set=None, **values)[source]

Return type:: Self

copy(*, include=None, exclude=None, update=None, deep=False)[source]

Returns a copy of the model.

!!! warning “Deprecated”: This method is now deprecated; use model_copy instead.

If you need include or exclude, use:

`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `

Parameters:

include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.

Returns:

A copy of the model with included, excluded and updated fields as specified.

data: MakeAxesGizmo[source]

dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)[source]

Return type:: Dict[str, Any]

classmethod from_orm(obj)[source]

Return type:: Self

json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)[source]

Return type:: str

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}[source]: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'protected_namespaces': ()}[source]: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod model_construct(_fields_set=None, **values)[source]

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note: model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == 'allow', then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == 'ignore' (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == 'forbid' does not result in an error if extra values are passed, but they will be ignored.

Parameters:

_fields_set (set[str] | None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.
values (Any) – Trusted or pre-validated data dictionary.

Return type:

Self

Returns:

A new instance of the Model class with validated data.

model_copy(*, update=None, deep=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy

Returns a copy of the model.

Parameters:

update (dict[str, Any] | None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.
deep (bool) – Set to True to make a deep copy of the model.

Return type:

Self

Returns:

New model instance.

model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters:

mode (Union[Literal['json', 'python'], str]) – The mode in which to_python 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.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to include in the output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to exclude from the output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to use the field’s alias in the dictionary key if defined.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A dictionary representation of the model.

model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

Generates a JSON representation of the model using Pydantic’s to_json method.

Parameters:

indent (int | None) – Indentation to use in the JSON output. If None is passed, the output will be compact.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to include in the JSON output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to exclude from the JSON output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to serialize using field aliases.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A JSON string representation of the model.

property model_extra: dict[str, Any] | None[source]

Get extra fields set during validation.

Returns:: A dictionary of extra fields, or None if config.extra is not set to "allow".

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=MakeAxesGizmo, required=True), 'type': FieldInfo(annotation=Literal['make_axes_gizmo'], required=False, default='make_axes_gizmo')}[source]

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

property model_fields_set: set[str][source]

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,: i.e. that were not filled from defaults.

classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')[source]

Generates a JSON schema for a model class.

Parameters:

by_alias (bool) – Whether to use attribute aliases or not.
ref_template (str) – The reference template.
schema_generator (type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modifications
mode (Literal['validation', 'serialization']) – The mode in which to generate the schema.

Return type:

Returns:

The JSON schema for the given model class.

classmethod model_parametrized_name(params)[source]

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

Parameters:: params (tuple[type[Any], ...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.
Return type:: str
Returns:: String representing the new class where params are passed to cls as type variables.
Raises:: TypeError – Raised when trying to generate concrete names for non-generic models.

model_post_init(_BaseModel__context)[source]

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

Return type:: None

classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)[source]

Try to rebuild the pydantic-core schema for the model.

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.

Parameters:

force (bool) – Whether to force the rebuilding of the model schema, defaults to False.
raise_errors (bool) – Whether to raise errors, defaults to True.
_parent_namespace_depth (int) – The depth level of the parent namespace, defaults to 2.
_types_namespace (dict[str, Any] | None) – The types namespace, defaults to None.

Return type:

Returns:

Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.

classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)[source]

Validate a pydantic model instance.

Parameters:

obj (Any) – The object to validate.
strict (bool | None) – Whether to enforce types strictly.
from_attributes (bool | None) – Whether to extract data from object attributes.
context (Any | None) – Additional context to pass to the validator.

Raises:

ValidationError – If the object could not be validated.

Return type:

Self

Returns:

The validated model instance.

classmethod model_validate_json(json_data, *, strict=None, context=None)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing

Validate the given JSON data against the Pydantic model.

Parameters:

json_data (str | bytes | bytearray) – The JSON data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

Raises:

ValidationError – If json_data is not a JSON string or the object could not be validated.

classmethod model_validate_strings(obj, *, strict=None, context=None)[source]

Validate the given object with string data against the Pydantic model.

Parameters:

obj (Any) – The object containing string data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod parse_obj(obj)[source]

Return type:: Self

classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod schema(by_alias=True, ref_template='#/$defs/{model}')[source]

Return type:: Dict[str, Any]

classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)[source]

Return type:: str

type: Literal['make_axes_gizmo'][source]

classmethod update_forward_refs(**localns)[source]

Return type:: None

classmethod validate(value)[source]

Return type:: Self

class kittycad.models.ok_modeling_cmd_response.OptionMakePlane(**data)[source][source]

The response to the ‘MakePlane’ endpoint

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__abstractmethods__ = frozenset({})[source]

__annotations__ = {'__class_vars__': 'ClassVar[set[str]]', '__private_attributes__': 'ClassVar[Dict[str, ModelPrivateAttr]]', '__pydantic_complete__': 'ClassVar[bool]', '__pydantic_core_schema__': 'ClassVar[CoreSchema]', '__pydantic_custom_init__': 'ClassVar[bool]', '__pydantic_decorators__': 'ClassVar[_decorators.DecoratorInfos]', '__pydantic_extra__': 'dict[str, Any] | None', '__pydantic_fields_set__': 'set[str]', '__pydantic_generic_metadata__': 'ClassVar[_generics.PydanticGenericMetadata]', '__pydantic_parent_namespace__': 'ClassVar[Dict[str, Any] | None]', '__pydantic_post_init__': "ClassVar[None | Literal['model_post_init']]", '__pydantic_private__': 'dict[str, Any] | None', '__pydantic_root_model__': 'ClassVar[bool]', '__pydantic_serializer__': 'ClassVar[SchemaSerializer]', '__pydantic_validator__': 'ClassVar[SchemaValidator | PluggableSchemaValidator]', '__signature__': 'ClassVar[Signature]', 'data': <class 'kittycad.models.make_plane.MakePlane'>, 'model_computed_fields': 'ClassVar[Dict[str, ComputedFieldInfo]]', 'model_config': 'ClassVar[ConfigDict]', 'model_fields': 'ClassVar[Dict[str, FieldInfo]]', 'type': typing.Literal['make_plane']}[source]

classmethod __class_getitem__(typevar_values)[source]

Return type:: type[BaseModel] | PydanticRecursiveRef

__class_vars__: ClassVar[set[str]] = {}[source]: The names of the class variables defined on the model.

__copy__()[source]

Returns a shallow copy of the model.

Return type:: Self

__deepcopy__(memo=None)[source]

Returns a deep copy of the model.

Return type:: Self

__delattr__(item)[source]

Implement delattr(self, name).

Return type:: Any

__dict__[source]

__eq__(other)[source]

Return self==value.

Return type:: bool

property __fields_set__: set[str][source]

classmethod __get_pydantic_core_schema__(source, handler, /)[source]

Hook into generating the model’s CoreSchema.

Parameters:

source (type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.
handler (GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.

Return type:

Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]

Returns:

A pydantic-core CoreSchema.

classmethod __get_pydantic_json_schema__(core_schema, handler, /)[source]

Hook into generating the model’s JSON schema.

Parameters:

core_schema (Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({'type': 'nullable', 'schema': current_schema}), or just call the handler with the original schema.
handler (GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.

Return type:

Returns:

A JSON schema, as a Python object.

__getattr__(item)[source]

Return type:: Any

__getstate__()[source]

Helper for pickle.

Return type:: dict[Any, Any]

__hash__ = None[source]

__init__(**data)[source]

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__iter__()[source]

So dict(model) works.

Return type:: Generator[Tuple[str, Any], None, None]

__module__ = 'kittycad.models.ok_modeling_cmd_response'[source]

__pretty__(fmt, **kwargs)[source]

Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.

Return type:: Generator[Any, None, None]

__private_attributes__: ClassVar[Dict[str, ModelPrivateAttr]] = {}[source]: Metadata about the private attributes of the model.

__pydantic_complete__: ClassVar[bool] = True[source]: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__: ClassVar[CoreSchema] = {'cls': <class 'kittycad.models.ok_modeling_cmd_response.OptionMakePlane'>, 'config': {'title': 'OptionMakePlane'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.ok_modeling_cmd_response.OptionMakePlane'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.ok_modeling_cmd_response.OptionMakePlane'>>]}, 'ref': 'kittycad.models.ok_modeling_cmd_response.OptionMakePlane:94667212980912', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'data': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.make_plane.MakePlane'>, 'config': {'title': 'MakePlane'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.make_plane.MakePlane'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.make_plane.MakePlane'>>]}, 'ref': 'kittycad.models.make_plane.MakePlane:94667207363616', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {}, 'model_name': 'MakePlane', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}, 'type': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': 'make_plane', 'schema': {'expected': ['make_plane'], 'type': 'literal'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'OptionMakePlane', 'type': 'model-fields'}, 'type': 'model'}[source]: The core schema of the model.

__pydantic_custom_init__: ClassVar[bool] = False[source]: Whether the model has a custom __init__ method.

__pydantic_decorators__: ClassVar[_decorators.DecoratorInfos] = DecoratorInfos(validators={}, field_validators={}, root_validators={}, field_serializers={}, model_serializers={}, model_validators={}, computed_fields={})[source]: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_extra__: dict[str, Any] | None[source]: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to 'allow'.

__pydantic_fields_set__: set[str][source]: The names of fields explicitly set during instantiation.

__pydantic_generic_metadata__: ClassVar[_generics.PydanticGenericMetadata] = {'args': (), 'origin': None, 'parameters': ()}[source]: 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.

classmethod __pydantic_init_subclass__(**kwargs)[source]

This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.

This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.

This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.

Parameters:: **kwargs (Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.
Return type:: None

__pydantic_parent_namespace__: ClassVar[Dict[str, Any] | None] = None[source]: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__: ClassVar[None | Literal['model_post_init']] = None[source]: The name of the post-init method for the model, if defined.

__pydantic_private__: dict[str, Any] | None[source]: Values of private attributes set on the model instance.

__pydantic_root_model__: ClassVar[bool] = False[source]: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__: ClassVar[SchemaSerializer] = SchemaSerializer(serializer=Model( ModelSerializer { class: Py( 0x000056196d9a02b0, ), serializer: Fields( GeneralFieldsSerializer { fields: { "type": SerField { key_py: Py( 0x00007f903823d958, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f90347f5f70, ), ), serializer: Literal( LiteralSerializer { expected_int: {}, expected_str: { "make_plane", }, expected_py: None, name: "literal['make_plane']", }, ), }, ), ), required: true, }, "data": SerField { key_py: Py( 0x00007f9038238fa0, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196d444c20, ), serializer: Fields( GeneralFieldsSerializer { fields: {}, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 0, }, ), has_extra: false, root_model: false, name: "MakePlane", }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "OptionMakePlane", }, ), definitions=[])[source]: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__: ClassVar[SchemaValidator | PluggableSchemaValidator] = SchemaValidator(title="OptionMakePlane", validator=Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "data", lookup_key: Simple { key: "data", py_key: Py( 0x00007f90334d4ae0, ), path: LookupPath( [ S( "data", Py( 0x00007f90334d4ab0, ), ), ], ), }, name_py: Py( 0x00007f9038238fa0, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [], model_name: "MakePlane", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d444c20, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "MakePlane", }, ), frozen: false, }, Field { name: "type", lookup_key: Simple { key: "type", py_key: Py( 0x00007f90334d4a20, ), path: LookupPath( [ S( "type", Py( 0x00007f90334d48d0, ), ), ], ), }, name_py: Py( 0x00007f903823d958, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f90347f5f70, ), ), on_error: Raise, validator: Literal( LiteralValidator { lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "make_plane": 0, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f90347f5f70, ), ], }, expected_repr: "'make_plane'", name: "literal['make_plane']", }, ), validate_default: false, copy_default: false, name: "default[literal['make_plane']]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "OptionMakePlane", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d9a02b0, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "OptionMakePlane", }, ), definitions=[], cache_strings=True)[source]: The pydantic-core SchemaValidator used to validate instances of the model.

__repr__()[source]

Return repr(self).

Return type:: str

__repr_args__()[source]

Return type:: Iterable[tuple[str | None, Any]]

__repr_name__()[source]

Name of the instance’s class, used in __repr__.

Return type:: str

__repr_str__(join_str)[source]

Return type:: str

__rich_repr__()[source]

Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.

Return type:: Iterable[Any | tuple[Any] | tuple[str, Any] | tuple[str, Any, Any]]

__setattr__(name, value)[source]

Implement setattr(self, name, value).

Return type:: None

__setstate__(state)[source]

Return type:: None

__signature__: ClassVar[Signature] = <Signature (*, data: kittycad.models.make_plane.MakePlane, type: Literal['make_plane'] = 'make_plane') -> None>[source]: The synthesized __init__ [Signature][inspect.Signature] of the model.

__slots__ = ('__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__')[source]

__str__()[source]

Return str(self).

Return type:: str

_abc_impl = <_abc._abc_data object>[source]

_calculate_keys(*args, **kwargs)[source]

Return type:: Any

_check_frozen(name, value)[source]

Return type:: None

_copy_and_set_values(*args, **kwargs)[source]

Return type:: Any

classmethod _get_value(*args, **kwargs)[source]

Return type:: Any

_iter(*args, **kwargs)[source]

Return type:: Any

classmethod construct(_fields_set=None, **values)[source]

Return type:: Self

copy(*, include=None, exclude=None, update=None, deep=False)[source]

Returns a copy of the model.

!!! warning “Deprecated”: This method is now deprecated; use model_copy instead.

If you need include or exclude, use:

`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `

Parameters:

include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.

Returns:

A copy of the model with included, excluded and updated fields as specified.

data: MakePlane[source]

dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)[source]

Return type:: Dict[str, Any]

classmethod from_orm(obj)[source]

Return type:: Self

json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)[source]

Return type:: str

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}[source]: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'protected_namespaces': ()}[source]: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod model_construct(_fields_set=None, **values)[source]

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note: model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == 'allow', then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == 'ignore' (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == 'forbid' does not result in an error if extra values are passed, but they will be ignored.

Parameters:

_fields_set (set[str] | None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.
values (Any) – Trusted or pre-validated data dictionary.

Return type:

Self

Returns:

A new instance of the Model class with validated data.

model_copy(*, update=None, deep=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy

Returns a copy of the model.

Parameters:

update (dict[str, Any] | None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.
deep (bool) – Set to True to make a deep copy of the model.

Return type:

Self

Returns:

New model instance.

model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters:

mode (Union[Literal['json', 'python'], str]) – The mode in which to_python 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.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to include in the output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to exclude from the output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to use the field’s alias in the dictionary key if defined.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A dictionary representation of the model.

model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

Generates a JSON representation of the model using Pydantic’s to_json method.

Parameters:

indent (int | None) – Indentation to use in the JSON output. If None is passed, the output will be compact.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to include in the JSON output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to exclude from the JSON output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to serialize using field aliases.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A JSON string representation of the model.

property model_extra: dict[str, Any] | None[source]

Get extra fields set during validation.

Returns:: A dictionary of extra fields, or None if config.extra is not set to "allow".

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=MakePlane, required=True), 'type': FieldInfo(annotation=Literal['make_plane'], required=False, default='make_plane')}[source]

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

property model_fields_set: set[str][source]

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,: i.e. that were not filled from defaults.

classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')[source]

Generates a JSON schema for a model class.

Parameters:

by_alias (bool) – Whether to use attribute aliases or not.
ref_template (str) – The reference template.
schema_generator (type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modifications
mode (Literal['validation', 'serialization']) – The mode in which to generate the schema.

Return type:

Returns:

The JSON schema for the given model class.

classmethod model_parametrized_name(params)[source]

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

Parameters:: params (tuple[type[Any], ...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.
Return type:: str
Returns:: String representing the new class where params are passed to cls as type variables.
Raises:: TypeError – Raised when trying to generate concrete names for non-generic models.

model_post_init(_BaseModel__context)[source]

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

Return type:: None

classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)[source]

Try to rebuild the pydantic-core schema for the model.

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.

Parameters:

force (bool) – Whether to force the rebuilding of the model schema, defaults to False.
raise_errors (bool) – Whether to raise errors, defaults to True.
_parent_namespace_depth (int) – The depth level of the parent namespace, defaults to 2.
_types_namespace (dict[str, Any] | None) – The types namespace, defaults to None.

Return type:

Returns:

Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.

classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)[source]

Validate a pydantic model instance.

Parameters:

obj (Any) – The object to validate.
strict (bool | None) – Whether to enforce types strictly.
from_attributes (bool | None) – Whether to extract data from object attributes.
context (Any | None) – Additional context to pass to the validator.

Raises:

ValidationError – If the object could not be validated.

Return type:

Self

Returns:

The validated model instance.

classmethod model_validate_json(json_data, *, strict=None, context=None)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing

Validate the given JSON data against the Pydantic model.

Parameters:

json_data (str | bytes | bytearray) – The JSON data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

Raises:

ValidationError – If json_data is not a JSON string or the object could not be validated.

classmethod model_validate_strings(obj, *, strict=None, context=None)[source]

Validate the given object with string data against the Pydantic model.

Parameters:

obj (Any) – The object containing string data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod parse_obj(obj)[source]

Return type:: Self

classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod schema(by_alias=True, ref_template='#/$defs/{model}')[source]

Return type:: Dict[str, Any]

classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)[source]

Return type:: str

type: Literal['make_plane'][source]

classmethod update_forward_refs(**localns)[source]

Return type:: None

classmethod validate(value)[source]

Return type:: Self

class kittycad.models.ok_modeling_cmd_response.OptionMass(**data)[source][source]

The response to the ‘Mass’ endpoint

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__abstractmethods__ = frozenset({})[source]

__annotations__ = {'__class_vars__': 'ClassVar[set[str]]', '__private_attributes__': 'ClassVar[Dict[str, ModelPrivateAttr]]', '__pydantic_complete__': 'ClassVar[bool]', '__pydantic_core_schema__': 'ClassVar[CoreSchema]', '__pydantic_custom_init__': 'ClassVar[bool]', '__pydantic_decorators__': 'ClassVar[_decorators.DecoratorInfos]', '__pydantic_extra__': 'dict[str, Any] | None', '__pydantic_fields_set__': 'set[str]', '__pydantic_generic_metadata__': 'ClassVar[_generics.PydanticGenericMetadata]', '__pydantic_parent_namespace__': 'ClassVar[Dict[str, Any] | None]', '__pydantic_post_init__': "ClassVar[None | Literal['model_post_init']]", '__pydantic_private__': 'dict[str, Any] | None', '__pydantic_root_model__': 'ClassVar[bool]', '__pydantic_serializer__': 'ClassVar[SchemaSerializer]', '__pydantic_validator__': 'ClassVar[SchemaValidator | PluggableSchemaValidator]', '__signature__': 'ClassVar[Signature]', 'data': <class 'kittycad.models.mass.Mass'>, 'model_computed_fields': 'ClassVar[Dict[str, ComputedFieldInfo]]', 'model_config': 'ClassVar[ConfigDict]', 'model_fields': 'ClassVar[Dict[str, FieldInfo]]', 'type': typing.Literal['mass']}[source]

classmethod __class_getitem__(typevar_values)[source]

Return type:: type[BaseModel] | PydanticRecursiveRef

__class_vars__: ClassVar[set[str]] = {}[source]: The names of the class variables defined on the model.

__copy__()[source]

Returns a shallow copy of the model.

Return type:: Self

__deepcopy__(memo=None)[source]

Returns a deep copy of the model.

Return type:: Self

__delattr__(item)[source]

Implement delattr(self, name).

Return type:: Any

__dict__[source]

__eq__(other)[source]

Return self==value.

Return type:: bool

property __fields_set__: set[str][source]

classmethod __get_pydantic_core_schema__(source, handler, /)[source]

Hook into generating the model’s CoreSchema.

Parameters:

source (type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.
handler (GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.

Return type:

Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]

Returns:

A pydantic-core CoreSchema.

classmethod __get_pydantic_json_schema__(core_schema, handler, /)[source]

Hook into generating the model’s JSON schema.

Parameters:

core_schema (Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({'type': 'nullable', 'schema': current_schema}), or just call the handler with the original schema.
handler (GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.

Return type:

Returns:

A JSON schema, as a Python object.

__getattr__(item)[source]

Return type:: Any

__getstate__()[source]

Helper for pickle.

Return type:: dict[Any, Any]

__hash__ = None[source]

__init__(**data)[source]

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__iter__()[source]

So dict(model) works.

Return type:: Generator[Tuple[str, Any], None, None]

__module__ = 'kittycad.models.ok_modeling_cmd_response'[source]

__pretty__(fmt, **kwargs)[source]

Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.

Return type:: Generator[Any, None, None]

__private_attributes__: ClassVar[Dict[str, ModelPrivateAttr]] = {}[source]: Metadata about the private attributes of the model.

__pydantic_complete__: ClassVar[bool] = True[source]: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__: ClassVar[CoreSchema] = {'cls': <class 'kittycad.models.ok_modeling_cmd_response.OptionMass'>, 'config': {'title': 'OptionMass'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.ok_modeling_cmd_response.OptionMass'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.ok_modeling_cmd_response.OptionMass'>>]}, 'ref': 'kittycad.models.ok_modeling_cmd_response.OptionMass:94667213946656', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'data': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.mass.Mass'>, 'config': {'title': 'Mass'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.mass.Mass'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.mass.Mass'>>]}, 'ref': 'kittycad.models.mass.Mass:94667207350496', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'mass': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'type': 'float'}, 'type': 'model-field'}, 'output_unit': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <enum 'UnitMass'>, 'members': [UnitMass.G, UnitMass.KG, UnitMass.LB], 'metadata': {'pydantic_js_functions': [<function GenerateSchema._enum_schema.<locals>.get_json_schema>]}, 'ref': 'kittycad.models.unit_mass.UnitMass:94667203584688', 'sub_type': 'str', 'type': 'enum'}, 'type': 'model-field'}}, 'model_name': 'Mass', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}, 'type': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': 'mass', 'schema': {'expected': ['mass'], 'type': 'literal'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'OptionMass', 'type': 'model-fields'}, 'type': 'model'}[source]: The core schema of the model.

__pydantic_custom_init__: ClassVar[bool] = False[source]: Whether the model has a custom __init__ method.

__pydantic_decorators__: ClassVar[_decorators.DecoratorInfos] = DecoratorInfos(validators={}, field_validators={}, root_validators={}, field_serializers={}, model_serializers={}, model_validators={}, computed_fields={})[source]: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_extra__: dict[str, Any] | None[source]: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to 'allow'.

__pydantic_fields_set__: set[str][source]: The names of fields explicitly set during instantiation.

__pydantic_generic_metadata__: ClassVar[_generics.PydanticGenericMetadata] = {'args': (), 'origin': None, 'parameters': ()}[source]: 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.

classmethod __pydantic_init_subclass__(**kwargs)[source]

This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.

This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.

This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.

Parameters:: **kwargs (Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.
Return type:: None

__pydantic_parent_namespace__: ClassVar[Dict[str, Any] | None] = None[source]: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__: ClassVar[None | Literal['model_post_init']] = None[source]: The name of the post-init method for the model, if defined.

__pydantic_private__: dict[str, Any] | None[source]: Values of private attributes set on the model instance.

__pydantic_root_model__: ClassVar[bool] = False[source]: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__: ClassVar[SchemaSerializer] = SchemaSerializer(serializer=Model( ModelSerializer { class: Py( 0x000056196da8bf20, ), serializer: Fields( GeneralFieldsSerializer { fields: { "type": SerField { key_py: Py( 0x00007f903823d958, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f9034acf4e0, ), ), serializer: Literal( LiteralSerializer { expected_int: {}, expected_str: { "mass", }, expected_py: None, name: "literal['mass']", }, ), }, ), ), required: true, }, "data": SerField { key_py: Py( 0x00007f9038238fa0, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196d4418e0, ), serializer: Fields( GeneralFieldsSerializer { fields: { "mass": SerField { key_py: Py( 0x00007f9034acf4e0, ), alias: None, alias_py: None, serializer: Some( Float( FloatSerializer { inf_nan_mode: Null, }, ), ), required: true, }, "output_unit": SerField { key_py: Py( 0x00007f903459f8b0, ), alias: None, alias_py: None, serializer: Some( Enum( EnumSerializer { class: Py( 0x000056196d0aa2b0, ), serializer: Some( Str( StrSerializer, ), ), }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "Mass", }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "OptionMass", }, ), definitions=[])[source]: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__: ClassVar[SchemaValidator | PluggableSchemaValidator] = SchemaValidator(title="OptionMass", validator=Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "data", lookup_key: Simple { key: "data", py_key: Py( 0x00007f90333a9830, ), path: LookupPath( [ S( "data", Py( 0x00007f90333a93b0, ), ), ], ), }, name_py: Py( 0x00007f9038238fa0, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "mass", lookup_key: Simple { key: "mass", py_key: Py( 0x00007f90333a9800, ), path: LookupPath( [ S( "mass", Py( 0x00007f90333a97d0, ), ), ], ), }, name_py: Py( 0x00007f9034acf4e0, ), validator: Float( FloatValidator { strict: false, allow_inf_nan: true, }, ), frozen: false, }, Field { name: "output_unit", lookup_key: Simple { key: "output_unit", py_key: Py( 0x00007f90333b72b0, ), path: LookupPath( [ S( "output_unit", Py( 0x00007f90333b72f0, ), ), ], ), }, name_py: Py( 0x00007f903459f8b0, ), validator: StrEnum( EnumValidator { phantom: PhantomData<_pydantic_core::validators::enum_::StrEnumValidator>, class: Py( 0x000056196d0aa2b0, ), lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "g": 0, "kg": 1, "lb": 2, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f9033caba10, ), Py( 0x00007f9033caba70, ), Py( 0x00007f9033cabad0, ), ], }, missing: None, expected_repr: "'g', 'kg' or 'lb'", strict: false, class_repr: "UnitMass", name: "str-enum[UnitMass]", }, ), frozen: false, }, ], model_name: "Mass", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d4418e0, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "Mass", }, ), frozen: false, }, Field { name: "type", lookup_key: Simple { key: "type", py_key: Py( 0x00007f90333a9440, ), path: LookupPath( [ S( "type", Py( 0x00007f90333a92f0, ), ), ], ), }, name_py: Py( 0x00007f903823d958, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f9034acf4e0, ), ), on_error: Raise, validator: Literal( LiteralValidator { lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "mass": 0, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f9034acf4e0, ), ], }, expected_repr: "'mass'", name: "literal['mass']", }, ), validate_default: false, copy_default: false, name: "default[literal['mass']]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "OptionMass", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196da8bf20, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "OptionMass", }, ), definitions=[], cache_strings=True)[source]: The pydantic-core SchemaValidator used to validate instances of the model.

__repr__()[source]

Return repr(self).

Return type:: str

__repr_args__()[source]

Return type:: Iterable[tuple[str | None, Any]]

__repr_name__()[source]

Name of the instance’s class, used in __repr__.

Return type:: str

__repr_str__(join_str)[source]

Return type:: str

__rich_repr__()[source]

Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.

Return type:: Iterable[Any | tuple[Any] | tuple[str, Any] | tuple[str, Any, Any]]

__setattr__(name, value)[source]

Implement setattr(self, name, value).

Return type:: None

__setstate__(state)[source]

Return type:: None

__signature__: ClassVar[Signature] = <Signature (*, data: kittycad.models.mass.Mass, type: Literal['mass'] = 'mass') -> None>[source]: The synthesized __init__ [Signature][inspect.Signature] of the model.

__slots__ = ('__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__')[source]

__str__()[source]

Return str(self).

Return type:: str

_abc_impl = <_abc._abc_data object>[source]

_calculate_keys(*args, **kwargs)[source]

Return type:: Any

_check_frozen(name, value)[source]

Return type:: None

_copy_and_set_values(*args, **kwargs)[source]

Return type:: Any

classmethod _get_value(*args, **kwargs)[source]

Return type:: Any

_iter(*args, **kwargs)[source]

Return type:: Any

classmethod construct(_fields_set=None, **values)[source]

Return type:: Self

copy(*, include=None, exclude=None, update=None, deep=False)[source]

Returns a copy of the model.

!!! warning “Deprecated”: This method is now deprecated; use model_copy instead.

If you need include or exclude, use:

`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `

Parameters:

include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.

Returns:

A copy of the model with included, excluded and updated fields as specified.

data: Mass[source]

dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)[source]

Return type:: Dict[str, Any]

classmethod from_orm(obj)[source]

Return type:: Self

json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)[source]

Return type:: str

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}[source]: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'protected_namespaces': ()}[source]: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod model_construct(_fields_set=None, **values)[source]

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note: model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == 'allow', then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == 'ignore' (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == 'forbid' does not result in an error if extra values are passed, but they will be ignored.

Parameters:

_fields_set (set[str] | None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.
values (Any) – Trusted or pre-validated data dictionary.

Return type:

Self

Returns:

A new instance of the Model class with validated data.

model_copy(*, update=None, deep=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy

Returns a copy of the model.

Parameters:

update (dict[str, Any] | None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.
deep (bool) – Set to True to make a deep copy of the model.

Return type:

Self

Returns:

New model instance.

model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters:

mode (Union[Literal['json', 'python'], str]) – The mode in which to_python 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.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to include in the output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to exclude from the output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to use the field’s alias in the dictionary key if defined.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A dictionary representation of the model.

model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

Generates a JSON representation of the model using Pydantic’s to_json method.

Parameters:

indent (int | None) – Indentation to use in the JSON output. If None is passed, the output will be compact.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to include in the JSON output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to exclude from the JSON output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to serialize using field aliases.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A JSON string representation of the model.

property model_extra: dict[str, Any] | None[source]

Get extra fields set during validation.

Returns:: A dictionary of extra fields, or None if config.extra is not set to "allow".

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=Mass, required=True), 'type': FieldInfo(annotation=Literal['mass'], required=False, default='mass')}[source]

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

property model_fields_set: set[str][source]

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,: i.e. that were not filled from defaults.

classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')[source]

Generates a JSON schema for a model class.

Parameters:

by_alias (bool) – Whether to use attribute aliases or not.
ref_template (str) – The reference template.
schema_generator (type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modifications
mode (Literal['validation', 'serialization']) – The mode in which to generate the schema.

Return type:

Returns:

The JSON schema for the given model class.

classmethod model_parametrized_name(params)[source]

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

Parameters:: params (tuple[type[Any], ...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.
Return type:: str
Returns:: String representing the new class where params are passed to cls as type variables.
Raises:: TypeError – Raised when trying to generate concrete names for non-generic models.

model_post_init(_BaseModel__context)[source]

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

Return type:: None

classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)[source]

Try to rebuild the pydantic-core schema for the model.

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.

Parameters:

force (bool) – Whether to force the rebuilding of the model schema, defaults to False.
raise_errors (bool) – Whether to raise errors, defaults to True.
_parent_namespace_depth (int) – The depth level of the parent namespace, defaults to 2.
_types_namespace (dict[str, Any] | None) – The types namespace, defaults to None.

Return type:

Returns:

Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.

classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)[source]

Validate a pydantic model instance.

Parameters:

obj (Any) – The object to validate.
strict (bool | None) – Whether to enforce types strictly.
from_attributes (bool | None) – Whether to extract data from object attributes.
context (Any | None) – Additional context to pass to the validator.

Raises:

ValidationError – If the object could not be validated.

Return type:

Self

Returns:

The validated model instance.

classmethod model_validate_json(json_data, *, strict=None, context=None)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing

Validate the given JSON data against the Pydantic model.

Parameters:

json_data (str | bytes | bytearray) – The JSON data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

Raises:

ValidationError – If json_data is not a JSON string or the object could not be validated.

classmethod model_validate_strings(obj, *, strict=None, context=None)[source]

Validate the given object with string data against the Pydantic model.

Parameters:

obj (Any) – The object containing string data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod parse_obj(obj)[source]

Return type:: Self

classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod schema(by_alias=True, ref_template='#/$defs/{model}')[source]

Return type:: Dict[str, Any]

classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)[source]

Return type:: str

type: Literal['mass'][source]

classmethod update_forward_refs(**localns)[source]

Return type:: None

classmethod validate(value)[source]

Return type:: Self

class kittycad.models.ok_modeling_cmd_response.OptionMouseClick(**data)[source][source]

The response to the ‘MouseClick’ endpoint

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__abstractmethods__ = frozenset({})[source]

__annotations__ = {'__class_vars__': 'ClassVar[set[str]]', '__private_attributes__': 'ClassVar[Dict[str, ModelPrivateAttr]]', '__pydantic_complete__': 'ClassVar[bool]', '__pydantic_core_schema__': 'ClassVar[CoreSchema]', '__pydantic_custom_init__': 'ClassVar[bool]', '__pydantic_decorators__': 'ClassVar[_decorators.DecoratorInfos]', '__pydantic_extra__': 'dict[str, Any] | None', '__pydantic_fields_set__': 'set[str]', '__pydantic_generic_metadata__': 'ClassVar[_generics.PydanticGenericMetadata]', '__pydantic_parent_namespace__': 'ClassVar[Dict[str, Any] | None]', '__pydantic_post_init__': "ClassVar[None | Literal['model_post_init']]", '__pydantic_private__': 'dict[str, Any] | None', '__pydantic_root_model__': 'ClassVar[bool]', '__pydantic_serializer__': 'ClassVar[SchemaSerializer]', '__pydantic_validator__': 'ClassVar[SchemaValidator | PluggableSchemaValidator]', '__signature__': 'ClassVar[Signature]', 'data': <class 'kittycad.models.mouse_click.MouseClick'>, 'model_computed_fields': 'ClassVar[Dict[str, ComputedFieldInfo]]', 'model_config': 'ClassVar[ConfigDict]', 'model_fields': 'ClassVar[Dict[str, FieldInfo]]', 'type': typing.Literal['mouse_click']}[source]

classmethod __class_getitem__(typevar_values)[source]

Return type:: type[BaseModel] | PydanticRecursiveRef

__class_vars__: ClassVar[set[str]] = {}[source]: The names of the class variables defined on the model.

__copy__()[source]

Returns a shallow copy of the model.

Return type:: Self

__deepcopy__(memo=None)[source]

Returns a deep copy of the model.

Return type:: Self

__delattr__(item)[source]

Implement delattr(self, name).

Return type:: Any

__dict__[source]

__eq__(other)[source]

Return self==value.

Return type:: bool

property __fields_set__: set[str][source]

classmethod __get_pydantic_core_schema__(source, handler, /)[source]

Hook into generating the model’s CoreSchema.

Parameters:

source (type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.
handler (GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.

Return type:

Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]

Returns:

A pydantic-core CoreSchema.

classmethod __get_pydantic_json_schema__(core_schema, handler, /)[source]

Hook into generating the model’s JSON schema.

Parameters:

core_schema (Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({'type': 'nullable', 'schema': current_schema}), or just call the handler with the original schema.
handler (GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.

Return type:

Returns:

A JSON schema, as a Python object.

__getattr__(item)[source]

Return type:: Any

__getstate__()[source]

Helper for pickle.

Return type:: dict[Any, Any]

__hash__ = None[source]

__init__(**data)[source]

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__iter__()[source]

So dict(model) works.

Return type:: Generator[Tuple[str, Any], None, None]

__module__ = 'kittycad.models.ok_modeling_cmd_response'[source]

__pretty__(fmt, **kwargs)[source]

Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.

Return type:: Generator[Any, None, None]

__private_attributes__: ClassVar[Dict[str, ModelPrivateAttr]] = {}[source]: Metadata about the private attributes of the model.

__pydantic_complete__: ClassVar[bool] = True[source]: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__: ClassVar[CoreSchema] = {'cls': <class 'kittycad.models.ok_modeling_cmd_response.OptionMouseClick'>, 'config': {'title': 'OptionMouseClick'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.ok_modeling_cmd_response.OptionMouseClick'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.ok_modeling_cmd_response.OptionMouseClick'>>]}, 'ref': 'kittycad.models.ok_modeling_cmd_response.OptionMouseClick:94667213693232', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'data': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.mouse_click.MouseClick'>, 'config': {'title': 'MouseClick'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.mouse_click.MouseClick'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.mouse_click.MouseClick'>>]}, 'ref': 'kittycad.models.mouse_click.MouseClick:94667211177056', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'entities_modified': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'items_schema': {'type': 'str'}, 'type': 'list'}, 'type': 'model-field'}, 'entities_selected': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'items_schema': {'type': 'str'}, 'type': 'list'}, 'type': 'model-field'}}, 'model_name': 'MouseClick', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}, 'type': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': 'mouse_click', 'schema': {'expected': ['mouse_click'], 'type': 'literal'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'OptionMouseClick', 'type': 'model-fields'}, 'type': 'model'}[source]: The core schema of the model.

__pydantic_custom_init__: ClassVar[bool] = False[source]: Whether the model has a custom __init__ method.

__pydantic_decorators__: ClassVar[_decorators.DecoratorInfos] = DecoratorInfos(validators={}, field_validators={}, root_validators={}, field_serializers={}, model_serializers={}, model_validators={}, computed_fields={})[source]: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_extra__: dict[str, Any] | None[source]: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to 'allow'.

__pydantic_fields_set__: set[str][source]: The names of fields explicitly set during instantiation.

__pydantic_generic_metadata__: ClassVar[_generics.PydanticGenericMetadata] = {'args': (), 'origin': None, 'parameters': ()}[source]: 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.

classmethod __pydantic_init_subclass__(**kwargs)[source]

This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.

This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.

This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.

Parameters:: **kwargs (Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.
Return type:: None

__pydantic_parent_namespace__: ClassVar[Dict[str, Any] | None] = None[source]: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__: ClassVar[None | Literal['model_post_init']] = None[source]: The name of the post-init method for the model, if defined.

__pydantic_private__: dict[str, Any] | None[source]: Values of private attributes set on the model instance.

__pydantic_root_model__: ClassVar[bool] = False[source]: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__: ClassVar[SchemaSerializer] = SchemaSerializer(serializer=Model( ModelSerializer { class: Py( 0x000056196da4e130, ), serializer: Fields( GeneralFieldsSerializer { fields: { "type": SerField { key_py: Py( 0x00007f903823d958, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f90346e3970, ), ), serializer: Literal( LiteralSerializer { expected_int: {}, expected_str: { "mouse_click", }, expected_py: None, name: "literal['mouse_click']", }, ), }, ), ), required: true, }, "data": SerField { key_py: Py( 0x00007f9038238fa0, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196d7e7c60, ), serializer: Fields( GeneralFieldsSerializer { fields: { "entities_selected": SerField { key_py: Py( 0x00007f90337149b0, ), alias: None, alias_py: None, serializer: Some( List( ListSerializer { item_serializer: Str( StrSerializer, ), filter: SchemaFilter { include: None, exclude: None, }, name: "list[str]", }, ), ), required: true, }, "entities_modified": SerField { key_py: Py( 0x00007f9033714bf0, ), alias: None, alias_py: None, serializer: Some( List( ListSerializer { item_serializer: Str( StrSerializer, ), filter: SchemaFilter { include: None, exclude: None, }, name: "list[str]", }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "MouseClick", }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "OptionMouseClick", }, ), definitions=[])[source]: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__: ClassVar[SchemaValidator | PluggableSchemaValidator] = SchemaValidator(title="OptionMouseClick", validator=Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "data", lookup_key: Simple { key: "data", py_key: Py( 0x00007f903336c810, ), path: LookupPath( [ S( "data", Py( 0x00007f903336c3c0, ), ), ], ), }, name_py: Py( 0x00007f9038238fa0, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "entities_modified", lookup_key: Simple { key: "entities_modified", py_key: Py( 0x00007f9033392cb0, ), path: LookupPath( [ S( "entities_modified", Py( 0x00007f9033392c70, ), ), ], ), }, name_py: Py( 0x00007f9033714bf0, ), validator: List( ListValidator { strict: false, item_validator: Some( Str( StrValidator { strict: false, coerce_numbers_to_str: false, }, ), ), min_length: None, max_length: None, name: OnceLock( <uninit>, ), fail_fast: false, }, ), frozen: false, }, Field { name: "entities_selected", lookup_key: Simple { key: "entities_selected", py_key: Py( 0x00007f9033392d30, ), path: LookupPath( [ S( "entities_selected", Py( 0x00007f9033392cf0, ), ), ], ), }, name_py: Py( 0x00007f90337149b0, ), validator: List( ListValidator { strict: false, item_validator: Some( Str( StrValidator { strict: false, coerce_numbers_to_str: false, }, ), ), min_length: None, max_length: None, name: OnceLock( <uninit>, ), fail_fast: false, }, ), frozen: false, }, ], model_name: "MouseClick", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d7e7c60, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "MouseClick", }, ), frozen: false, }, Field { name: "type", lookup_key: Simple { key: "type", py_key: Py( 0x00007f903336cae0, ), path: LookupPath( [ S( "type", Py( 0x00007f903336d020, ), ), ], ), }, name_py: Py( 0x00007f903823d958, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f90346e3970, ), ), on_error: Raise, validator: Literal( LiteralValidator { lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "mouse_click": 0, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f90346e3970, ), ], }, expected_repr: "'mouse_click'", name: "literal['mouse_click']", }, ), validate_default: false, copy_default: false, name: "default[literal['mouse_click']]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "OptionMouseClick", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196da4e130, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "OptionMouseClick", }, ), definitions=[], cache_strings=True)[source]: The pydantic-core SchemaValidator used to validate instances of the model.

__repr__()[source]

Return repr(self).

Return type:: str

__repr_args__()[source]

Return type:: Iterable[tuple[str | None, Any]]

__repr_name__()[source]

Name of the instance’s class, used in __repr__.

Return type:: str

__repr_str__(join_str)[source]

Return type:: str

__rich_repr__()[source]

Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.

Return type:: Iterable[Any | tuple[Any] | tuple[str, Any] | tuple[str, Any, Any]]

__setattr__(name, value)[source]

Implement setattr(self, name, value).

Return type:: None

__setstate__(state)[source]

Return type:: None

__signature__: ClassVar[Signature] = <Signature (*, data: kittycad.models.mouse_click.MouseClick, type: Literal['mouse_click'] = 'mouse_click') -> None>[source]: The synthesized __init__ [Signature][inspect.Signature] of the model.

__slots__ = ('__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__')[source]

__str__()[source]

Return str(self).

Return type:: str

_abc_impl = <_abc._abc_data object>[source]

_calculate_keys(*args, **kwargs)[source]

Return type:: Any

_check_frozen(name, value)[source]

Return type:: None

_copy_and_set_values(*args, **kwargs)[source]

Return type:: Any

classmethod _get_value(*args, **kwargs)[source]

Return type:: Any

_iter(*args, **kwargs)[source]

Return type:: Any

classmethod construct(_fields_set=None, **values)[source]

Return type:: Self

copy(*, include=None, exclude=None, update=None, deep=False)[source]

Returns a copy of the model.

!!! warning “Deprecated”: This method is now deprecated; use model_copy instead.

If you need include or exclude, use:

`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `

Parameters:

include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.

Returns:

A copy of the model with included, excluded and updated fields as specified.

data: MouseClick[source]

dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)[source]

Return type:: Dict[str, Any]

classmethod from_orm(obj)[source]

Return type:: Self

json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)[source]

Return type:: str

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}[source]: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'protected_namespaces': ()}[source]: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod model_construct(_fields_set=None, **values)[source]

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note: model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == 'allow', then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == 'ignore' (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == 'forbid' does not result in an error if extra values are passed, but they will be ignored.

Parameters:

_fields_set (set[str] | None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.
values (Any) – Trusted or pre-validated data dictionary.

Return type:

Self

Returns:

A new instance of the Model class with validated data.

model_copy(*, update=None, deep=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy

Returns a copy of the model.

Parameters:

update (dict[str, Any] | None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.
deep (bool) – Set to True to make a deep copy of the model.

Return type:

Self

Returns:

New model instance.

model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters:

mode (Union[Literal['json', 'python'], str]) – The mode in which to_python 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.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to include in the output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to exclude from the output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to use the field’s alias in the dictionary key if defined.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A dictionary representation of the model.

model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

Generates a JSON representation of the model using Pydantic’s to_json method.

Parameters:

indent (int | None) – Indentation to use in the JSON output. If None is passed, the output will be compact.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to include in the JSON output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to exclude from the JSON output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to serialize using field aliases.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A JSON string representation of the model.

property model_extra: dict[str, Any] | None[source]

Get extra fields set during validation.

Returns:: A dictionary of extra fields, or None if config.extra is not set to "allow".

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=MouseClick, required=True), 'type': FieldInfo(annotation=Literal['mouse_click'], required=False, default='mouse_click')}[source]

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

property model_fields_set: set[str][source]

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,: i.e. that were not filled from defaults.

classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')[source]

Generates a JSON schema for a model class.

Parameters:

by_alias (bool) – Whether to use attribute aliases or not.
ref_template (str) – The reference template.
schema_generator (type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modifications
mode (Literal['validation', 'serialization']) – The mode in which to generate the schema.

Return type:

Returns:

The JSON schema for the given model class.

classmethod model_parametrized_name(params)[source]

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

Parameters:: params (tuple[type[Any], ...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.
Return type:: str
Returns:: String representing the new class where params are passed to cls as type variables.
Raises:: TypeError – Raised when trying to generate concrete names for non-generic models.

model_post_init(_BaseModel__context)[source]

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

Return type:: None

classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)[source]

Try to rebuild the pydantic-core schema for the model.

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.

Parameters:

force (bool) – Whether to force the rebuilding of the model schema, defaults to False.
raise_errors (bool) – Whether to raise errors, defaults to True.
_parent_namespace_depth (int) – The depth level of the parent namespace, defaults to 2.
_types_namespace (dict[str, Any] | None) – The types namespace, defaults to None.

Return type:

Returns:

Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.

classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)[source]

Validate a pydantic model instance.

Parameters:

obj (Any) – The object to validate.
strict (bool | None) – Whether to enforce types strictly.
from_attributes (bool | None) – Whether to extract data from object attributes.
context (Any | None) – Additional context to pass to the validator.

Raises:

ValidationError – If the object could not be validated.

Return type:

Self

Returns:

The validated model instance.

classmethod model_validate_json(json_data, *, strict=None, context=None)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing

Validate the given JSON data against the Pydantic model.

Parameters:

json_data (str | bytes | bytearray) – The JSON data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

Raises:

ValidationError – If json_data is not a JSON string or the object could not be validated.

classmethod model_validate_strings(obj, *, strict=None, context=None)[source]

Validate the given object with string data against the Pydantic model.

Parameters:

obj (Any) – The object containing string data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod parse_obj(obj)[source]

Return type:: Self

classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod schema(by_alias=True, ref_template='#/$defs/{model}')[source]

Return type:: Dict[str, Any]

classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)[source]

Return type:: str

type: Literal['mouse_click'][source]

classmethod update_forward_refs(**localns)[source]

Return type:: None

classmethod validate(value)[source]

Return type:: Self

class kittycad.models.ok_modeling_cmd_response.OptionMouseMove(**data)[source][source]

The response to the ‘MouseMove’ endpoint

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__abstractmethods__ = frozenset({})[source]

__annotations__ = {'__class_vars__': 'ClassVar[set[str]]', '__private_attributes__': 'ClassVar[Dict[str, ModelPrivateAttr]]', '__pydantic_complete__': 'ClassVar[bool]', '__pydantic_core_schema__': 'ClassVar[CoreSchema]', '__pydantic_custom_init__': 'ClassVar[bool]', '__pydantic_decorators__': 'ClassVar[_decorators.DecoratorInfos]', '__pydantic_extra__': 'dict[str, Any] | None', '__pydantic_fields_set__': 'set[str]', '__pydantic_generic_metadata__': 'ClassVar[_generics.PydanticGenericMetadata]', '__pydantic_parent_namespace__': 'ClassVar[Dict[str, Any] | None]', '__pydantic_post_init__': "ClassVar[None | Literal['model_post_init']]", '__pydantic_private__': 'dict[str, Any] | None', '__pydantic_root_model__': 'ClassVar[bool]', '__pydantic_serializer__': 'ClassVar[SchemaSerializer]', '__pydantic_validator__': 'ClassVar[SchemaValidator | PluggableSchemaValidator]', '__signature__': 'ClassVar[Signature]', 'data': <class 'kittycad.models.mouse_move.MouseMove'>, 'model_computed_fields': 'ClassVar[Dict[str, ComputedFieldInfo]]', 'model_config': 'ClassVar[ConfigDict]', 'model_fields': 'ClassVar[Dict[str, FieldInfo]]', 'type': typing.Literal['mouse_move']}[source]

classmethod __class_getitem__(typevar_values)[source]

Return type:: type[BaseModel] | PydanticRecursiveRef

__class_vars__: ClassVar[set[str]] = {}[source]: The names of the class variables defined on the model.

__copy__()[source]

Returns a shallow copy of the model.

Return type:: Self

__deepcopy__(memo=None)[source]

Returns a deep copy of the model.

Return type:: Self

__delattr__(item)[source]

Implement delattr(self, name).

Return type:: Any

__dict__[source]

__eq__(other)[source]

Return self==value.

Return type:: bool

property __fields_set__: set[str][source]

classmethod __get_pydantic_core_schema__(source, handler, /)[source]

Hook into generating the model’s CoreSchema.

Parameters:

source (type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.
handler (GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.

Return type:

Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]

Returns:

A pydantic-core CoreSchema.

classmethod __get_pydantic_json_schema__(core_schema, handler, /)[source]

Hook into generating the model’s JSON schema.

Parameters:

core_schema (Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({'type': 'nullable', 'schema': current_schema}), or just call the handler with the original schema.
handler (GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.

Return type:

Returns:

A JSON schema, as a Python object.

__getattr__(item)[source]

Return type:: Any

__getstate__()[source]

Helper for pickle.

Return type:: dict[Any, Any]

__hash__ = None[source]

__init__(**data)[source]

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__iter__()[source]

So dict(model) works.

Return type:: Generator[Tuple[str, Any], None, None]

__module__ = 'kittycad.models.ok_modeling_cmd_response'[source]

__pretty__(fmt, **kwargs)[source]

Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.

Return type:: Generator[Any, None, None]

__private_attributes__: ClassVar[Dict[str, ModelPrivateAttr]] = {}[source]: Metadata about the private attributes of the model.

__pydantic_complete__: ClassVar[bool] = True[source]: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__: ClassVar[CoreSchema] = {'cls': <class 'kittycad.models.ok_modeling_cmd_response.OptionMouseMove'>, 'config': {'title': 'OptionMouseMove'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.ok_modeling_cmd_response.OptionMouseMove'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.ok_modeling_cmd_response.OptionMouseMove'>>]}, 'ref': 'kittycad.models.ok_modeling_cmd_response.OptionMouseMove:94667213008512', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'data': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.mouse_move.MouseMove'>, 'config': {'title': 'MouseMove'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.mouse_move.MouseMove'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.mouse_move.MouseMove'>>]}, 'ref': 'kittycad.models.mouse_move.MouseMove:94667209935888', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {}, 'model_name': 'MouseMove', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}, 'type': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': 'mouse_move', 'schema': {'expected': ['mouse_move'], 'type': 'literal'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'OptionMouseMove', 'type': 'model-fields'}, 'type': 'model'}[source]: The core schema of the model.

__pydantic_custom_init__: ClassVar[bool] = False[source]: Whether the model has a custom __init__ method.

__pydantic_decorators__: ClassVar[_decorators.DecoratorInfos] = DecoratorInfos(validators={}, field_validators={}, root_validators={}, field_serializers={}, model_serializers={}, model_validators={}, computed_fields={})[source]: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_extra__: dict[str, Any] | None[source]: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to 'allow'.

__pydantic_fields_set__: set[str][source]: The names of fields explicitly set during instantiation.

__pydantic_generic_metadata__: ClassVar[_generics.PydanticGenericMetadata] = {'args': (), 'origin': None, 'parameters': ()}[source]: 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.

classmethod __pydantic_init_subclass__(**kwargs)[source]

This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.

This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.

This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.

Parameters:: **kwargs (Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.
Return type:: None

__pydantic_parent_namespace__: ClassVar[Dict[str, Any] | None] = None[source]: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__: ClassVar[None | Literal['model_post_init']] = None[source]: The name of the post-init method for the model, if defined.

__pydantic_private__: dict[str, Any] | None[source]: Values of private attributes set on the model instance.

__pydantic_root_model__: ClassVar[bool] = False[source]: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__: ClassVar[SchemaSerializer] = SchemaSerializer(serializer=Model( ModelSerializer { class: Py( 0x000056196d9a6e80, ), serializer: Fields( GeneralFieldsSerializer { fields: { "type": SerField { key_py: Py( 0x00007f903823d958, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f90346e39f0, ), ), serializer: Literal( LiteralSerializer { expected_int: {}, expected_str: { "mouse_move", }, expected_py: None, name: "literal['mouse_move']", }, ), }, ), ), required: true, }, "data": SerField { key_py: Py( 0x00007f9038238fa0, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196d6b8c10, ), serializer: Fields( GeneralFieldsSerializer { fields: {}, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 0, }, ), has_extra: false, root_model: false, name: "MouseMove", }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "OptionMouseMove", }, ), definitions=[])[source]: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__: ClassVar[SchemaValidator | PluggableSchemaValidator] = SchemaValidator(title="OptionMouseMove", validator=Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "data", lookup_key: Simple { key: "data", py_key: Py( 0x00007f90334d7180, ), path: LookupPath( [ S( "data", Py( 0x00007f90334d71b0, ), ), ], ), }, name_py: Py( 0x00007f9038238fa0, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [], model_name: "MouseMove", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d6b8c10, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "MouseMove", }, ), frozen: false, }, Field { name: "type", lookup_key: Simple { key: "type", py_key: Py( 0x00007f90334d71e0, ), path: LookupPath( [ S( "type", Py( 0x00007f90334d7210, ), ), ], ), }, name_py: Py( 0x00007f903823d958, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f90346e39f0, ), ), on_error: Raise, validator: Literal( LiteralValidator { lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "mouse_move": 0, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f90346e39f0, ), ], }, expected_repr: "'mouse_move'", name: "literal['mouse_move']", }, ), validate_default: false, copy_default: false, name: "default[literal['mouse_move']]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "OptionMouseMove", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d9a6e80, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "OptionMouseMove", }, ), definitions=[], cache_strings=True)[source]: The pydantic-core SchemaValidator used to validate instances of the model.

__repr__()[source]

Return repr(self).

Return type:: str

__repr_args__()[source]

Return type:: Iterable[tuple[str | None, Any]]

__repr_name__()[source]

Name of the instance’s class, used in __repr__.

Return type:: str

__repr_str__(join_str)[source]

Return type:: str

__rich_repr__()[source]

Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.

Return type:: Iterable[Any | tuple[Any] | tuple[str, Any] | tuple[str, Any, Any]]

__setattr__(name, value)[source]

Implement setattr(self, name, value).

Return type:: None

__setstate__(state)[source]

Return type:: None

__signature__: ClassVar[Signature] = <Signature (*, data: kittycad.models.mouse_move.MouseMove, type: Literal['mouse_move'] = 'mouse_move') -> None>[source]: The synthesized __init__ [Signature][inspect.Signature] of the model.

__slots__ = ('__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__')[source]

__str__()[source]

Return str(self).

Return type:: str

_abc_impl = <_abc._abc_data object>[source]

_calculate_keys(*args, **kwargs)[source]

Return type:: Any

_check_frozen(name, value)[source]

Return type:: None

_copy_and_set_values(*args, **kwargs)[source]

Return type:: Any

classmethod _get_value(*args, **kwargs)[source]

Return type:: Any

_iter(*args, **kwargs)[source]

Return type:: Any

classmethod construct(_fields_set=None, **values)[source]

Return type:: Self

copy(*, include=None, exclude=None, update=None, deep=False)[source]

Returns a copy of the model.

!!! warning “Deprecated”: This method is now deprecated; use model_copy instead.

If you need include or exclude, use:

`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `

Parameters:

include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.

Returns:

A copy of the model with included, excluded and updated fields as specified.

data: MouseMove[source]

dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)[source]

Return type:: Dict[str, Any]

classmethod from_orm(obj)[source]

Return type:: Self

json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)[source]

Return type:: str

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}[source]: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'protected_namespaces': ()}[source]: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod model_construct(_fields_set=None, **values)[source]

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note: model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == 'allow', then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == 'ignore' (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == 'forbid' does not result in an error if extra values are passed, but they will be ignored.

Parameters:

_fields_set (set[str] | None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.
values (Any) – Trusted or pre-validated data dictionary.

Return type:

Self

Returns:

A new instance of the Model class with validated data.

model_copy(*, update=None, deep=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy

Returns a copy of the model.

Parameters:

update (dict[str, Any] | None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.
deep (bool) – Set to True to make a deep copy of the model.

Return type:

Self

Returns:

New model instance.

model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters:

mode (Union[Literal['json', 'python'], str]) – The mode in which to_python 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.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to include in the output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to exclude from the output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to use the field’s alias in the dictionary key if defined.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A dictionary representation of the model.

model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

Generates a JSON representation of the model using Pydantic’s to_json method.

Parameters:

indent (int | None) – Indentation to use in the JSON output. If None is passed, the output will be compact.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to include in the JSON output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to exclude from the JSON output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to serialize using field aliases.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A JSON string representation of the model.

property model_extra: dict[str, Any] | None[source]

Get extra fields set during validation.

Returns:: A dictionary of extra fields, or None if config.extra is not set to "allow".

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=MouseMove, required=True), 'type': FieldInfo(annotation=Literal['mouse_move'], required=False, default='mouse_move')}[source]

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

property model_fields_set: set[str][source]

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,: i.e. that were not filled from defaults.

classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')[source]

Generates a JSON schema for a model class.

Parameters:

by_alias (bool) – Whether to use attribute aliases or not.
ref_template (str) – The reference template.
schema_generator (type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modifications
mode (Literal['validation', 'serialization']) – The mode in which to generate the schema.

Return type:

Returns:

The JSON schema for the given model class.

classmethod model_parametrized_name(params)[source]

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

Parameters:: params (tuple[type[Any], ...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.
Return type:: str
Returns:: String representing the new class where params are passed to cls as type variables.
Raises:: TypeError – Raised when trying to generate concrete names for non-generic models.

model_post_init(_BaseModel__context)[source]

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

Return type:: None

classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)[source]

Try to rebuild the pydantic-core schema for the model.

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.

Parameters:

force (bool) – Whether to force the rebuilding of the model schema, defaults to False.
raise_errors (bool) – Whether to raise errors, defaults to True.
_parent_namespace_depth (int) – The depth level of the parent namespace, defaults to 2.
_types_namespace (dict[str, Any] | None) – The types namespace, defaults to None.

Return type:

Returns:

Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.

classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)[source]

Validate a pydantic model instance.

Parameters:

obj (Any) – The object to validate.
strict (bool | None) – Whether to enforce types strictly.
from_attributes (bool | None) – Whether to extract data from object attributes.
context (Any | None) – Additional context to pass to the validator.

Raises:

ValidationError – If the object could not be validated.

Return type:

Self

Returns:

The validated model instance.

classmethod model_validate_json(json_data, *, strict=None, context=None)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing

Validate the given JSON data against the Pydantic model.

Parameters:

json_data (str | bytes | bytearray) – The JSON data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

Raises:

ValidationError – If json_data is not a JSON string or the object could not be validated.

classmethod model_validate_strings(obj, *, strict=None, context=None)[source]

Validate the given object with string data against the Pydantic model.

Parameters:

obj (Any) – The object containing string data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod parse_obj(obj)[source]

Return type:: Self

classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod schema(by_alias=True, ref_template='#/$defs/{model}')[source]

Return type:: Dict[str, Any]

classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)[source]

Return type:: str

type: Literal['mouse_move'][source]

classmethod update_forward_refs(**localns)[source]

Return type:: None

classmethod validate(value)[source]

Return type:: Self

class kittycad.models.ok_modeling_cmd_response.OptionMovePathPen(**data)[source][source]

The response to the ‘MovePathPen’ endpoint

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__abstractmethods__ = frozenset({})[source]

__annotations__ = {'__class_vars__': 'ClassVar[set[str]]', '__private_attributes__': 'ClassVar[Dict[str, ModelPrivateAttr]]', '__pydantic_complete__': 'ClassVar[bool]', '__pydantic_core_schema__': 'ClassVar[CoreSchema]', '__pydantic_custom_init__': 'ClassVar[bool]', '__pydantic_decorators__': 'ClassVar[_decorators.DecoratorInfos]', '__pydantic_extra__': 'dict[str, Any] | None', '__pydantic_fields_set__': 'set[str]', '__pydantic_generic_metadata__': 'ClassVar[_generics.PydanticGenericMetadata]', '__pydantic_parent_namespace__': 'ClassVar[Dict[str, Any] | None]', '__pydantic_post_init__': "ClassVar[None | Literal['model_post_init']]", '__pydantic_private__': 'dict[str, Any] | None', '__pydantic_root_model__': 'ClassVar[bool]', '__pydantic_serializer__': 'ClassVar[SchemaSerializer]', '__pydantic_validator__': 'ClassVar[SchemaValidator | PluggableSchemaValidator]', '__signature__': 'ClassVar[Signature]', 'data': <class 'kittycad.models.move_path_pen.MovePathPen'>, 'model_computed_fields': 'ClassVar[Dict[str, ComputedFieldInfo]]', 'model_config': 'ClassVar[ConfigDict]', 'model_fields': 'ClassVar[Dict[str, FieldInfo]]', 'type': typing.Literal['move_path_pen']}[source]

classmethod __class_getitem__(typevar_values)[source]

Return type:: type[BaseModel] | PydanticRecursiveRef

__class_vars__: ClassVar[set[str]] = {}[source]: The names of the class variables defined on the model.

__copy__()[source]

Returns a shallow copy of the model.

Return type:: Self

__deepcopy__(memo=None)[source]

Returns a deep copy of the model.

Return type:: Self

__delattr__(item)[source]

Implement delattr(self, name).

Return type:: Any

__dict__[source]

__eq__(other)[source]

Return self==value.

Return type:: bool

property __fields_set__: set[str][source]

classmethod __get_pydantic_core_schema__(source, handler, /)[source]

Hook into generating the model’s CoreSchema.

Parameters:

source (type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.
handler (GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.

Return type:

Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]

Returns:

A pydantic-core CoreSchema.

classmethod __get_pydantic_json_schema__(core_schema, handler, /)[source]

Hook into generating the model’s JSON schema.

Parameters:

core_schema (Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({'type': 'nullable', 'schema': current_schema}), or just call the handler with the original schema.
handler (GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.

Return type:

Returns:

A JSON schema, as a Python object.

__getattr__(item)[source]

Return type:: Any

__getstate__()[source]

Helper for pickle.

Return type:: dict[Any, Any]

__hash__ = None[source]

__init__(**data)[source]

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__iter__()[source]

So dict(model) works.

Return type:: Generator[Tuple[str, Any], None, None]

__module__ = 'kittycad.models.ok_modeling_cmd_response'[source]

__pretty__(fmt, **kwargs)[source]

Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.

Return type:: Generator[Any, None, None]

__private_attributes__: ClassVar[Dict[str, ModelPrivateAttr]] = {}[source]: Metadata about the private attributes of the model.

__pydantic_complete__: ClassVar[bool] = True[source]: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__: ClassVar[CoreSchema] = {'cls': <class 'kittycad.models.ok_modeling_cmd_response.OptionMovePathPen'>, 'config': {'title': 'OptionMovePathPen'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.ok_modeling_cmd_response.OptionMovePathPen'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.ok_modeling_cmd_response.OptionMovePathPen'>>]}, 'ref': 'kittycad.models.ok_modeling_cmd_response.OptionMovePathPen:94667212677040', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'data': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.move_path_pen.MovePathPen'>, 'config': {'title': 'MovePathPen'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.move_path_pen.MovePathPen'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.move_path_pen.MovePathPen'>>]}, 'ref': 'kittycad.models.move_path_pen.MovePathPen:94667209834016', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {}, 'model_name': 'MovePathPen', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}, 'type': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': 'move_path_pen', 'schema': {'expected': ['move_path_pen'], 'type': 'literal'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'OptionMovePathPen', 'type': 'model-fields'}, 'type': 'model'}[source]: The core schema of the model.

__pydantic_custom_init__: ClassVar[bool] = False[source]: Whether the model has a custom __init__ method.

__pydantic_decorators__: ClassVar[_decorators.DecoratorInfos] = DecoratorInfos(validators={}, field_validators={}, root_validators={}, field_serializers={}, model_serializers={}, model_validators={}, computed_fields={})[source]: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_extra__: dict[str, Any] | None[source]: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to 'allow'.

__pydantic_fields_set__: set[str][source]: The names of fields explicitly set during instantiation.

__pydantic_generic_metadata__: ClassVar[_generics.PydanticGenericMetadata] = {'args': (), 'origin': None, 'parameters': ()}[source]: 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.

classmethod __pydantic_init_subclass__(**kwargs)[source]

This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.

This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.

This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.

Parameters:: **kwargs (Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.
Return type:: None

__pydantic_parent_namespace__: ClassVar[Dict[str, Any] | None] = None[source]: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__: ClassVar[None | Literal['model_post_init']] = None[source]: The name of the post-init method for the model, if defined.

__pydantic_private__: dict[str, Any] | None[source]: Values of private attributes set on the model instance.

__pydantic_root_model__: ClassVar[bool] = False[source]: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__: ClassVar[SchemaSerializer] = SchemaSerializer(serializer=Model( ModelSerializer { class: Py( 0x000056196d955fb0, ), serializer: Fields( GeneralFieldsSerializer { fields: { "data": SerField { key_py: Py( 0x00007f9038238fa0, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196d69fe20, ), serializer: Fields( GeneralFieldsSerializer { fields: {}, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 0, }, ), has_extra: false, root_model: false, name: "MovePathPen", }, ), ), required: true, }, "type": SerField { key_py: Py( 0x00007f903823d958, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f90346e3a70, ), ), serializer: Literal( LiteralSerializer { expected_int: {}, expected_str: { "move_path_pen", }, expected_py: None, name: "literal['move_path_pen']", }, ), }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "OptionMovePathPen", }, ), definitions=[])[source]: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__: ClassVar[SchemaValidator | PluggableSchemaValidator] = SchemaValidator(title="OptionMovePathPen", validator=Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "data", lookup_key: Simple { key: "data", py_key: Py( 0x00007f90335004e0, ), path: LookupPath( [ S( "data", Py( 0x00007f9033500b10, ), ), ], ), }, name_py: Py( 0x00007f9038238fa0, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [], model_name: "MovePathPen", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d69fe20, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "MovePathPen", }, ), frozen: false, }, Field { name: "type", lookup_key: Simple { key: "type", py_key: Py( 0x00007f9033500720, ), path: LookupPath( [ S( "type", Py( 0x00007f90335006f0, ), ), ], ), }, name_py: Py( 0x00007f903823d958, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f90346e3a70, ), ), on_error: Raise, validator: Literal( LiteralValidator { lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "move_path_pen": 0, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f90346e3a70, ), ], }, expected_repr: "'move_path_pen'", name: "literal['move_path_pen']", }, ), validate_default: false, copy_default: false, name: "default[literal['move_path_pen']]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "OptionMovePathPen", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d955fb0, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "OptionMovePathPen", }, ), definitions=[], cache_strings=True)[source]: The pydantic-core SchemaValidator used to validate instances of the model.

__repr__()[source]

Return repr(self).

Return type:: str

__repr_args__()[source]

Return type:: Iterable[tuple[str | None, Any]]

__repr_name__()[source]

Name of the instance’s class, used in __repr__.

Return type:: str

__repr_str__(join_str)[source]

Return type:: str

__rich_repr__()[source]

Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.

Return type:: Iterable[Any | tuple[Any] | tuple[str, Any] | tuple[str, Any, Any]]

__setattr__(name, value)[source]

Implement setattr(self, name, value).

Return type:: None

__setstate__(state)[source]

Return type:: None

__signature__: ClassVar[Signature] = <Signature (*, data: kittycad.models.move_path_pen.MovePathPen, type: Literal['move_path_pen'] = 'move_path_pen') -> None>[source]: The synthesized __init__ [Signature][inspect.Signature] of the model.

__slots__ = ('__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__')[source]

__str__()[source]

Return str(self).

Return type:: str

_abc_impl = <_abc._abc_data object>[source]

_calculate_keys(*args, **kwargs)[source]

Return type:: Any

_check_frozen(name, value)[source]

Return type:: None

_copy_and_set_values(*args, **kwargs)[source]

Return type:: Any

classmethod _get_value(*args, **kwargs)[source]

Return type:: Any

_iter(*args, **kwargs)[source]

Return type:: Any

classmethod construct(_fields_set=None, **values)[source]

Return type:: Self

copy(*, include=None, exclude=None, update=None, deep=False)[source]

Returns a copy of the model.

!!! warning “Deprecated”: This method is now deprecated; use model_copy instead.

If you need include or exclude, use:

`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `

Parameters:

include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.

Returns:

A copy of the model with included, excluded and updated fields as specified.

data: MovePathPen[source]

dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)[source]

Return type:: Dict[str, Any]

classmethod from_orm(obj)[source]

Return type:: Self

json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)[source]

Return type:: str

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}[source]: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'protected_namespaces': ()}[source]: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod model_construct(_fields_set=None, **values)[source]

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note: model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == 'allow', then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == 'ignore' (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == 'forbid' does not result in an error if extra values are passed, but they will be ignored.

Parameters:

_fields_set (set[str] | None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.
values (Any) – Trusted or pre-validated data dictionary.

Return type:

Self

Returns:

A new instance of the Model class with validated data.

model_copy(*, update=None, deep=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy

Returns a copy of the model.

Parameters:

update (dict[str, Any] | None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.
deep (bool) – Set to True to make a deep copy of the model.

Return type:

Self

Returns:

New model instance.

model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters:

mode (Union[Literal['json', 'python'], str]) – The mode in which to_python 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.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to include in the output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to exclude from the output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to use the field’s alias in the dictionary key if defined.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A dictionary representation of the model.

model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

Generates a JSON representation of the model using Pydantic’s to_json method.

Parameters:

indent (int | None) – Indentation to use in the JSON output. If None is passed, the output will be compact.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to include in the JSON output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to exclude from the JSON output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to serialize using field aliases.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A JSON string representation of the model.

property model_extra: dict[str, Any] | None[source]

Get extra fields set during validation.

Returns:: A dictionary of extra fields, or None if config.extra is not set to "allow".

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=MovePathPen, required=True), 'type': FieldInfo(annotation=Literal['move_path_pen'], required=False, default='move_path_pen')}[source]

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

property model_fields_set: set[str][source]

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,: i.e. that were not filled from defaults.

classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')[source]

Generates a JSON schema for a model class.

Parameters:

by_alias (bool) – Whether to use attribute aliases or not.
ref_template (str) – The reference template.
schema_generator (type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modifications
mode (Literal['validation', 'serialization']) – The mode in which to generate the schema.

Return type:

Returns:

The JSON schema for the given model class.

classmethod model_parametrized_name(params)[source]

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

Parameters:: params (tuple[type[Any], ...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.
Return type:: str
Returns:: String representing the new class where params are passed to cls as type variables.
Raises:: TypeError – Raised when trying to generate concrete names for non-generic models.

model_post_init(_BaseModel__context)[source]

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

Return type:: None

classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)[source]

Try to rebuild the pydantic-core schema for the model.

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.

Parameters:

force (bool) – Whether to force the rebuilding of the model schema, defaults to False.
raise_errors (bool) – Whether to raise errors, defaults to True.
_parent_namespace_depth (int) – The depth level of the parent namespace, defaults to 2.
_types_namespace (dict[str, Any] | None) – The types namespace, defaults to None.

Return type:

Returns:

Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.

classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)[source]

Validate a pydantic model instance.

Parameters:

obj (Any) – The object to validate.
strict (bool | None) – Whether to enforce types strictly.
from_attributes (bool | None) – Whether to extract data from object attributes.
context (Any | None) – Additional context to pass to the validator.

Raises:

ValidationError – If the object could not be validated.

Return type:

Self

Returns:

The validated model instance.

classmethod model_validate_json(json_data, *, strict=None, context=None)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing

Validate the given JSON data against the Pydantic model.

Parameters:

json_data (str | bytes | bytearray) – The JSON data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

Raises:

ValidationError – If json_data is not a JSON string or the object could not be validated.

classmethod model_validate_strings(obj, *, strict=None, context=None)[source]

Validate the given object with string data against the Pydantic model.

Parameters:

obj (Any) – The object containing string data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod parse_obj(obj)[source]

Return type:: Self

classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod schema(by_alias=True, ref_template='#/$defs/{model}')[source]

Return type:: Dict[str, Any]

classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)[source]

Return type:: str

type: Literal['move_path_pen'][source]

classmethod update_forward_refs(**localns)[source]

Return type:: None

classmethod validate(value)[source]

Return type:: Self

class kittycad.models.ok_modeling_cmd_response.OptionNewAnnotation(**data)[source][source]

The response to the ‘NewAnnotation’ endpoint

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__abstractmethods__ = frozenset({})[source]

__annotations__ = {'__class_vars__': 'ClassVar[set[str]]', '__private_attributes__': 'ClassVar[Dict[str, ModelPrivateAttr]]', '__pydantic_complete__': 'ClassVar[bool]', '__pydantic_core_schema__': 'ClassVar[CoreSchema]', '__pydantic_custom_init__': 'ClassVar[bool]', '__pydantic_decorators__': 'ClassVar[_decorators.DecoratorInfos]', '__pydantic_extra__': 'dict[str, Any] | None', '__pydantic_fields_set__': 'set[str]', '__pydantic_generic_metadata__': 'ClassVar[_generics.PydanticGenericMetadata]', '__pydantic_parent_namespace__': 'ClassVar[Dict[str, Any] | None]', '__pydantic_post_init__': "ClassVar[None | Literal['model_post_init']]", '__pydantic_private__': 'dict[str, Any] | None', '__pydantic_root_model__': 'ClassVar[bool]', '__pydantic_serializer__': 'ClassVar[SchemaSerializer]', '__pydantic_validator__': 'ClassVar[SchemaValidator | PluggableSchemaValidator]', '__signature__': 'ClassVar[Signature]', 'data': <class 'kittycad.models.new_annotation.NewAnnotation'>, 'model_computed_fields': 'ClassVar[Dict[str, ComputedFieldInfo]]', 'model_config': 'ClassVar[ConfigDict]', 'model_fields': 'ClassVar[Dict[str, FieldInfo]]', 'type': typing.Literal['new_annotation']}[source]

classmethod __class_getitem__(typevar_values)[source]

Return type:: type[BaseModel] | PydanticRecursiveRef

__class_vars__: ClassVar[set[str]] = {}[source]: The names of the class variables defined on the model.

__copy__()[source]

Returns a shallow copy of the model.

Return type:: Self

__deepcopy__(memo=None)[source]

Returns a deep copy of the model.

Return type:: Self

__delattr__(item)[source]

Implement delattr(self, name).

Return type:: Any

__dict__[source]

__eq__(other)[source]

Return self==value.

Return type:: bool

property __fields_set__: set[str][source]

classmethod __get_pydantic_core_schema__(source, handler, /)[source]

Hook into generating the model’s CoreSchema.

Parameters:

source (type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.
handler (GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.

Return type:

Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]

Returns:

A pydantic-core CoreSchema.

classmethod __get_pydantic_json_schema__(core_schema, handler, /)[source]

Hook into generating the model’s JSON schema.

Parameters:

core_schema (Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({'type': 'nullable', 'schema': current_schema}), or just call the handler with the original schema.
handler (GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.

Return type:

Returns:

A JSON schema, as a Python object.

__getattr__(item)[source]

Return type:: Any

__getstate__()[source]

Helper for pickle.

Return type:: dict[Any, Any]

__hash__ = None[source]

__init__(**data)[source]

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__iter__()[source]

So dict(model) works.

Return type:: Generator[Tuple[str, Any], None, None]

__module__ = 'kittycad.models.ok_modeling_cmd_response'[source]

__pretty__(fmt, **kwargs)[source]

Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.

Return type:: Generator[Any, None, None]

__private_attributes__: ClassVar[Dict[str, ModelPrivateAttr]] = {}[source]: Metadata about the private attributes of the model.

__pydantic_complete__: ClassVar[bool] = True[source]: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__: ClassVar[CoreSchema] = {'cls': <class 'kittycad.models.ok_modeling_cmd_response.OptionNewAnnotation'>, 'config': {'title': 'OptionNewAnnotation'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.ok_modeling_cmd_response.OptionNewAnnotation'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.ok_modeling_cmd_response.OptionNewAnnotation'>>]}, 'ref': 'kittycad.models.ok_modeling_cmd_response.OptionNewAnnotation:94667212878032', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'data': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.new_annotation.NewAnnotation'>, 'config': {'title': 'NewAnnotation'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.new_annotation.NewAnnotation'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.new_annotation.NewAnnotation'>>]}, 'ref': 'kittycad.models.new_annotation.NewAnnotation:94667212356400', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {}, 'model_name': 'NewAnnotation', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}, 'type': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': 'new_annotation', 'schema': {'expected': ['new_annotation'], 'type': 'literal'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'OptionNewAnnotation', 'type': 'model-fields'}, 'type': 'model'}[source]: The core schema of the model.

__pydantic_custom_init__: ClassVar[bool] = False[source]: Whether the model has a custom __init__ method.

__pydantic_decorators__: ClassVar[_decorators.DecoratorInfos] = DecoratorInfos(validators={}, field_validators={}, root_validators={}, field_serializers={}, model_serializers={}, model_validators={}, computed_fields={})[source]: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_extra__: dict[str, Any] | None[source]: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to 'allow'.

__pydantic_fields_set__: set[str][source]: The names of fields explicitly set during instantiation.

__pydantic_generic_metadata__: ClassVar[_generics.PydanticGenericMetadata] = {'args': (), 'origin': None, 'parameters': ()}[source]: 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.

classmethod __pydantic_init_subclass__(**kwargs)[source]

This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.

This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.

This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.

Parameters:: **kwargs (Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.
Return type:: None

__pydantic_parent_namespace__: ClassVar[Dict[str, Any] | None] = None[source]: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__: ClassVar[None | Literal['model_post_init']] = None[source]: The name of the post-init method for the model, if defined.

__pydantic_private__: dict[str, Any] | None[source]: Values of private attributes set on the model instance.

__pydantic_root_model__: ClassVar[bool] = False[source]: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__: ClassVar[SchemaSerializer] = SchemaSerializer(serializer=Model( ModelSerializer { class: Py( 0x000056196d9870d0, ), serializer: Fields( GeneralFieldsSerializer { fields: { "type": SerField { key_py: Py( 0x00007f903823d958, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f90346e3af0, ), ), serializer: Literal( LiteralSerializer { expected_int: {}, expected_str: { "new_annotation", }, expected_py: None, name: "literal['new_annotation']", }, ), }, ), ), required: true, }, "data": SerField { key_py: Py( 0x00007f9038238fa0, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196d907b30, ), serializer: Fields( GeneralFieldsSerializer { fields: {}, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 0, }, ), has_extra: false, root_model: false, name: "NewAnnotation", }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "OptionNewAnnotation", }, ), definitions=[])[source]: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__: ClassVar[SchemaValidator | PluggableSchemaValidator] = SchemaValidator(title="OptionNewAnnotation", validator=Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "data", lookup_key: Simple { key: "data", py_key: Py( 0x00007f90334d4c90, ), path: LookupPath( [ S( "data", Py( 0x00007f90334d4cc0, ), ), ], ), }, name_py: Py( 0x00007f9038238fa0, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [], model_name: "NewAnnotation", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d907b30, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "NewAnnotation", }, ), frozen: false, }, Field { name: "type", lookup_key: Simple { key: "type", py_key: Py( 0x00007f90334d4cf0, ), path: LookupPath( [ S( "type", Py( 0x00007f90334d4d20, ), ), ], ), }, name_py: Py( 0x00007f903823d958, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f90346e3af0, ), ), on_error: Raise, validator: Literal( LiteralValidator { lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "new_annotation": 0, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f90346e3af0, ), ], }, expected_repr: "'new_annotation'", name: "literal['new_annotation']", }, ), validate_default: false, copy_default: false, name: "default[literal['new_annotation']]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "OptionNewAnnotation", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d9870d0, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "OptionNewAnnotation", }, ), definitions=[], cache_strings=True)[source]: The pydantic-core SchemaValidator used to validate instances of the model.

__repr__()[source]

Return repr(self).

Return type:: str

__repr_args__()[source]

Return type:: Iterable[tuple[str | None, Any]]

__repr_name__()[source]

Name of the instance’s class, used in __repr__.

Return type:: str

__repr_str__(join_str)[source]

Return type:: str

__rich_repr__()[source]

Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.

Return type:: Iterable[Any | tuple[Any] | tuple[str, Any] | tuple[str, Any, Any]]

__setattr__(name, value)[source]

Implement setattr(self, name, value).

Return type:: None

__setstate__(state)[source]

Return type:: None

__signature__: ClassVar[Signature] = <Signature (*, data: kittycad.models.new_annotation.NewAnnotation, type: Literal['new_annotation'] = 'new_annotation') -> None>[source]: The synthesized __init__ [Signature][inspect.Signature] of the model.

__slots__ = ('__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__')[source]

__str__()[source]

Return str(self).

Return type:: str

_abc_impl = <_abc._abc_data object>[source]

_calculate_keys(*args, **kwargs)[source]

Return type:: Any

_check_frozen(name, value)[source]

Return type:: None

_copy_and_set_values(*args, **kwargs)[source]

Return type:: Any

classmethod _get_value(*args, **kwargs)[source]

Return type:: Any

_iter(*args, **kwargs)[source]

Return type:: Any

classmethod construct(_fields_set=None, **values)[source]

Return type:: Self

copy(*, include=None, exclude=None, update=None, deep=False)[source]

Returns a copy of the model.

!!! warning “Deprecated”: This method is now deprecated; use model_copy instead.

If you need include or exclude, use:

`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `

Parameters:

include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.

Returns:

A copy of the model with included, excluded and updated fields as specified.

data: NewAnnotation[source]

dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)[source]

Return type:: Dict[str, Any]

classmethod from_orm(obj)[source]

Return type:: Self

json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)[source]

Return type:: str

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}[source]: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'protected_namespaces': ()}[source]: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod model_construct(_fields_set=None, **values)[source]

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note: model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == 'allow', then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == 'ignore' (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == 'forbid' does not result in an error if extra values are passed, but they will be ignored.

Parameters:

_fields_set (set[str] | None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.
values (Any) – Trusted or pre-validated data dictionary.

Return type:

Self

Returns:

A new instance of the Model class with validated data.

model_copy(*, update=None, deep=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy

Returns a copy of the model.

Parameters:

update (dict[str, Any] | None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.
deep (bool) – Set to True to make a deep copy of the model.

Return type:

Self

Returns:

New model instance.

model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters:

mode (Union[Literal['json', 'python'], str]) – The mode in which to_python 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.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to include in the output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to exclude from the output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to use the field’s alias in the dictionary key if defined.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A dictionary representation of the model.

model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

Generates a JSON representation of the model using Pydantic’s to_json method.

Parameters:

indent (int | None) – Indentation to use in the JSON output. If None is passed, the output will be compact.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to include in the JSON output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to exclude from the JSON output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to serialize using field aliases.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A JSON string representation of the model.

property model_extra: dict[str, Any] | None[source]

Get extra fields set during validation.

Returns:: A dictionary of extra fields, or None if config.extra is not set to "allow".

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=NewAnnotation, required=True), 'type': FieldInfo(annotation=Literal['new_annotation'], required=False, default='new_annotation')}[source]

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

property model_fields_set: set[str][source]

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,: i.e. that were not filled from defaults.

classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')[source]

Generates a JSON schema for a model class.

Parameters:

by_alias (bool) – Whether to use attribute aliases or not.
ref_template (str) – The reference template.
schema_generator (type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modifications
mode (Literal['validation', 'serialization']) – The mode in which to generate the schema.

Return type:

Returns:

The JSON schema for the given model class.

classmethod model_parametrized_name(params)[source]

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

Parameters:: params (tuple[type[Any], ...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.
Return type:: str
Returns:: String representing the new class where params are passed to cls as type variables.
Raises:: TypeError – Raised when trying to generate concrete names for non-generic models.

model_post_init(_BaseModel__context)[source]

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

Return type:: None

classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)[source]

Try to rebuild the pydantic-core schema for the model.

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.

Parameters:

force (bool) – Whether to force the rebuilding of the model schema, defaults to False.
raise_errors (bool) – Whether to raise errors, defaults to True.
_parent_namespace_depth (int) – The depth level of the parent namespace, defaults to 2.
_types_namespace (dict[str, Any] | None) – The types namespace, defaults to None.

Return type:

Returns:

Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.

classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)[source]

Validate a pydantic model instance.

Parameters:

obj (Any) – The object to validate.
strict (bool | None) – Whether to enforce types strictly.
from_attributes (bool | None) – Whether to extract data from object attributes.
context (Any | None) – Additional context to pass to the validator.

Raises:

ValidationError – If the object could not be validated.

Return type:

Self

Returns:

The validated model instance.

classmethod model_validate_json(json_data, *, strict=None, context=None)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing

Validate the given JSON data against the Pydantic model.

Parameters:

json_data (str | bytes | bytearray) – The JSON data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

Raises:

ValidationError – If json_data is not a JSON string or the object could not be validated.

classmethod model_validate_strings(obj, *, strict=None, context=None)[source]

Validate the given object with string data against the Pydantic model.

Parameters:

obj (Any) – The object containing string data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod parse_obj(obj)[source]

Return type:: Self

classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod schema(by_alias=True, ref_template='#/$defs/{model}')[source]

Return type:: Dict[str, Any]

classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)[source]

Return type:: str

type: Literal['new_annotation'][source]

classmethod update_forward_refs(**localns)[source]

Return type:: None

classmethod validate(value)[source]

Return type:: Self

class kittycad.models.ok_modeling_cmd_response.OptionObjectBringToFront(**data)[source][source]

The response to the ‘ObjectBringToFront’ endpoint

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__abstractmethods__ = frozenset({})[source]

__annotations__ = {'__class_vars__': 'ClassVar[set[str]]', '__private_attributes__': 'ClassVar[Dict[str, ModelPrivateAttr]]', '__pydantic_complete__': 'ClassVar[bool]', '__pydantic_core_schema__': 'ClassVar[CoreSchema]', '__pydantic_custom_init__': 'ClassVar[bool]', '__pydantic_decorators__': 'ClassVar[_decorators.DecoratorInfos]', '__pydantic_extra__': 'dict[str, Any] | None', '__pydantic_fields_set__': 'set[str]', '__pydantic_generic_metadata__': 'ClassVar[_generics.PydanticGenericMetadata]', '__pydantic_parent_namespace__': 'ClassVar[Dict[str, Any] | None]', '__pydantic_post_init__': "ClassVar[None | Literal['model_post_init']]", '__pydantic_private__': 'dict[str, Any] | None', '__pydantic_root_model__': 'ClassVar[bool]', '__pydantic_serializer__': 'ClassVar[SchemaSerializer]', '__pydantic_validator__': 'ClassVar[SchemaValidator | PluggableSchemaValidator]', '__signature__': 'ClassVar[Signature]', 'data': <class 'kittycad.models.object_bring_to_front.ObjectBringToFront'>, 'model_computed_fields': 'ClassVar[Dict[str, ComputedFieldInfo]]', 'model_config': 'ClassVar[ConfigDict]', 'model_fields': 'ClassVar[Dict[str, FieldInfo]]', 'type': typing.Literal['object_bring_to_front']}[source]

classmethod __class_getitem__(typevar_values)[source]

Return type:: type[BaseModel] | PydanticRecursiveRef

__class_vars__: ClassVar[set[str]] = {}[source]: The names of the class variables defined on the model.

__copy__()[source]

Returns a shallow copy of the model.

Return type:: Self

__deepcopy__(memo=None)[source]

Returns a deep copy of the model.

Return type:: Self

__delattr__(item)[source]

Implement delattr(self, name).

Return type:: Any

__dict__[source]

__eq__(other)[source]

Return self==value.

Return type:: bool

property __fields_set__: set[str][source]

classmethod __get_pydantic_core_schema__(source, handler, /)[source]

Hook into generating the model’s CoreSchema.

Parameters:

source (type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.
handler (GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.

Return type:

Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]

Returns:

A pydantic-core CoreSchema.

classmethod __get_pydantic_json_schema__(core_schema, handler, /)[source]

Hook into generating the model’s JSON schema.

Parameters:

core_schema (Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({'type': 'nullable', 'schema': current_schema}), or just call the handler with the original schema.
handler (GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.

Return type:

Returns:

A JSON schema, as a Python object.

__getattr__(item)[source]

Return type:: Any

__getstate__()[source]

Helper for pickle.

Return type:: dict[Any, Any]

__hash__ = None[source]

__init__(**data)[source]

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__iter__()[source]

So dict(model) works.

Return type:: Generator[Tuple[str, Any], None, None]

__module__ = 'kittycad.models.ok_modeling_cmd_response'[source]

__pretty__(fmt, **kwargs)[source]

Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.

Return type:: Generator[Any, None, None]

__private_attributes__: ClassVar[Dict[str, ModelPrivateAttr]] = {}[source]: Metadata about the private attributes of the model.

__pydantic_complete__: ClassVar[bool] = True[source]: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__: ClassVar[CoreSchema] = {'cls': <class 'kittycad.models.ok_modeling_cmd_response.OptionObjectBringToFront'>, 'config': {'title': 'OptionObjectBringToFront'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.ok_modeling_cmd_response.OptionObjectBringToFront'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.ok_modeling_cmd_response.OptionObjectBringToFront'>>]}, 'ref': 'kittycad.models.ok_modeling_cmd_response.OptionObjectBringToFront:94667212915296', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'data': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.object_bring_to_front.ObjectBringToFront'>, 'config': {'title': 'ObjectBringToFront'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.object_bring_to_front.ObjectBringToFront'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.object_bring_to_front.ObjectBringToFront'>>]}, 'ref': 'kittycad.models.object_bring_to_front.ObjectBringToFront:94667212365712', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {}, 'model_name': 'ObjectBringToFront', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}, 'type': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': 'object_bring_to_front', 'schema': {'expected': ['object_bring_to_front'], 'type': 'literal'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'OptionObjectBringToFront', 'type': 'model-fields'}, 'type': 'model'}[source]: The core schema of the model.

__pydantic_custom_init__: ClassVar[bool] = False[source]: Whether the model has a custom __init__ method.

__pydantic_decorators__: ClassVar[_decorators.DecoratorInfos] = DecoratorInfos(validators={}, field_validators={}, root_validators={}, field_serializers={}, model_serializers={}, model_validators={}, computed_fields={})[source]: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_extra__: dict[str, Any] | None[source]: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to 'allow'.

__pydantic_fields_set__: set[str][source]: The names of fields explicitly set during instantiation.

__pydantic_generic_metadata__: ClassVar[_generics.PydanticGenericMetadata] = {'args': (), 'origin': None, 'parameters': ()}[source]: 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.

classmethod __pydantic_init_subclass__(**kwargs)[source]

This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.

This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.

This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.

Parameters:: **kwargs (Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.
Return type:: None

__pydantic_parent_namespace__: ClassVar[Dict[str, Any] | None] = None[source]: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__: ClassVar[None | Literal['model_post_init']] = None[source]: The name of the post-init method for the model, if defined.

__pydantic_private__: dict[str, Any] | None[source]: Values of private attributes set on the model instance.

__pydantic_root_model__: ClassVar[bool] = False[source]: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__: ClassVar[SchemaSerializer] = SchemaSerializer(serializer=Model( ModelSerializer { class: Py( 0x000056196d990260, ), serializer: Fields( GeneralFieldsSerializer { fields: { "type": SerField { key_py: Py( 0x00007f903823d958, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f90346e3d70, ), ), serializer: Literal( LiteralSerializer { expected_int: {}, expected_str: { "object_bring_to_front", }, expected_py: None, name: "literal['object_bring_to_front']", }, ), }, ), ), required: true, }, "data": SerField { key_py: Py( 0x00007f9038238fa0, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196d909f90, ), serializer: Fields( GeneralFieldsSerializer { fields: {}, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 0, }, ), has_extra: false, root_model: false, name: "ObjectBringToFront", }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "OptionObjectBringToFront", }, ), definitions=[])[source]: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__: ClassVar[SchemaValidator | PluggableSchemaValidator] = SchemaValidator(title="OptionObjectBringToFront", validator=Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "data", lookup_key: Simple { key: "data", py_key: Py( 0x00007f90334d4f60, ), path: LookupPath( [ S( "data", Py( 0x00007f90334d4f30, ), ), ], ), }, name_py: Py( 0x00007f9038238fa0, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [], model_name: "ObjectBringToFront", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d909f90, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "ObjectBringToFront", }, ), frozen: false, }, Field { name: "type", lookup_key: Simple { key: "type", py_key: Py( 0x00007f90334d4ed0, ), path: LookupPath( [ S( "type", Py( 0x00007f90334d4ea0, ), ), ], ), }, name_py: Py( 0x00007f903823d958, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f90346e3d70, ), ), on_error: Raise, validator: Literal( LiteralValidator { lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "object_bring_to_front": 0, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f90346e3d70, ), ], }, expected_repr: "'object_bring_to_front'", name: "literal['object_bring_to_front']", }, ), validate_default: false, copy_default: false, name: "default[literal['object_bring_to_front']]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "OptionObjectBringToFront", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d990260, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "OptionObjectBringToFront", }, ), definitions=[], cache_strings=True)[source]: The pydantic-core SchemaValidator used to validate instances of the model.

__repr__()[source]

Return repr(self).

Return type:: str

__repr_args__()[source]

Return type:: Iterable[tuple[str | None, Any]]

__repr_name__()[source]

Name of the instance’s class, used in __repr__.

Return type:: str

__repr_str__(join_str)[source]

Return type:: str

__rich_repr__()[source]

Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.

Return type:: Iterable[Any | tuple[Any] | tuple[str, Any] | tuple[str, Any, Any]]

__setattr__(name, value)[source]

Implement setattr(self, name, value).

Return type:: None

__setstate__(state)[source]

Return type:: None

__signature__: ClassVar[Signature] = <Signature (*, data: kittycad.models.object_bring_to_front.ObjectBringToFront, type: Literal['object_bring_to_front'] = 'object_bring_to_front') -> None>[source]: The synthesized __init__ [Signature][inspect.Signature] of the model.

__slots__ = ('__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__')[source]

__str__()[source]

Return str(self).

Return type:: str

_abc_impl = <_abc._abc_data object>[source]

_calculate_keys(*args, **kwargs)[source]

Return type:: Any

_check_frozen(name, value)[source]

Return type:: None

_copy_and_set_values(*args, **kwargs)[source]

Return type:: Any

classmethod _get_value(*args, **kwargs)[source]

Return type:: Any

_iter(*args, **kwargs)[source]

Return type:: Any

classmethod construct(_fields_set=None, **values)[source]

Return type:: Self

copy(*, include=None, exclude=None, update=None, deep=False)[source]

Returns a copy of the model.

!!! warning “Deprecated”: This method is now deprecated; use model_copy instead.

If you need include or exclude, use:

`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `

Parameters:

include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.

Returns:

A copy of the model with included, excluded and updated fields as specified.

data: ObjectBringToFront[source]

dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)[source]

Return type:: Dict[str, Any]

classmethod from_orm(obj)[source]

Return type:: Self

json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)[source]

Return type:: str

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}[source]: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'protected_namespaces': ()}[source]: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod model_construct(_fields_set=None, **values)[source]

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note: model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == 'allow', then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == 'ignore' (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == 'forbid' does not result in an error if extra values are passed, but they will be ignored.

Parameters:

_fields_set (set[str] | None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.
values (Any) – Trusted or pre-validated data dictionary.

Return type:

Self

Returns:

A new instance of the Model class with validated data.

model_copy(*, update=None, deep=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy

Returns a copy of the model.

Parameters:

update (dict[str, Any] | None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.
deep (bool) – Set to True to make a deep copy of the model.

Return type:

Self

Returns:

New model instance.

model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters:

mode (Union[Literal['json', 'python'], str]) – The mode in which to_python 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.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to include in the output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to exclude from the output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to use the field’s alias in the dictionary key if defined.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A dictionary representation of the model.

model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

Generates a JSON representation of the model using Pydantic’s to_json method.

Parameters:

indent (int | None) – Indentation to use in the JSON output. If None is passed, the output will be compact.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to include in the JSON output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to exclude from the JSON output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to serialize using field aliases.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A JSON string representation of the model.

property model_extra: dict[str, Any] | None[source]

Get extra fields set during validation.

Returns:: A dictionary of extra fields, or None if config.extra is not set to "allow".

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=ObjectBringToFront, required=True), 'type': FieldInfo(annotation=Literal['object_bring_to_front'], required=False, default='object_bring_to_front')}[source]

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

property model_fields_set: set[str][source]

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,: i.e. that were not filled from defaults.

classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')[source]

Generates a JSON schema for a model class.

Parameters:

by_alias (bool) – Whether to use attribute aliases or not.
ref_template (str) – The reference template.
schema_generator (type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modifications
mode (Literal['validation', 'serialization']) – The mode in which to generate the schema.

Return type:

Returns:

The JSON schema for the given model class.

classmethod model_parametrized_name(params)[source]

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

Parameters:: params (tuple[type[Any], ...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.
Return type:: str
Returns:: String representing the new class where params are passed to cls as type variables.
Raises:: TypeError – Raised when trying to generate concrete names for non-generic models.

model_post_init(_BaseModel__context)[source]

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

Return type:: None

classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)[source]

Try to rebuild the pydantic-core schema for the model.

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.

Parameters:

force (bool) – Whether to force the rebuilding of the model schema, defaults to False.
raise_errors (bool) – Whether to raise errors, defaults to True.
_parent_namespace_depth (int) – The depth level of the parent namespace, defaults to 2.
_types_namespace (dict[str, Any] | None) – The types namespace, defaults to None.

Return type:

Returns:

Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.

classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)[source]

Validate a pydantic model instance.

Parameters:

obj (Any) – The object to validate.
strict (bool | None) – Whether to enforce types strictly.
from_attributes (bool | None) – Whether to extract data from object attributes.
context (Any | None) – Additional context to pass to the validator.

Raises:

ValidationError – If the object could not be validated.

Return type:

Self

Returns:

The validated model instance.

classmethod model_validate_json(json_data, *, strict=None, context=None)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing

Validate the given JSON data against the Pydantic model.

Parameters:

json_data (str | bytes | bytearray) – The JSON data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

Raises:

ValidationError – If json_data is not a JSON string or the object could not be validated.

classmethod model_validate_strings(obj, *, strict=None, context=None)[source]

Validate the given object with string data against the Pydantic model.

Parameters:

obj (Any) – The object containing string data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod parse_obj(obj)[source]

Return type:: Self

classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod schema(by_alias=True, ref_template='#/$defs/{model}')[source]

Return type:: Dict[str, Any]

classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)[source]

Return type:: str

type: Literal['object_bring_to_front'][source]

classmethod update_forward_refs(**localns)[source]

Return type:: None

classmethod validate(value)[source]

Return type:: Self

class kittycad.models.ok_modeling_cmd_response.OptionObjectSetMaterialParamsPbr(**data)[source][source]

The response to the ‘ObjectSetMaterialParamsPbr’ endpoint

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__abstractmethods__ = frozenset({})[source]

__annotations__ = {'__class_vars__': 'ClassVar[set[str]]', '__private_attributes__': 'ClassVar[Dict[str, ModelPrivateAttr]]', '__pydantic_complete__': 'ClassVar[bool]', '__pydantic_core_schema__': 'ClassVar[CoreSchema]', '__pydantic_custom_init__': 'ClassVar[bool]', '__pydantic_decorators__': 'ClassVar[_decorators.DecoratorInfos]', '__pydantic_extra__': 'dict[str, Any] | None', '__pydantic_fields_set__': 'set[str]', '__pydantic_generic_metadata__': 'ClassVar[_generics.PydanticGenericMetadata]', '__pydantic_parent_namespace__': 'ClassVar[Dict[str, Any] | None]', '__pydantic_post_init__': "ClassVar[None | Literal['model_post_init']]", '__pydantic_private__': 'dict[str, Any] | None', '__pydantic_root_model__': 'ClassVar[bool]', '__pydantic_serializer__': 'ClassVar[SchemaSerializer]', '__pydantic_validator__': 'ClassVar[SchemaValidator | PluggableSchemaValidator]', '__signature__': 'ClassVar[Signature]', 'data': <class 'kittycad.models.object_set_material_params_pbr.ObjectSetMaterialParamsPbr'>, 'model_computed_fields': 'ClassVar[Dict[str, ComputedFieldInfo]]', 'model_config': 'ClassVar[ConfigDict]', 'model_fields': 'ClassVar[Dict[str, FieldInfo]]', 'type': typing.Literal['object_set_material_params_pbr']}[source]

classmethod __class_getitem__(typevar_values)[source]

Return type:: type[BaseModel] | PydanticRecursiveRef

__class_vars__: ClassVar[set[str]] = {}[source]: The names of the class variables defined on the model.

__copy__()[source]

Returns a shallow copy of the model.

Return type:: Self

__deepcopy__(memo=None)[source]

Returns a deep copy of the model.

Return type:: Self

__delattr__(item)[source]

Implement delattr(self, name).

Return type:: Any

__dict__[source]

__eq__(other)[source]

Return self==value.

Return type:: bool

property __fields_set__: set[str][source]

classmethod __get_pydantic_core_schema__(source, handler, /)[source]

Hook into generating the model’s CoreSchema.

Parameters:

source (type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.
handler (GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.

Return type:

Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]

Returns:

A pydantic-core CoreSchema.

classmethod __get_pydantic_json_schema__(core_schema, handler, /)[source]

Hook into generating the model’s JSON schema.

Parameters:

core_schema (Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({'type': 'nullable', 'schema': current_schema}), or just call the handler with the original schema.
handler (GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.

Return type:

Returns:

A JSON schema, as a Python object.

__getattr__(item)[source]

Return type:: Any

__getstate__()[source]

Helper for pickle.

Return type:: dict[Any, Any]

__hash__ = None[source]

__init__(**data)[source]

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__iter__()[source]

So dict(model) works.

Return type:: Generator[Tuple[str, Any], None, None]

__module__ = 'kittycad.models.ok_modeling_cmd_response'[source]

__pretty__(fmt, **kwargs)[source]

Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.

Return type:: Generator[Any, None, None]

__private_attributes__: ClassVar[Dict[str, ModelPrivateAttr]] = {}[source]: Metadata about the private attributes of the model.

__pydantic_complete__: ClassVar[bool] = True[source]: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__: ClassVar[CoreSchema] = {'cls': <class 'kittycad.models.ok_modeling_cmd_response.OptionObjectSetMaterialParamsPbr'>, 'config': {'title': 'OptionObjectSetMaterialParamsPbr'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.ok_modeling_cmd_response.OptionObjectSetMaterialParamsPbr'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.ok_modeling_cmd_response.OptionObjectSetMaterialParamsPbr'>>]}, 'ref': 'kittycad.models.ok_modeling_cmd_response.OptionObjectSetMaterialParamsPbr:94667212924816', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'data': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.object_set_material_params_pbr.ObjectSetMaterialParamsPbr'>, 'config': {'title': 'ObjectSetMaterialParamsPbr'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.object_set_material_params_pbr.ObjectSetMaterialParamsPbr'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.object_set_material_params_pbr.ObjectSetMaterialParamsPbr'>>]}, 'ref': 'kittycad.models.object_set_material_params_pbr.ObjectSetMaterialParamsPbr:94667212370336', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {}, 'model_name': 'ObjectSetMaterialParamsPbr', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}, 'type': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': 'object_set_material_params_pbr', 'schema': {'expected': ['object_set_material_params_pbr'], 'type': 'literal'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'OptionObjectSetMaterialParamsPbr', 'type': 'model-fields'}, 'type': 'model'}[source]: The core schema of the model.

__pydantic_custom_init__: ClassVar[bool] = False[source]: Whether the model has a custom __init__ method.

__pydantic_decorators__: ClassVar[_decorators.DecoratorInfos] = DecoratorInfos(validators={}, field_validators={}, root_validators={}, field_serializers={}, model_serializers={}, model_validators={}, computed_fields={})[source]: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_extra__: dict[str, Any] | None[source]: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to 'allow'.

__pydantic_fields_set__: set[str][source]: The names of fields explicitly set during instantiation.

__pydantic_generic_metadata__: ClassVar[_generics.PydanticGenericMetadata] = {'args': (), 'origin': None, 'parameters': ()}[source]: 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.

classmethod __pydantic_init_subclass__(**kwargs)[source]

This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.

This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.

This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.

Parameters:: **kwargs (Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.
Return type:: None

__pydantic_parent_namespace__: ClassVar[Dict[str, Any] | None] = None[source]: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__: ClassVar[None | Literal['model_post_init']] = None[source]: The name of the post-init method for the model, if defined.

__pydantic_private__: dict[str, Any] | None[source]: Values of private attributes set on the model instance.

__pydantic_root_model__: ClassVar[bool] = False[source]: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__: ClassVar[SchemaSerializer] = SchemaSerializer(serializer=Model( ModelSerializer { class: Py( 0x000056196d992790, ), serializer: Fields( GeneralFieldsSerializer { fields: { "type": SerField { key_py: Py( 0x00007f903823d958, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f9034697320, ), ), serializer: Literal( LiteralSerializer { expected_int: {}, expected_str: { "object_set_material_params_pbr", }, expected_py: None, name: "literal['object_set_material_params_pbr']", }, ), }, ), ), required: true, }, "data": SerField { key_py: Py( 0x00007f9038238fa0, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196d90b1a0, ), serializer: Fields( GeneralFieldsSerializer { fields: {}, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 0, }, ), has_extra: false, root_model: false, name: "ObjectSetMaterialParamsPbr", }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "OptionObjectSetMaterialParamsPbr", }, ), definitions=[])[source]: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__: ClassVar[SchemaValidator | PluggableSchemaValidator] = SchemaValidator(title="OptionObjectSetMaterialParamsPbr", validator=Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "data", lookup_key: Simple { key: "data", py_key: Py( 0x00007f90334d4240, ), path: LookupPath( [ S( "data", Py( 0x00007f90334d4300, ), ), ], ), }, name_py: Py( 0x00007f9038238fa0, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [], model_name: "ObjectSetMaterialParamsPbr", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d90b1a0, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "ObjectSetMaterialParamsPbr", }, ), frozen: false, }, Field { name: "type", lookup_key: Simple { key: "type", py_key: Py( 0x00007f90334d4390, ), path: LookupPath( [ S( "type", Py( 0x00007f90334d44b0, ), ), ], ), }, name_py: Py( 0x00007f903823d958, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f9034697320, ), ), on_error: Raise, validator: Literal( LiteralValidator { lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "object_set_material_params_pbr": 0, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f9034697320, ), ], }, expected_repr: "'object_set_material_params_pbr'", name: "literal['object_set_material_params_pbr']", }, ), validate_default: false, copy_default: false, name: "default[literal['object_set_material_params_pbr']]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "OptionObjectSetMaterialParamsPbr", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d992790, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "OptionObjectSetMaterialParamsPbr", }, ), definitions=[], cache_strings=True)[source]: The pydantic-core SchemaValidator used to validate instances of the model.

__repr__()[source]

Return repr(self).

Return type:: str

__repr_args__()[source]

Return type:: Iterable[tuple[str | None, Any]]

__repr_name__()[source]

Name of the instance’s class, used in __repr__.

Return type:: str

__repr_str__(join_str)[source]

Return type:: str

__rich_repr__()[source]

Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.

Return type:: Iterable[Any | tuple[Any] | tuple[str, Any] | tuple[str, Any, Any]]

__setattr__(name, value)[source]

Implement setattr(self, name, value).

Return type:: None

__setstate__(state)[source]

Return type:: None

__signature__: ClassVar[Signature] = <Signature (*, data: kittycad.models.object_set_material_params_pbr.ObjectSetMaterialParamsPbr, type: Literal['object_set_material_params_pbr'] = 'object_set_material_params_pbr') -> None>[source]: The synthesized __init__ [Signature][inspect.Signature] of the model.

__slots__ = ('__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__')[source]

__str__()[source]

Return str(self).

Return type:: str

_abc_impl = <_abc._abc_data object>[source]

_calculate_keys(*args, **kwargs)[source]

Return type:: Any

_check_frozen(name, value)[source]

Return type:: None

_copy_and_set_values(*args, **kwargs)[source]

Return type:: Any

classmethod _get_value(*args, **kwargs)[source]

Return type:: Any

_iter(*args, **kwargs)[source]

Return type:: Any

classmethod construct(_fields_set=None, **values)[source]

Return type:: Self

copy(*, include=None, exclude=None, update=None, deep=False)[source]

Returns a copy of the model.

!!! warning “Deprecated”: This method is now deprecated; use model_copy instead.

If you need include or exclude, use:

`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `

Parameters:

include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.

Returns:

A copy of the model with included, excluded and updated fields as specified.

data: ObjectSetMaterialParamsPbr[source]

dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)[source]

Return type:: Dict[str, Any]

classmethod from_orm(obj)[source]

Return type:: Self

json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)[source]

Return type:: str

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}[source]: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'protected_namespaces': ()}[source]: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod model_construct(_fields_set=None, **values)[source]

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note: model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == 'allow', then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == 'ignore' (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == 'forbid' does not result in an error if extra values are passed, but they will be ignored.

Parameters:

_fields_set (set[str] | None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.
values (Any) – Trusted or pre-validated data dictionary.

Return type:

Self

Returns:

A new instance of the Model class with validated data.

model_copy(*, update=None, deep=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy

Returns a copy of the model.

Parameters:

update (dict[str, Any] | None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.
deep (bool) – Set to True to make a deep copy of the model.

Return type:

Self

Returns:

New model instance.

model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters:

mode (Union[Literal['json', 'python'], str]) – The mode in which to_python 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.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to include in the output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to exclude from the output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to use the field’s alias in the dictionary key if defined.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A dictionary representation of the model.

model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

Generates a JSON representation of the model using Pydantic’s to_json method.

Parameters:

indent (int | None) – Indentation to use in the JSON output. If None is passed, the output will be compact.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to include in the JSON output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to exclude from the JSON output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to serialize using field aliases.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A JSON string representation of the model.

property model_extra: dict[str, Any] | None[source]

Get extra fields set during validation.

Returns:: A dictionary of extra fields, or None if config.extra is not set to "allow".

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=ObjectSetMaterialParamsPbr, required=True), 'type': FieldInfo(annotation=Literal['object_set_material_params_pbr'], required=False, default='object_set_material_params_pbr')}[source]

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

property model_fields_set: set[str][source]

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,: i.e. that were not filled from defaults.

classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')[source]

Generates a JSON schema for a model class.

Parameters:

by_alias (bool) – Whether to use attribute aliases or not.
ref_template (str) – The reference template.
schema_generator (type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modifications
mode (Literal['validation', 'serialization']) – The mode in which to generate the schema.

Return type:

Returns:

The JSON schema for the given model class.

classmethod model_parametrized_name(params)[source]

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

Parameters:: params (tuple[type[Any], ...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.
Return type:: str
Returns:: String representing the new class where params are passed to cls as type variables.
Raises:: TypeError – Raised when trying to generate concrete names for non-generic models.

model_post_init(_BaseModel__context)[source]

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

Return type:: None

classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)[source]

Try to rebuild the pydantic-core schema for the model.

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.

Parameters:

force (bool) – Whether to force the rebuilding of the model schema, defaults to False.
raise_errors (bool) – Whether to raise errors, defaults to True.
_parent_namespace_depth (int) – The depth level of the parent namespace, defaults to 2.
_types_namespace (dict[str, Any] | None) – The types namespace, defaults to None.

Return type:

Returns:

Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.

classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)[source]

Validate a pydantic model instance.

Parameters:

obj (Any) – The object to validate.
strict (bool | None) – Whether to enforce types strictly.
from_attributes (bool | None) – Whether to extract data from object attributes.
context (Any | None) – Additional context to pass to the validator.

Raises:

ValidationError – If the object could not be validated.

Return type:

Self

Returns:

The validated model instance.

classmethod model_validate_json(json_data, *, strict=None, context=None)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing

Validate the given JSON data against the Pydantic model.

Parameters:

json_data (str | bytes | bytearray) – The JSON data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

Raises:

ValidationError – If json_data is not a JSON string or the object could not be validated.

classmethod model_validate_strings(obj, *, strict=None, context=None)[source]

Validate the given object with string data against the Pydantic model.

Parameters:

obj (Any) – The object containing string data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod parse_obj(obj)[source]

Return type:: Self

classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod schema(by_alias=True, ref_template='#/$defs/{model}')[source]

Return type:: Dict[str, Any]

classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)[source]

Return type:: str

type: Literal['object_set_material_params_pbr'][source]

classmethod update_forward_refs(**localns)[source]

Return type:: None

classmethod validate(value)[source]

Return type:: Self

class kittycad.models.ok_modeling_cmd_response.OptionObjectVisible(**data)[source][source]

The response to the ‘ObjectVisible’ endpoint

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__abstractmethods__ = frozenset({})[source]

__annotations__ = {'__class_vars__': 'ClassVar[set[str]]', '__private_attributes__': 'ClassVar[Dict[str, ModelPrivateAttr]]', '__pydantic_complete__': 'ClassVar[bool]', '__pydantic_core_schema__': 'ClassVar[CoreSchema]', '__pydantic_custom_init__': 'ClassVar[bool]', '__pydantic_decorators__': 'ClassVar[_decorators.DecoratorInfos]', '__pydantic_extra__': 'dict[str, Any] | None', '__pydantic_fields_set__': 'set[str]', '__pydantic_generic_metadata__': 'ClassVar[_generics.PydanticGenericMetadata]', '__pydantic_parent_namespace__': 'ClassVar[Dict[str, Any] | None]', '__pydantic_post_init__': "ClassVar[None | Literal['model_post_init']]", '__pydantic_private__': 'dict[str, Any] | None', '__pydantic_root_model__': 'ClassVar[bool]', '__pydantic_serializer__': 'ClassVar[SchemaSerializer]', '__pydantic_validator__': 'ClassVar[SchemaValidator | PluggableSchemaValidator]', '__signature__': 'ClassVar[Signature]', 'data': <class 'kittycad.models.object_visible.ObjectVisible'>, 'model_computed_fields': 'ClassVar[Dict[str, ComputedFieldInfo]]', 'model_config': 'ClassVar[ConfigDict]', 'model_fields': 'ClassVar[Dict[str, FieldInfo]]', 'type': typing.Literal['object_visible']}[source]

classmethod __class_getitem__(typevar_values)[source]

Return type:: type[BaseModel] | PydanticRecursiveRef

__class_vars__: ClassVar[set[str]] = {}[source]: The names of the class variables defined on the model.

__copy__()[source]

Returns a shallow copy of the model.

Return type:: Self

__deepcopy__(memo=None)[source]

Returns a deep copy of the model.

Return type:: Self

__delattr__(item)[source]

Implement delattr(self, name).

Return type:: Any

__dict__[source]

__eq__(other)[source]

Return self==value.

Return type:: bool

property __fields_set__: set[str][source]

classmethod __get_pydantic_core_schema__(source, handler, /)[source]

Hook into generating the model’s CoreSchema.

Parameters:

source (type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.
handler (GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.

Return type:

Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]

Returns:

A pydantic-core CoreSchema.

classmethod __get_pydantic_json_schema__(core_schema, handler, /)[source]

Hook into generating the model’s JSON schema.

Parameters:

core_schema (Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({'type': 'nullable', 'schema': current_schema}), or just call the handler with the original schema.
handler (GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.

Return type:

Returns:

A JSON schema, as a Python object.

__getattr__(item)[source]

Return type:: Any

__getstate__()[source]

Helper for pickle.

Return type:: dict[Any, Any]

__hash__ = None[source]

__init__(**data)[source]

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__iter__()[source]

So dict(model) works.

Return type:: Generator[Tuple[str, Any], None, None]

__module__ = 'kittycad.models.ok_modeling_cmd_response'[source]

__pretty__(fmt, **kwargs)[source]

Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.

Return type:: Generator[Any, None, None]

__private_attributes__: ClassVar[Dict[str, ModelPrivateAttr]] = {}[source]: Metadata about the private attributes of the model.

__pydantic_complete__: ClassVar[bool] = True[source]: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__: ClassVar[CoreSchema] = {'cls': <class 'kittycad.models.ok_modeling_cmd_response.OptionObjectVisible'>, 'config': {'title': 'OptionObjectVisible'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.ok_modeling_cmd_response.OptionObjectVisible'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.ok_modeling_cmd_response.OptionObjectVisible'>>]}, 'ref': 'kittycad.models.ok_modeling_cmd_response.OptionObjectVisible:94667212906224', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'data': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.object_visible.ObjectVisible'>, 'config': {'title': 'ObjectVisible'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.object_visible.ObjectVisible'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.object_visible.ObjectVisible'>>]}, 'ref': 'kittycad.models.object_visible.ObjectVisible:94667211064512', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {}, 'model_name': 'ObjectVisible', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}, 'type': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': 'object_visible', 'schema': {'expected': ['object_visible'], 'type': 'literal'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'OptionObjectVisible', 'type': 'model-fields'}, 'type': 'model'}[source]: The core schema of the model.

__pydantic_custom_init__: ClassVar[bool] = False[source]: Whether the model has a custom __init__ method.

__pydantic_decorators__: ClassVar[_decorators.DecoratorInfos] = DecoratorInfos(validators={}, field_validators={}, root_validators={}, field_serializers={}, model_serializers={}, model_validators={}, computed_fields={})[source]: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_extra__: dict[str, Any] | None[source]: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to 'allow'.

__pydantic_fields_set__: set[str][source]: The names of fields explicitly set during instantiation.

__pydantic_generic_metadata__: ClassVar[_generics.PydanticGenericMetadata] = {'args': (), 'origin': None, 'parameters': ()}[source]: 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.

classmethod __pydantic_init_subclass__(**kwargs)[source]

This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.

This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.

This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.

Parameters:: **kwargs (Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.
Return type:: None

__pydantic_parent_namespace__: ClassVar[Dict[str, Any] | None] = None[source]: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__: ClassVar[None | Literal['model_post_init']] = None[source]: The name of the post-init method for the model, if defined.

__pydantic_private__: dict[str, Any] | None[source]: Values of private attributes set on the model instance.

__pydantic_root_model__: ClassVar[bool] = False[source]: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__: ClassVar[SchemaSerializer] = SchemaSerializer(serializer=Model( ModelSerializer { class: Py( 0x000056196d98def0, ), serializer: Fields( GeneralFieldsSerializer { fields: { "data": SerField { key_py: Py( 0x00007f9038238fa0, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196d7cc4c0, ), serializer: Fields( GeneralFieldsSerializer { fields: {}, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 0, }, ), has_extra: false, root_model: false, name: "ObjectVisible", }, ), ), required: true, }, "type": SerField { key_py: Py( 0x00007f903823d958, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f90346e3eb0, ), ), serializer: Literal( LiteralSerializer { expected_int: {}, expected_str: { "object_visible", }, expected_py: None, name: "literal['object_visible']", }, ), }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "OptionObjectVisible", }, ), definitions=[])[source]: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__: ClassVar[SchemaValidator | PluggableSchemaValidator] = SchemaValidator(title="OptionObjectVisible", validator=Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "data", lookup_key: Simple { key: "data", py_key: Py( 0x00007f90334d53b0, ), path: LookupPath( [ S( "data", Py( 0x00007f90334d5470, ), ), ], ), }, name_py: Py( 0x00007f9038238fa0, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [], model_name: "ObjectVisible", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d7cc4c0, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "ObjectVisible", }, ), frozen: false, }, Field { name: "type", lookup_key: Simple { key: "type", py_key: Py( 0x00007f90334d5410, ), path: LookupPath( [ S( "type", Py( 0x00007f90334d5350, ), ), ], ), }, name_py: Py( 0x00007f903823d958, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f90346e3eb0, ), ), on_error: Raise, validator: Literal( LiteralValidator { lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "object_visible": 0, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f90346e3eb0, ), ], }, expected_repr: "'object_visible'", name: "literal['object_visible']", }, ), validate_default: false, copy_default: false, name: "default[literal['object_visible']]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "OptionObjectVisible", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d98def0, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "OptionObjectVisible", }, ), definitions=[], cache_strings=True)[source]: The pydantic-core SchemaValidator used to validate instances of the model.

__repr__()[source]

Return repr(self).

Return type:: str

__repr_args__()[source]

Return type:: Iterable[tuple[str | None, Any]]

__repr_name__()[source]

Name of the instance’s class, used in __repr__.

Return type:: str

__repr_str__(join_str)[source]

Return type:: str

__rich_repr__()[source]

Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.

Return type:: Iterable[Any | tuple[Any] | tuple[str, Any] | tuple[str, Any, Any]]

__setattr__(name, value)[source]

Implement setattr(self, name, value).

Return type:: None

__setstate__(state)[source]

Return type:: None

__signature__: ClassVar[Signature] = <Signature (*, data: kittycad.models.object_visible.ObjectVisible, type: Literal['object_visible'] = 'object_visible') -> None>[source]: The synthesized __init__ [Signature][inspect.Signature] of the model.

__slots__ = ('__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__')[source]

__str__()[source]

Return str(self).

Return type:: str

_abc_impl = <_abc._abc_data object>[source]

_calculate_keys(*args, **kwargs)[source]

Return type:: Any

_check_frozen(name, value)[source]

Return type:: None

_copy_and_set_values(*args, **kwargs)[source]

Return type:: Any

classmethod _get_value(*args, **kwargs)[source]

Return type:: Any

_iter(*args, **kwargs)[source]

Return type:: Any

classmethod construct(_fields_set=None, **values)[source]

Return type:: Self

copy(*, include=None, exclude=None, update=None, deep=False)[source]

Returns a copy of the model.

!!! warning “Deprecated”: This method is now deprecated; use model_copy instead.

If you need include or exclude, use:

`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `

Parameters:

include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.

Returns:

A copy of the model with included, excluded and updated fields as specified.

data: ObjectVisible[source]

dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)[source]

Return type:: Dict[str, Any]

classmethod from_orm(obj)[source]

Return type:: Self

json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)[source]

Return type:: str

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}[source]: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'protected_namespaces': ()}[source]: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod model_construct(_fields_set=None, **values)[source]

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note: model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == 'allow', then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == 'ignore' (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == 'forbid' does not result in an error if extra values are passed, but they will be ignored.

Parameters:

_fields_set (set[str] | None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.
values (Any) – Trusted or pre-validated data dictionary.

Return type:

Self

Returns:

A new instance of the Model class with validated data.

model_copy(*, update=None, deep=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy

Returns a copy of the model.

Parameters:

update (dict[str, Any] | None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.
deep (bool) – Set to True to make a deep copy of the model.

Return type:

Self

Returns:

New model instance.

model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters:

mode (Union[Literal['json', 'python'], str]) – The mode in which to_python 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.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to include in the output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to exclude from the output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to use the field’s alias in the dictionary key if defined.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A dictionary representation of the model.

model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

Generates a JSON representation of the model using Pydantic’s to_json method.

Parameters:

indent (int | None) – Indentation to use in the JSON output. If None is passed, the output will be compact.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to include in the JSON output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to exclude from the JSON output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to serialize using field aliases.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A JSON string representation of the model.

property model_extra: dict[str, Any] | None[source]

Get extra fields set during validation.

Returns:: A dictionary of extra fields, or None if config.extra is not set to "allow".

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=ObjectVisible, required=True), 'type': FieldInfo(annotation=Literal['object_visible'], required=False, default='object_visible')}[source]

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

property model_fields_set: set[str][source]

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,: i.e. that were not filled from defaults.

classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')[source]

Generates a JSON schema for a model class.

Parameters:

by_alias (bool) – Whether to use attribute aliases or not.
ref_template (str) – The reference template.
schema_generator (type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modifications
mode (Literal['validation', 'serialization']) – The mode in which to generate the schema.

Return type:

Returns:

The JSON schema for the given model class.

classmethod model_parametrized_name(params)[source]

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

Parameters:: params (tuple[type[Any], ...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.
Return type:: str
Returns:: String representing the new class where params are passed to cls as type variables.
Raises:: TypeError – Raised when trying to generate concrete names for non-generic models.

model_post_init(_BaseModel__context)[source]

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

Return type:: None

classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)[source]

Try to rebuild the pydantic-core schema for the model.

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.

Parameters:

force (bool) – Whether to force the rebuilding of the model schema, defaults to False.
raise_errors (bool) – Whether to raise errors, defaults to True.
_parent_namespace_depth (int) – The depth level of the parent namespace, defaults to 2.
_types_namespace (dict[str, Any] | None) – The types namespace, defaults to None.

Return type:

Returns:

Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.

classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)[source]

Validate a pydantic model instance.

Parameters:

obj (Any) – The object to validate.
strict (bool | None) – Whether to enforce types strictly.
from_attributes (bool | None) – Whether to extract data from object attributes.
context (Any | None) – Additional context to pass to the validator.

Raises:

ValidationError – If the object could not be validated.

Return type:

Self

Returns:

The validated model instance.

classmethod model_validate_json(json_data, *, strict=None, context=None)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing

Validate the given JSON data against the Pydantic model.

Parameters:

json_data (str | bytes | bytearray) – The JSON data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

Raises:

ValidationError – If json_data is not a JSON string or the object could not be validated.

classmethod model_validate_strings(obj, *, strict=None, context=None)[source]

Validate the given object with string data against the Pydantic model.

Parameters:

obj (Any) – The object containing string data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod parse_obj(obj)[source]

Return type:: Self

classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod schema(by_alias=True, ref_template='#/$defs/{model}')[source]

Return type:: Dict[str, Any]

classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)[source]

Return type:: str

type: Literal['object_visible'][source]

classmethod update_forward_refs(**localns)[source]

Return type:: None

classmethod validate(value)[source]

Return type:: Self

class kittycad.models.ok_modeling_cmd_response.OptionPathGetCurveUuid(**data)[source][source]

The response to the ‘PathGetCurveUuid’ endpoint

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__abstractmethods__ = frozenset({})[source]

__annotations__ = {'__class_vars__': 'ClassVar[set[str]]', '__private_attributes__': 'ClassVar[Dict[str, ModelPrivateAttr]]', '__pydantic_complete__': 'ClassVar[bool]', '__pydantic_core_schema__': 'ClassVar[CoreSchema]', '__pydantic_custom_init__': 'ClassVar[bool]', '__pydantic_decorators__': 'ClassVar[_decorators.DecoratorInfos]', '__pydantic_extra__': 'dict[str, Any] | None', '__pydantic_fields_set__': 'set[str]', '__pydantic_generic_metadata__': 'ClassVar[_generics.PydanticGenericMetadata]', '__pydantic_parent_namespace__': 'ClassVar[Dict[str, Any] | None]', '__pydantic_post_init__': "ClassVar[None | Literal['model_post_init']]", '__pydantic_private__': 'dict[str, Any] | None', '__pydantic_root_model__': 'ClassVar[bool]', '__pydantic_serializer__': 'ClassVar[SchemaSerializer]', '__pydantic_validator__': 'ClassVar[SchemaValidator | PluggableSchemaValidator]', '__signature__': 'ClassVar[Signature]', 'data': <class 'kittycad.models.path_get_curve_uuid.PathGetCurveUuid'>, 'model_computed_fields': 'ClassVar[Dict[str, ComputedFieldInfo]]', 'model_config': 'ClassVar[ConfigDict]', 'model_fields': 'ClassVar[Dict[str, FieldInfo]]', 'type': typing.Literal['path_get_curve_uuid']}[source]

classmethod __class_getitem__(typevar_values)[source]

Return type:: type[BaseModel] | PydanticRecursiveRef

__class_vars__: ClassVar[set[str]] = {}[source]: The names of the class variables defined on the model.

__copy__()[source]

Returns a shallow copy of the model.

Return type:: Self

__deepcopy__(memo=None)[source]

Returns a deep copy of the model.

Return type:: Self

__delattr__(item)[source]

Implement delattr(self, name).

Return type:: Any

__dict__[source]

__eq__(other)[source]

Return self==value.

Return type:: bool

property __fields_set__: set[str][source]

classmethod __get_pydantic_core_schema__(source, handler, /)[source]

Hook into generating the model’s CoreSchema.

Parameters:

source (type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.
handler (GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.

Return type:

Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]

Returns:

A pydantic-core CoreSchema.

classmethod __get_pydantic_json_schema__(core_schema, handler, /)[source]

Hook into generating the model’s JSON schema.

Parameters:

core_schema (Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({'type': 'nullable', 'schema': current_schema}), or just call the handler with the original schema.
handler (GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.

Return type:

Returns:

A JSON schema, as a Python object.

__getattr__(item)[source]

Return type:: Any

__getstate__()[source]

Helper for pickle.

Return type:: dict[Any, Any]

__hash__ = None[source]

__init__(**data)[source]

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__iter__()[source]

So dict(model) works.

Return type:: Generator[Tuple[str, Any], None, None]

__module__ = 'kittycad.models.ok_modeling_cmd_response'[source]

__pretty__(fmt, **kwargs)[source]

Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.

Return type:: Generator[Any, None, None]

__private_attributes__: ClassVar[Dict[str, ModelPrivateAttr]] = {}[source]: Metadata about the private attributes of the model.

__pydantic_complete__: ClassVar[bool] = True[source]: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__: ClassVar[CoreSchema] = {'cls': <class 'kittycad.models.ok_modeling_cmd_response.OptionPathGetCurveUuid'>, 'config': {'title': 'OptionPathGetCurveUuid'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.ok_modeling_cmd_response.OptionPathGetCurveUuid'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.ok_modeling_cmd_response.OptionPathGetCurveUuid'>>]}, 'ref': 'kittycad.models.ok_modeling_cmd_response.OptionPathGetCurveUuid:94667213769888', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'data': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.path_get_curve_uuid.PathGetCurveUuid'>, 'config': {'title': 'PathGetCurveUuid'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.path_get_curve_uuid.PathGetCurveUuid'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.path_get_curve_uuid.PathGetCurveUuid'>>]}, 'ref': 'kittycad.models.path_get_curve_uuid.PathGetCurveUuid:94667211080064', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'curve_id': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'type': 'str'}, 'type': 'model-field'}}, 'model_name': 'PathGetCurveUuid', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}, 'type': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': 'path_get_curve_uuid', 'schema': {'expected': ['path_get_curve_uuid'], 'type': 'literal'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'OptionPathGetCurveUuid', 'type': 'model-fields'}, 'type': 'model'}[source]: The core schema of the model.

__pydantic_custom_init__: ClassVar[bool] = False[source]: Whether the model has a custom __init__ method.

__pydantic_decorators__: ClassVar[_decorators.DecoratorInfos] = DecoratorInfos(validators={}, field_validators={}, root_validators={}, field_serializers={}, model_serializers={}, model_validators={}, computed_fields={})[source]: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_extra__: dict[str, Any] | None[source]: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to 'allow'.

__pydantic_fields_set__: set[str][source]: The names of fields explicitly set during instantiation.

__pydantic_generic_metadata__: ClassVar[_generics.PydanticGenericMetadata] = {'args': (), 'origin': None, 'parameters': ()}[source]: 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.

classmethod __pydantic_init_subclass__(**kwargs)[source]

This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.

This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.

This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.

Parameters:: **kwargs (Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.
Return type:: None

__pydantic_parent_namespace__: ClassVar[Dict[str, Any] | None] = None[source]: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__: ClassVar[None | Literal['model_post_init']] = None[source]: The name of the post-init method for the model, if defined.

__pydantic_private__: dict[str, Any] | None[source]: Values of private attributes set on the model instance.

__pydantic_root_model__: ClassVar[bool] = False[source]: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__: ClassVar[SchemaSerializer] = SchemaSerializer(serializer=Model( ModelSerializer { class: Py( 0x000056196da60ca0, ), serializer: Fields( GeneralFieldsSerializer { fields: { "type": SerField { key_py: Py( 0x00007f903823d958, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f90346e4770, ), ), serializer: Literal( LiteralSerializer { expected_int: {}, expected_str: { "path_get_curve_uuid", }, expected_py: None, name: "literal['path_get_curve_uuid']", }, ), }, ), ), required: true, }, "data": SerField { key_py: Py( 0x00007f9038238fa0, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196d7d0180, ), serializer: Fields( GeneralFieldsSerializer { fields: { "curve_id": SerField { key_py: Py( 0x00007f90339660f0, ), alias: None, alias_py: None, serializer: Some( Str( StrSerializer, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 1, }, ), has_extra: false, root_model: false, name: "PathGetCurveUuid", }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "OptionPathGetCurveUuid", }, ), definitions=[])[source]: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__: ClassVar[SchemaValidator | PluggableSchemaValidator] = SchemaValidator(title="OptionPathGetCurveUuid", validator=Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "data", lookup_key: Simple { key: "data", py_key: Py( 0x00007f903336e490, ), path: LookupPath( [ S( "data", Py( 0x00007f903336e820, ), ), ], ), }, name_py: Py( 0x00007f9038238fa0, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "curve_id", lookup_key: Simple { key: "curve_id", py_key: Py( 0x00007f90333933b0, ), path: LookupPath( [ S( "curve_id", Py( 0x00007f90333931f0, ), ), ], ), }, name_py: Py( 0x00007f90339660f0, ), validator: Str( StrValidator { strict: false, coerce_numbers_to_str: false, }, ), frozen: false, }, ], model_name: "PathGetCurveUuid", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d7d0180, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "PathGetCurveUuid", }, ), frozen: false, }, Field { name: "type", lookup_key: Simple { key: "type", py_key: Py( 0x00007f903336e550, ), path: LookupPath( [ S( "type", Py( 0x00007f903336e580, ), ), ], ), }, name_py: Py( 0x00007f903823d958, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f90346e4770, ), ), on_error: Raise, validator: Literal( LiteralValidator { lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "path_get_curve_uuid": 0, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f90346e4770, ), ], }, expected_repr: "'path_get_curve_uuid'", name: "literal['path_get_curve_uuid']", }, ), validate_default: false, copy_default: false, name: "default[literal['path_get_curve_uuid']]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "OptionPathGetCurveUuid", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196da60ca0, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "OptionPathGetCurveUuid", }, ), definitions=[], cache_strings=True)[source]: The pydantic-core SchemaValidator used to validate instances of the model.

__repr__()[source]

Return repr(self).

Return type:: str

__repr_args__()[source]

Return type:: Iterable[tuple[str | None, Any]]

__repr_name__()[source]

Name of the instance’s class, used in __repr__.

Return type:: str

__repr_str__(join_str)[source]

Return type:: str

__rich_repr__()[source]

Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.

Return type:: Iterable[Any | tuple[Any] | tuple[str, Any] | tuple[str, Any, Any]]

__setattr__(name, value)[source]

Implement setattr(self, name, value).

Return type:: None

__setstate__(state)[source]

Return type:: None

__signature__: ClassVar[Signature] = <Signature (*, data: kittycad.models.path_get_curve_uuid.PathGetCurveUuid, type: Literal['path_get_curve_uuid'] = 'path_get_curve_uuid') -> None>[source]: The synthesized __init__ [Signature][inspect.Signature] of the model.

__slots__ = ('__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__')[source]

__str__()[source]

Return str(self).

Return type:: str

_abc_impl = <_abc._abc_data object>[source]

_calculate_keys(*args, **kwargs)[source]

Return type:: Any

_check_frozen(name, value)[source]

Return type:: None

_copy_and_set_values(*args, **kwargs)[source]

Return type:: Any

classmethod _get_value(*args, **kwargs)[source]

Return type:: Any

_iter(*args, **kwargs)[source]

Return type:: Any

classmethod construct(_fields_set=None, **values)[source]

Return type:: Self

copy(*, include=None, exclude=None, update=None, deep=False)[source]

Returns a copy of the model.

!!! warning “Deprecated”: This method is now deprecated; use model_copy instead.

If you need include or exclude, use:

`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `

Parameters:

include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.

Returns:

A copy of the model with included, excluded and updated fields as specified.

data: PathGetCurveUuid[source]

dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)[source]

Return type:: Dict[str, Any]

classmethod from_orm(obj)[source]

Return type:: Self

json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)[source]

Return type:: str

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}[source]: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'protected_namespaces': ()}[source]: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod model_construct(_fields_set=None, **values)[source]

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note: model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == 'allow', then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == 'ignore' (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == 'forbid' does not result in an error if extra values are passed, but they will be ignored.

Parameters:

_fields_set (set[str] | None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.
values (Any) – Trusted or pre-validated data dictionary.

Return type:

Self

Returns:

A new instance of the Model class with validated data.

model_copy(*, update=None, deep=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy

Returns a copy of the model.

Parameters:

update (dict[str, Any] | None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.
deep (bool) – Set to True to make a deep copy of the model.

Return type:

Self

Returns:

New model instance.

model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters:

mode (Union[Literal['json', 'python'], str]) – The mode in which to_python 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.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to include in the output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to exclude from the output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to use the field’s alias in the dictionary key if defined.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A dictionary representation of the model.

model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

Generates a JSON representation of the model using Pydantic’s to_json method.

Parameters:

indent (int | None) – Indentation to use in the JSON output. If None is passed, the output will be compact.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to include in the JSON output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to exclude from the JSON output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to serialize using field aliases.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A JSON string representation of the model.

property model_extra: dict[str, Any] | None[source]

Get extra fields set during validation.

Returns:: A dictionary of extra fields, or None if config.extra is not set to "allow".

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=PathGetCurveUuid, required=True), 'type': FieldInfo(annotation=Literal['path_get_curve_uuid'], required=False, default='path_get_curve_uuid')}[source]

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

property model_fields_set: set[str][source]

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,: i.e. that were not filled from defaults.

classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')[source]

Generates a JSON schema for a model class.

Parameters:

by_alias (bool) – Whether to use attribute aliases or not.
ref_template (str) – The reference template.
schema_generator (type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modifications
mode (Literal['validation', 'serialization']) – The mode in which to generate the schema.

Return type:

Returns:

The JSON schema for the given model class.

classmethod model_parametrized_name(params)[source]

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

Parameters:: params (tuple[type[Any], ...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.
Return type:: str
Returns:: String representing the new class where params are passed to cls as type variables.
Raises:: TypeError – Raised when trying to generate concrete names for non-generic models.

model_post_init(_BaseModel__context)[source]

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

Return type:: None

classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)[source]

Try to rebuild the pydantic-core schema for the model.

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.

Parameters:

force (bool) – Whether to force the rebuilding of the model schema, defaults to False.
raise_errors (bool) – Whether to raise errors, defaults to True.
_parent_namespace_depth (int) – The depth level of the parent namespace, defaults to 2.
_types_namespace (dict[str, Any] | None) – The types namespace, defaults to None.

Return type:

Returns:

Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.

classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)[source]

Validate a pydantic model instance.

Parameters:

obj (Any) – The object to validate.
strict (bool | None) – Whether to enforce types strictly.
from_attributes (bool | None) – Whether to extract data from object attributes.
context (Any | None) – Additional context to pass to the validator.

Raises:

ValidationError – If the object could not be validated.

Return type:

Self

Returns:

The validated model instance.

classmethod model_validate_json(json_data, *, strict=None, context=None)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing

Validate the given JSON data against the Pydantic model.

Parameters:

json_data (str | bytes | bytearray) – The JSON data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

Raises:

ValidationError – If json_data is not a JSON string or the object could not be validated.

classmethod model_validate_strings(obj, *, strict=None, context=None)[source]

Validate the given object with string data against the Pydantic model.

Parameters:

obj (Any) – The object containing string data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod parse_obj(obj)[source]

Return type:: Self

classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod schema(by_alias=True, ref_template='#/$defs/{model}')[source]

Return type:: Dict[str, Any]

classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)[source]

Return type:: str

type: Literal['path_get_curve_uuid'][source]

classmethod update_forward_refs(**localns)[source]

Return type:: None

classmethod validate(value)[source]

Return type:: Self

class kittycad.models.ok_modeling_cmd_response.OptionPathGetCurveUuidsForVertices(**data)[source][source]

The response to the ‘PathGetCurveUuidsForVertices’ endpoint

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__abstractmethods__ = frozenset({})[source]

__annotations__ = {'__class_vars__': 'ClassVar[set[str]]', '__private_attributes__': 'ClassVar[Dict[str, ModelPrivateAttr]]', '__pydantic_complete__': 'ClassVar[bool]', '__pydantic_core_schema__': 'ClassVar[CoreSchema]', '__pydantic_custom_init__': 'ClassVar[bool]', '__pydantic_decorators__': 'ClassVar[_decorators.DecoratorInfos]', '__pydantic_extra__': 'dict[str, Any] | None', '__pydantic_fields_set__': 'set[str]', '__pydantic_generic_metadata__': 'ClassVar[_generics.PydanticGenericMetadata]', '__pydantic_parent_namespace__': 'ClassVar[Dict[str, Any] | None]', '__pydantic_post_init__': "ClassVar[None | Literal['model_post_init']]", '__pydantic_private__': 'dict[str, Any] | None', '__pydantic_root_model__': 'ClassVar[bool]', '__pydantic_serializer__': 'ClassVar[SchemaSerializer]', '__pydantic_validator__': 'ClassVar[SchemaValidator | PluggableSchemaValidator]', '__signature__': 'ClassVar[Signature]', 'data': <class 'kittycad.models.path_get_curve_uuids_for_vertices.PathGetCurveUuidsForVertices'>, 'model_computed_fields': 'ClassVar[Dict[str, ComputedFieldInfo]]', 'model_config': 'ClassVar[ConfigDict]', 'model_fields': 'ClassVar[Dict[str, FieldInfo]]', 'type': typing.Literal['path_get_curve_uuids_for_vertices']}[source]

classmethod __class_getitem__(typevar_values)[source]

Return type:: type[BaseModel] | PydanticRecursiveRef

__class_vars__: ClassVar[set[str]] = {}[source]: The names of the class variables defined on the model.

__copy__()[source]

Returns a shallow copy of the model.

Return type:: Self

__deepcopy__(memo=None)[source]

Returns a deep copy of the model.

Return type:: Self

__delattr__(item)[source]

Implement delattr(self, name).

Return type:: Any

__dict__[source]

__eq__(other)[source]

Return self==value.

Return type:: bool

property __fields_set__: set[str][source]

classmethod __get_pydantic_core_schema__(source, handler, /)[source]

Hook into generating the model’s CoreSchema.

Parameters:

source (type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.
handler (GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.

Return type:

Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]

Returns:

A pydantic-core CoreSchema.

classmethod __get_pydantic_json_schema__(core_schema, handler, /)[source]

Hook into generating the model’s JSON schema.

Parameters:

core_schema (Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({'type': 'nullable', 'schema': current_schema}), or just call the handler with the original schema.
handler (GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.

Return type:

Returns:

A JSON schema, as a Python object.

__getattr__(item)[source]

Return type:: Any

__getstate__()[source]

Helper for pickle.

Return type:: dict[Any, Any]

__hash__ = None[source]

__init__(**data)[source]

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__iter__()[source]

So dict(model) works.

Return type:: Generator[Tuple[str, Any], None, None]

__module__ = 'kittycad.models.ok_modeling_cmd_response'[source]

__pretty__(fmt, **kwargs)[source]

Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.

Return type:: Generator[Any, None, None]

__private_attributes__: ClassVar[Dict[str, ModelPrivateAttr]] = {}[source]: Metadata about the private attributes of the model.

__pydantic_complete__: ClassVar[bool] = True[source]: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__: ClassVar[CoreSchema] = {'cls': <class 'kittycad.models.ok_modeling_cmd_response.OptionPathGetCurveUuidsForVertices'>, 'config': {'title': 'OptionPathGetCurveUuidsForVertices'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.ok_modeling_cmd_response.OptionPathGetCurveUuidsForVertices'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.ok_modeling_cmd_response.OptionPathGetCurveUuidsForVertices'>>]}, 'ref': 'kittycad.models.ok_modeling_cmd_response.OptionPathGetCurveUuidsForVertices:94667213753744', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'data': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.path_get_curve_uuids_for_vertices.PathGetCurveUuidsForVertices'>, 'config': {'title': 'PathGetCurveUuidsForVertices'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.path_get_curve_uuids_for_vertices.PathGetCurveUuidsForVertices'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.path_get_curve_uuids_for_vertices.PathGetCurveUuidsForVertices'>>]}, 'ref': 'kittycad.models.path_get_curve_uuids_for_vertices.PathGetCurveUuidsForVertices:94667211083984', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'curve_ids': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'items_schema': {'type': 'str'}, 'type': 'list'}, 'type': 'model-field'}}, 'model_name': 'PathGetCurveUuidsForVertices', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}, 'type': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': 'path_get_curve_uuids_for_vertices', 'schema': {'expected': ['path_get_curve_uuids_for_vertices'], 'type': 'literal'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'OptionPathGetCurveUuidsForVertices', 'type': 'model-fields'}, 'type': 'model'}[source]: The core schema of the model.

__pydantic_custom_init__: ClassVar[bool] = False[source]: Whether the model has a custom __init__ method.

__pydantic_decorators__: ClassVar[_decorators.DecoratorInfos] = DecoratorInfos(validators={}, field_validators={}, root_validators={}, field_serializers={}, model_serializers={}, model_validators={}, computed_fields={})[source]: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_extra__: dict[str, Any] | None[source]: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to 'allow'.

__pydantic_fields_set__: set[str][source]: The names of fields explicitly set during instantiation.

__pydantic_generic_metadata__: ClassVar[_generics.PydanticGenericMetadata] = {'args': (), 'origin': None, 'parameters': ()}[source]: 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.

classmethod __pydantic_init_subclass__(**kwargs)[source]

This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.

This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.

This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.

Parameters:: **kwargs (Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.
Return type:: None

__pydantic_parent_namespace__: ClassVar[Dict[str, Any] | None] = None[source]: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__: ClassVar[None | Literal['model_post_init']] = None[source]: The name of the post-init method for the model, if defined.

__pydantic_private__: dict[str, Any] | None[source]: Values of private attributes set on the model instance.

__pydantic_root_model__: ClassVar[bool] = False[source]: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__: ClassVar[SchemaSerializer] = SchemaSerializer(serializer=Model( ModelSerializer { class: Py( 0x000056196da5cd90, ), serializer: Fields( GeneralFieldsSerializer { fields: { "type": SerField { key_py: Py( 0x00007f903823d958, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f90346975f0, ), ), serializer: Literal( LiteralSerializer { expected_int: {}, expected_str: { "path_get_curve_uuids_for_vertices", }, expected_py: None, name: "literal['path_get_curve_uuids_for_vertices']", }, ), }, ), ), required: true, }, "data": SerField { key_py: Py( 0x00007f9038238fa0, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196d7d10d0, ), serializer: Fields( GeneralFieldsSerializer { fields: { "curve_ids": SerField { key_py: Py( 0x00007f903352fd70, ), alias: None, alias_py: None, serializer: Some( List( ListSerializer { item_serializer: Str( StrSerializer, ), filter: SchemaFilter { include: None, exclude: None, }, name: "list[str]", }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 1, }, ), has_extra: false, root_model: false, name: "PathGetCurveUuidsForVertices", }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "OptionPathGetCurveUuidsForVertices", }, ), definitions=[])[source]: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__: ClassVar[SchemaValidator | PluggableSchemaValidator] = SchemaValidator(title="OptionPathGetCurveUuidsForVertices", validator=Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "data", lookup_key: Simple { key: "data", py_key: Py( 0x00007f903336f480, ), path: LookupPath( [ S( "data", Py( 0x00007f903336f4e0, ), ), ], ), }, name_py: Py( 0x00007f9038238fa0, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "curve_ids", lookup_key: Simple { key: "curve_ids", py_key: Py( 0x00007f90333a31b0, ), path: LookupPath( [ S( "curve_ids", Py( 0x00007f90333a2fb0, ), ), ], ), }, name_py: Py( 0x00007f903352fd70, ), validator: List( ListValidator { strict: false, item_validator: Some( Str( StrValidator { strict: false, coerce_numbers_to_str: false, }, ), ), min_length: None, max_length: None, name: OnceLock( <uninit>, ), fail_fast: false, }, ), frozen: false, }, ], model_name: "PathGetCurveUuidsForVertices", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d7d10d0, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "PathGetCurveUuidsForVertices", }, ), frozen: false, }, Field { name: "type", lookup_key: Simple { key: "type", py_key: Py( 0x00007f903336f4b0, ), path: LookupPath( [ S( "type", Py( 0x00007f903336f600, ), ), ], ), }, name_py: Py( 0x00007f903823d958, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f90346975f0, ), ), on_error: Raise, validator: Literal( LiteralValidator { lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "path_get_curve_uuids_for_vertices": 0, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f90346975f0, ), ], }, expected_repr: "'path_get_curve_uuids_for_vertices'", name: "literal['path_get_curve_uuids_for_vertices']", }, ), validate_default: false, copy_default: false, name: "default[literal['path_get_curve_uuids_for_vertices']]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "OptionPathGetCurveUuidsForVertices", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196da5cd90, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "OptionPathGetCurveUuidsForVertices", }, ), definitions=[], cache_strings=True)[source]: The pydantic-core SchemaValidator used to validate instances of the model.

__repr__()[source]

Return repr(self).

Return type:: str

__repr_args__()[source]

Return type:: Iterable[tuple[str | None, Any]]

__repr_name__()[source]

Name of the instance’s class, used in __repr__.

Return type:: str

__repr_str__(join_str)[source]

Return type:: str

__rich_repr__()[source]

Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.

Return type:: Iterable[Any | tuple[Any] | tuple[str, Any] | tuple[str, Any, Any]]

__setattr__(name, value)[source]

Implement setattr(self, name, value).

Return type:: None

__setstate__(state)[source]

Return type:: None

__signature__: ClassVar[Signature] = <Signature (*, data: kittycad.models.path_get_curve_uuids_for_vertices.PathGetCurveUuidsForVertices, type: Literal['path_get_curve_uuids_for_vertices'] = 'path_get_curve_uuids_for_vertices') -> None>[source]: The synthesized __init__ [Signature][inspect.Signature] of the model.

__slots__ = ('__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__')[source]

__str__()[source]

Return str(self).

Return type:: str

_abc_impl = <_abc._abc_data object>[source]

_calculate_keys(*args, **kwargs)[source]

Return type:: Any

_check_frozen(name, value)[source]

Return type:: None

_copy_and_set_values(*args, **kwargs)[source]

Return type:: Any

classmethod _get_value(*args, **kwargs)[source]

Return type:: Any

_iter(*args, **kwargs)[source]

Return type:: Any

classmethod construct(_fields_set=None, **values)[source]

Return type:: Self

copy(*, include=None, exclude=None, update=None, deep=False)[source]

Returns a copy of the model.

!!! warning “Deprecated”: This method is now deprecated; use model_copy instead.

If you need include or exclude, use:

`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `

Parameters:

include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.

Returns:

A copy of the model with included, excluded and updated fields as specified.

data: PathGetCurveUuidsForVertices[source]

dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)[source]

Return type:: Dict[str, Any]

classmethod from_orm(obj)[source]

Return type:: Self

json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)[source]

Return type:: str

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}[source]: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'protected_namespaces': ()}[source]: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod model_construct(_fields_set=None, **values)[source]

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note: model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == 'allow', then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == 'ignore' (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == 'forbid' does not result in an error if extra values are passed, but they will be ignored.

Parameters:

_fields_set (set[str] | None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.
values (Any) – Trusted or pre-validated data dictionary.

Return type:

Self

Returns:

A new instance of the Model class with validated data.

model_copy(*, update=None, deep=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy

Returns a copy of the model.

Parameters:

update (dict[str, Any] | None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.
deep (bool) – Set to True to make a deep copy of the model.

Return type:

Self

Returns:

New model instance.

model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters:

mode (Union[Literal['json', 'python'], str]) – The mode in which to_python 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.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to include in the output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to exclude from the output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to use the field’s alias in the dictionary key if defined.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A dictionary representation of the model.

model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

Generates a JSON representation of the model using Pydantic’s to_json method.

Parameters:

indent (int | None) – Indentation to use in the JSON output. If None is passed, the output will be compact.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to include in the JSON output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to exclude from the JSON output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to serialize using field aliases.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A JSON string representation of the model.

property model_extra: dict[str, Any] | None[source]

Get extra fields set during validation.

Returns:: A dictionary of extra fields, or None if config.extra is not set to "allow".

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=PathGetCurveUuidsForVertices, required=True), 'type': FieldInfo(annotation=Literal['path_get_curve_uuids_for_vertices'], required=False, default='path_get_curve_uuids_for_vertices')}[source]

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

property model_fields_set: set[str][source]

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,: i.e. that were not filled from defaults.

classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')[source]

Generates a JSON schema for a model class.

Parameters:

by_alias (bool) – Whether to use attribute aliases or not.
ref_template (str) – The reference template.
schema_generator (type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modifications
mode (Literal['validation', 'serialization']) – The mode in which to generate the schema.

Return type:

Returns:

The JSON schema for the given model class.

classmethod model_parametrized_name(params)[source]

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

Parameters:: params (tuple[type[Any], ...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.
Return type:: str
Returns:: String representing the new class where params are passed to cls as type variables.
Raises:: TypeError – Raised when trying to generate concrete names for non-generic models.

model_post_init(_BaseModel__context)[source]

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

Return type:: None

classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)[source]

Try to rebuild the pydantic-core schema for the model.

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.

Parameters:

force (bool) – Whether to force the rebuilding of the model schema, defaults to False.
raise_errors (bool) – Whether to raise errors, defaults to True.
_parent_namespace_depth (int) – The depth level of the parent namespace, defaults to 2.
_types_namespace (dict[str, Any] | None) – The types namespace, defaults to None.

Return type:

Returns:

Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.

classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)[source]

Validate a pydantic model instance.

Parameters:

obj (Any) – The object to validate.
strict (bool | None) – Whether to enforce types strictly.
from_attributes (bool | None) – Whether to extract data from object attributes.
context (Any | None) – Additional context to pass to the validator.

Raises:

ValidationError – If the object could not be validated.

Return type:

Self

Returns:

The validated model instance.

classmethod model_validate_json(json_data, *, strict=None, context=None)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing

Validate the given JSON data against the Pydantic model.

Parameters:

json_data (str | bytes | bytearray) – The JSON data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

Raises:

ValidationError – If json_data is not a JSON string or the object could not be validated.

classmethod model_validate_strings(obj, *, strict=None, context=None)[source]

Validate the given object with string data against the Pydantic model.

Parameters:

obj (Any) – The object containing string data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod parse_obj(obj)[source]

Return type:: Self

classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod schema(by_alias=True, ref_template='#/$defs/{model}')[source]

Return type:: Dict[str, Any]

classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)[source]

Return type:: str

type: Literal['path_get_curve_uuids_for_vertices'][source]

classmethod update_forward_refs(**localns)[source]

Return type:: None

classmethod validate(value)[source]

Return type:: Self

class kittycad.models.ok_modeling_cmd_response.OptionPathGetInfo(**data)[source][source]

The response to the ‘PathGetInfo’ endpoint

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__abstractmethods__ = frozenset({})[source]

__annotations__ = {'__class_vars__': 'ClassVar[set[str]]', '__private_attributes__': 'ClassVar[Dict[str, ModelPrivateAttr]]', '__pydantic_complete__': 'ClassVar[bool]', '__pydantic_core_schema__': 'ClassVar[CoreSchema]', '__pydantic_custom_init__': 'ClassVar[bool]', '__pydantic_decorators__': 'ClassVar[_decorators.DecoratorInfos]', '__pydantic_extra__': 'dict[str, Any] | None', '__pydantic_fields_set__': 'set[str]', '__pydantic_generic_metadata__': 'ClassVar[_generics.PydanticGenericMetadata]', '__pydantic_parent_namespace__': 'ClassVar[Dict[str, Any] | None]', '__pydantic_post_init__': "ClassVar[None | Literal['model_post_init']]", '__pydantic_private__': 'dict[str, Any] | None', '__pydantic_root_model__': 'ClassVar[bool]', '__pydantic_serializer__': 'ClassVar[SchemaSerializer]', '__pydantic_validator__': 'ClassVar[SchemaValidator | PluggableSchemaValidator]', '__signature__': 'ClassVar[Signature]', 'data': <class 'kittycad.models.path_get_info.PathGetInfo'>, 'model_computed_fields': 'ClassVar[Dict[str, ComputedFieldInfo]]', 'model_config': 'ClassVar[ConfigDict]', 'model_fields': 'ClassVar[Dict[str, FieldInfo]]', 'type': typing.Literal['path_get_info']}[source]

classmethod __class_getitem__(typevar_values)[source]

Return type:: type[BaseModel] | PydanticRecursiveRef

__class_vars__: ClassVar[set[str]] = {}[source]: The names of the class variables defined on the model.

__copy__()[source]

Returns a shallow copy of the model.

Return type:: Self

__deepcopy__(memo=None)[source]

Returns a deep copy of the model.

Return type:: Self

__delattr__(item)[source]

Implement delattr(self, name).

Return type:: Any

__dict__[source]

__eq__(other)[source]

Return self==value.

Return type:: bool

property __fields_set__: set[str][source]

classmethod __get_pydantic_core_schema__(source, handler, /)[source]

Hook into generating the model’s CoreSchema.

Parameters:

source (type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.
handler (GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.

Return type:

Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]

Returns:

A pydantic-core CoreSchema.

classmethod __get_pydantic_json_schema__(core_schema, handler, /)[source]

Hook into generating the model’s JSON schema.

Parameters:

core_schema (Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({'type': 'nullable', 'schema': current_schema}), or just call the handler with the original schema.
handler (GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.

Return type:

Returns:

A JSON schema, as a Python object.

__getattr__(item)[source]

Return type:: Any

__getstate__()[source]

Helper for pickle.

Return type:: dict[Any, Any]

__hash__ = None[source]

__init__(**data)[source]

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__iter__()[source]

So dict(model) works.

Return type:: Generator[Tuple[str, Any], None, None]

__module__ = 'kittycad.models.ok_modeling_cmd_response'[source]

__pretty__(fmt, **kwargs)[source]

Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.

Return type:: Generator[Any, None, None]

__private_attributes__: ClassVar[Dict[str, ModelPrivateAttr]] = {}[source]: Metadata about the private attributes of the model.

__pydantic_complete__: ClassVar[bool] = True[source]: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__: ClassVar[CoreSchema] = {'cls': <class 'kittycad.models.ok_modeling_cmd_response.OptionPathGetInfo'>, 'config': {'title': 'OptionPathGetInfo'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.ok_modeling_cmd_response.OptionPathGetInfo'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.ok_modeling_cmd_response.OptionPathGetInfo'>>]}, 'ref': 'kittycad.models.ok_modeling_cmd_response.OptionPathGetInfo:94667213718704', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'data': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.path_get_info.PathGetInfo'>, 'config': {'title': 'PathGetInfo'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.path_get_info.PathGetInfo'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.path_get_info.PathGetInfo'>>]}, 'ref': 'kittycad.models.path_get_info.PathGetInfo:94667212480128', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'segments': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'items_schema': {'cls': <class 'kittycad.models.path_segment_info.PathSegmentInfo'>, 'config': {'title': 'PathSegmentInfo'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.path_segment_info.PathSegmentInfo'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.path_segment_info.PathSegmentInfo'>>]}, 'ref': 'kittycad.models.path_segment_info.PathSegmentInfo:94667212684112', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'command': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <enum 'PathCommand'>, 'members': [PathCommand.MOVE_TO, PathCommand.LINE_TO, PathCommand.BEZ_CURVE_TO, PathCommand.NURBS_CURVE_TO, PathCommand.ADD_ARC], 'metadata': {'pydantic_js_functions': [<function GenerateSchema._enum_schema.<locals>.get_json_schema>]}, 'ref': 'kittycad.models.path_command.PathCommand:94667212682336', 'sub_type': 'str', 'type': 'enum'}, 'type': 'model-field'}, 'command_id': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': None, 'schema': {'schema': {'function': {'function': <class 'kittycad.models.modeling_cmd_id.ModelingCmdId'>, 'type': 'no-info'}, 'schema': {'type': 'str'}, 'type': 'function-after'}, 'type': 'nullable'}, 'type': 'default'}, 'type': 'model-field'}, 'relative': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'type': 'bool'}, 'type': 'model-field'}}, 'model_name': 'PathSegmentInfo', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'list'}, 'type': 'model-field'}}, 'model_name': 'PathGetInfo', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}, 'type': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': 'path_get_info', 'schema': {'expected': ['path_get_info'], 'type': 'literal'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'OptionPathGetInfo', 'type': 'model-fields'}, 'type': 'model'}[source]: The core schema of the model.

__pydantic_custom_init__: ClassVar[bool] = False[source]: Whether the model has a custom __init__ method.

__pydantic_decorators__: ClassVar[_decorators.DecoratorInfos] = DecoratorInfos(validators={}, field_validators={}, root_validators={}, field_serializers={}, model_serializers={}, model_validators={}, computed_fields={})[source]: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_extra__: dict[str, Any] | None[source]: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to 'allow'.

__pydantic_fields_set__: set[str][source]: The names of fields explicitly set during instantiation.

__pydantic_generic_metadata__: ClassVar[_generics.PydanticGenericMetadata] = {'args': (), 'origin': None, 'parameters': ()}[source]: 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.

classmethod __pydantic_init_subclass__(**kwargs)[source]

This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.

This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.

This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.

Parameters:: **kwargs (Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.
Return type:: None

__pydantic_parent_namespace__: ClassVar[Dict[str, Any] | None] = None[source]: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__: ClassVar[None | Literal['model_post_init']] = None[source]: The name of the post-init method for the model, if defined.

__pydantic_private__: dict[str, Any] | None[source]: Values of private attributes set on the model instance.

__pydantic_root_model__: ClassVar[bool] = False[source]: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__: ClassVar[SchemaSerializer] = SchemaSerializer(serializer=Model( ModelSerializer { class: Py( 0x000056196da544b0, ), serializer: Fields( GeneralFieldsSerializer { fields: { "type": SerField { key_py: Py( 0x00007f903823d958, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f90346e4870, ), ), serializer: Literal( LiteralSerializer { expected_int: {}, expected_str: { "path_get_info", }, expected_py: None, name: "literal['path_get_info']", }, ), }, ), ), required: true, }, "data": SerField { key_py: Py( 0x00007f9038238fa0, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196d925e80, ), serializer: Fields( GeneralFieldsSerializer { fields: { "segments": SerField { key_py: Py( 0x00007f9037146130, ), alias: None, alias_py: None, serializer: Some( List( ListSerializer { item_serializer: Model( ModelSerializer { class: Py( 0x000056196d957b50, ), serializer: Fields( GeneralFieldsSerializer { fields: { "command": SerField { key_py: Py( 0x00007f9038238ce0, ), alias: None, alias_py: None, serializer: Some( Enum( EnumSerializer { class: Py( 0x000056196d957460, ), serializer: Some( Str( StrSerializer, ), ), }, ), ), required: true, }, "relative": SerField { key_py: Py( 0x00007f9036a086f0, ), alias: None, alias_py: None, serializer: Some( Bool( BoolSerializer, ), ), required: true, }, "command_id": SerField { key_py: Py( 0x00007f90334b14f0, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f9038148100, ), ), serializer: Nullable( NullableSerializer { serializer: Str( StrSerializer, ), }, ), }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 3, }, ), has_extra: false, root_model: false, name: "PathSegmentInfo", }, ), filter: SchemaFilter { include: None, exclude: None, }, name: "list[PathSegmentInfo]", }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 1, }, ), has_extra: false, root_model: false, name: "PathGetInfo", }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "OptionPathGetInfo", }, ), definitions=[])[source]: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__: ClassVar[SchemaValidator | PluggableSchemaValidator] = SchemaValidator(title="OptionPathGetInfo", validator=Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "data", lookup_key: Simple { key: "data", py_key: Py( 0x00007f903336f900, ), path: LookupPath( [ S( "data", Py( 0x00007f903336f930, ), ), ], ), }, name_py: Py( 0x00007f9038238fa0, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "segments", lookup_key: Simple { key: "segments", py_key: Py( 0x00007f90333a20f0, ), path: LookupPath( [ S( "segments", Py( 0x00007f90333a2130, ), ), ], ), }, name_py: Py( 0x00007f9037146130, ), validator: List( ListValidator { strict: false, item_validator: Some( Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "command", lookup_key: Simple { key: "command", py_key: Py( 0x00007f903336f8a0, ), path: LookupPath( [ S( "command", Py( 0x00007f903336f8d0, ), ), ], ), }, name_py: Py( 0x00007f9038238ce0, ), validator: StrEnum( EnumValidator { phantom: PhantomData<_pydantic_core::validators::enum_::StrEnumValidator>, class: Py( 0x000056196d957460, ), lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "nurbs_curve_to": 3, "line_to": 1, "move_to": 0, "bez_curve_to": 2, "add_arc": 4, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f90338b6db0, ), Py( 0x00007f90338b6e70, ), Py( 0x00007f90338b6f30, ), Py( 0x00007f90338b6f90, ), Py( 0x00007f90338b7050, ), ], }, missing: None, expected_repr: "'move_to', 'line_to', 'bez_curve_to', 'nurbs_curve_to' or 'add_arc'", strict: false, class_repr: "PathCommand", name: "str-enum[PathCommand]", }, ), frozen: false, }, Field { name: "command_id", lookup_key: Simple { key: "command_id", py_key: Py( 0x00007f90333a2030, ), path: LookupPath( [ S( "command_id", Py( 0x00007f90333a1ff0, ), ), ], ), }, name_py: Py( 0x00007f90334b14f0, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f9038148100, ), ), on_error: Raise, validator: Nullable( NullableValidator { validator: FunctionAfter( FunctionAfterValidator { validator: Str( StrValidator { strict: false, coerce_numbers_to_str: false, }, ), func: Py( 0x000056196d4b6c20, ), config: Py( 0x00007f90333a1cc0, ), name: "function-after[ModelingCmdId(), str]", field_name: None, info_arg: false, }, ), name: "nullable[function-after[ModelingCmdId(), str]]", }, ), validate_default: false, copy_default: false, name: "default[nullable[function-after[ModelingCmdId(), str]]]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, Field { name: "relative", lookup_key: Simple { key: "relative", py_key: Py( 0x00007f90333a20b0, ), path: LookupPath( [ S( "relative", Py( 0x00007f90333a2070, ), ), ], ), }, name_py: Py( 0x00007f9036a086f0, ), validator: Bool( BoolValidator { strict: false, }, ), frozen: false, }, ], model_name: "PathSegmentInfo", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d957b50, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "PathSegmentInfo", }, ), ), min_length: None, max_length: None, name: OnceLock( <uninit>, ), fail_fast: false, }, ), frozen: false, }, ], model_name: "PathGetInfo", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d925e80, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "PathGetInfo", }, ), frozen: false, }, Field { name: "type", lookup_key: Simple { key: "type", py_key: Py( 0x00007f903336f960, ), path: LookupPath( [ S( "type", Py( 0x00007f903336f990, ), ), ], ), }, name_py: Py( 0x00007f903823d958, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f90346e4870, ), ), on_error: Raise, validator: Literal( LiteralValidator { lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "path_get_info": 0, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f90346e4870, ), ], }, expected_repr: "'path_get_info'", name: "literal['path_get_info']", }, ), validate_default: false, copy_default: false, name: "default[literal['path_get_info']]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "OptionPathGetInfo", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196da544b0, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "OptionPathGetInfo", }, ), definitions=[], cache_strings=True)[source]: The pydantic-core SchemaValidator used to validate instances of the model.

__repr__()[source]

Return repr(self).

Return type:: str

__repr_args__()[source]

Return type:: Iterable[tuple[str | None, Any]]

__repr_name__()[source]

Name of the instance’s class, used in __repr__.

Return type:: str

__repr_str__(join_str)[source]

Return type:: str

__rich_repr__()[source]

Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.

Return type:: Iterable[Any | tuple[Any] | tuple[str, Any] | tuple[str, Any, Any]]

__setattr__(name, value)[source]

Implement setattr(self, name, value).

Return type:: None

__setstate__(state)[source]

Return type:: None

__signature__: ClassVar[Signature] = <Signature (*, data: kittycad.models.path_get_info.PathGetInfo, type: Literal['path_get_info'] = 'path_get_info') -> None>[source]: The synthesized __init__ [Signature][inspect.Signature] of the model.

__slots__ = ('__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__')[source]

__str__()[source]

Return str(self).

Return type:: str

_abc_impl = <_abc._abc_data object>[source]

_calculate_keys(*args, **kwargs)[source]

Return type:: Any

_check_frozen(name, value)[source]

Return type:: None

_copy_and_set_values(*args, **kwargs)[source]

Return type:: Any

classmethod _get_value(*args, **kwargs)[source]

Return type:: Any

_iter(*args, **kwargs)[source]

Return type:: Any

classmethod construct(_fields_set=None, **values)[source]

Return type:: Self

copy(*, include=None, exclude=None, update=None, deep=False)[source]

Returns a copy of the model.

!!! warning “Deprecated”: This method is now deprecated; use model_copy instead.

If you need include or exclude, use:

`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `

Parameters:

include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.

Returns:

A copy of the model with included, excluded and updated fields as specified.

data: PathGetInfo[source]

dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)[source]

Return type:: Dict[str, Any]

classmethod from_orm(obj)[source]

Return type:: Self

json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)[source]

Return type:: str

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}[source]: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'protected_namespaces': ()}[source]: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod model_construct(_fields_set=None, **values)[source]

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note: model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == 'allow', then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == 'ignore' (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == 'forbid' does not result in an error if extra values are passed, but they will be ignored.

Parameters:

_fields_set (set[str] | None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.
values (Any) – Trusted or pre-validated data dictionary.

Return type:

Self

Returns:

A new instance of the Model class with validated data.

model_copy(*, update=None, deep=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy

Returns a copy of the model.

Parameters:

update (dict[str, Any] | None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.
deep (bool) – Set to True to make a deep copy of the model.

Return type:

Self

Returns:

New model instance.

model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters:

mode (Union[Literal['json', 'python'], str]) – The mode in which to_python 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.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to include in the output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to exclude from the output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to use the field’s alias in the dictionary key if defined.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A dictionary representation of the model.

model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

Generates a JSON representation of the model using Pydantic’s to_json method.

Parameters:

indent (int | None) – Indentation to use in the JSON output. If None is passed, the output will be compact.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to include in the JSON output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to exclude from the JSON output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to serialize using field aliases.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A JSON string representation of the model.

property model_extra: dict[str, Any] | None[source]

Get extra fields set during validation.

Returns:: A dictionary of extra fields, or None if config.extra is not set to "allow".

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=PathGetInfo, required=True), 'type': FieldInfo(annotation=Literal['path_get_info'], required=False, default='path_get_info')}[source]

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

property model_fields_set: set[str][source]

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,: i.e. that were not filled from defaults.

classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')[source]

Generates a JSON schema for a model class.

Parameters:

by_alias (bool) – Whether to use attribute aliases or not.
ref_template (str) – The reference template.
schema_generator (type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modifications
mode (Literal['validation', 'serialization']) – The mode in which to generate the schema.

Return type:

Returns:

The JSON schema for the given model class.

classmethod model_parametrized_name(params)[source]

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

Parameters:: params (tuple[type[Any], ...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.
Return type:: str
Returns:: String representing the new class where params are passed to cls as type variables.
Raises:: TypeError – Raised when trying to generate concrete names for non-generic models.

model_post_init(_BaseModel__context)[source]

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

Return type:: None

classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)[source]

Try to rebuild the pydantic-core schema for the model.

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.

Parameters:

force (bool) – Whether to force the rebuilding of the model schema, defaults to False.
raise_errors (bool) – Whether to raise errors, defaults to True.
_parent_namespace_depth (int) – The depth level of the parent namespace, defaults to 2.
_types_namespace (dict[str, Any] | None) – The types namespace, defaults to None.

Return type:

Returns:

Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.

classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)[source]

Validate a pydantic model instance.

Parameters:

obj (Any) – The object to validate.
strict (bool | None) – Whether to enforce types strictly.
from_attributes (bool | None) – Whether to extract data from object attributes.
context (Any | None) – Additional context to pass to the validator.

Raises:

ValidationError – If the object could not be validated.

Return type:

Self

Returns:

The validated model instance.

classmethod model_validate_json(json_data, *, strict=None, context=None)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing

Validate the given JSON data against the Pydantic model.

Parameters:

json_data (str | bytes | bytearray) – The JSON data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

Raises:

ValidationError – If json_data is not a JSON string or the object could not be validated.

classmethod model_validate_strings(obj, *, strict=None, context=None)[source]

Validate the given object with string data against the Pydantic model.

Parameters:

obj (Any) – The object containing string data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod parse_obj(obj)[source]

Return type:: Self

classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod schema(by_alias=True, ref_template='#/$defs/{model}')[source]

Return type:: Dict[str, Any]

classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)[source]

Return type:: str

type: Literal['path_get_info'][source]

classmethod update_forward_refs(**localns)[source]

Return type:: None

classmethod validate(value)[source]

Return type:: Self

class kittycad.models.ok_modeling_cmd_response.OptionPathGetSketchTargetUuid(**data)[source][source]

The response to the ‘PathGetSketchTargetUuid’ endpoint

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__abstractmethods__ = frozenset({})[source]

__annotations__ = {'__class_vars__': 'ClassVar[set[str]]', '__private_attributes__': 'ClassVar[Dict[str, ModelPrivateAttr]]', '__pydantic_complete__': 'ClassVar[bool]', '__pydantic_core_schema__': 'ClassVar[CoreSchema]', '__pydantic_custom_init__': 'ClassVar[bool]', '__pydantic_decorators__': 'ClassVar[_decorators.DecoratorInfos]', '__pydantic_extra__': 'dict[str, Any] | None', '__pydantic_fields_set__': 'set[str]', '__pydantic_generic_metadata__': 'ClassVar[_generics.PydanticGenericMetadata]', '__pydantic_parent_namespace__': 'ClassVar[Dict[str, Any] | None]', '__pydantic_post_init__': "ClassVar[None | Literal['model_post_init']]", '__pydantic_private__': 'dict[str, Any] | None', '__pydantic_root_model__': 'ClassVar[bool]', '__pydantic_serializer__': 'ClassVar[SchemaSerializer]', '__pydantic_validator__': 'ClassVar[SchemaValidator | PluggableSchemaValidator]', '__signature__': 'ClassVar[Signature]', 'data': <class 'kittycad.models.path_get_sketch_target_uuid.PathGetSketchTargetUuid'>, 'model_computed_fields': 'ClassVar[Dict[str, ComputedFieldInfo]]', 'model_config': 'ClassVar[ConfigDict]', 'model_fields': 'ClassVar[Dict[str, FieldInfo]]', 'type': typing.Literal['path_get_sketch_target_uuid']}[source]

classmethod __class_getitem__(typevar_values)[source]

Return type:: type[BaseModel] | PydanticRecursiveRef

__class_vars__: ClassVar[set[str]] = {}[source]: The names of the class variables defined on the model.

__copy__()[source]

Returns a shallow copy of the model.

Return type:: Self

__deepcopy__(memo=None)[source]

Returns a deep copy of the model.

Return type:: Self

__delattr__(item)[source]

Implement delattr(self, name).

Return type:: Any

__dict__[source]

__eq__(other)[source]

Return self==value.

Return type:: bool

property __fields_set__: set[str][source]

classmethod __get_pydantic_core_schema__(source, handler, /)[source]

Hook into generating the model’s CoreSchema.

Parameters:

source (type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.
handler (GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.

Return type:

Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]

Returns:

A pydantic-core CoreSchema.

classmethod __get_pydantic_json_schema__(core_schema, handler, /)[source]

Hook into generating the model’s JSON schema.

Parameters:

core_schema (Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({'type': 'nullable', 'schema': current_schema}), or just call the handler with the original schema.
handler (GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.

Return type:

Returns:

A JSON schema, as a Python object.

__getattr__(item)[source]

Return type:: Any

__getstate__()[source]

Helper for pickle.

Return type:: dict[Any, Any]

__hash__ = None[source]

__init__(**data)[source]

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__iter__()[source]

So dict(model) works.

Return type:: Generator[Tuple[str, Any], None, None]

__module__ = 'kittycad.models.ok_modeling_cmd_response'[source]

__pretty__(fmt, **kwargs)[source]

Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.

Return type:: Generator[Any, None, None]

__private_attributes__: ClassVar[Dict[str, ModelPrivateAttr]] = {}[source]: Metadata about the private attributes of the model.

__pydantic_complete__: ClassVar[bool] = True[source]: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__: ClassVar[CoreSchema] = {'cls': <class 'kittycad.models.ok_modeling_cmd_response.OptionPathGetSketchTargetUuid'>, 'config': {'title': 'OptionPathGetSketchTargetUuid'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.ok_modeling_cmd_response.OptionPathGetSketchTargetUuid'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.ok_modeling_cmd_response.OptionPathGetSketchTargetUuid'>>]}, 'ref': 'kittycad.models.ok_modeling_cmd_response.OptionPathGetSketchTargetUuid:94667213793792', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'data': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.path_get_sketch_target_uuid.PathGetSketchTargetUuid'>, 'config': {'title': 'PathGetSketchTargetUuid'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.path_get_sketch_target_uuid.PathGetSketchTargetUuid'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.path_get_sketch_target_uuid.PathGetSketchTargetUuid'>>]}, 'ref': 'kittycad.models.path_get_sketch_target_uuid.PathGetSketchTargetUuid:94667212495008', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'target_id': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': None, 'schema': {'schema': {'type': 'str'}, 'type': 'nullable'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'PathGetSketchTargetUuid', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}, 'type': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': 'path_get_sketch_target_uuid', 'schema': {'expected': ['path_get_sketch_target_uuid'], 'type': 'literal'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'OptionPathGetSketchTargetUuid', 'type': 'model-fields'}, 'type': 'model'}[source]: The core schema of the model.

__pydantic_custom_init__: ClassVar[bool] = False[source]: Whether the model has a custom __init__ method.

__pydantic_decorators__: ClassVar[_decorators.DecoratorInfos] = DecoratorInfos(validators={}, field_validators={}, root_validators={}, field_serializers={}, model_serializers={}, model_validators={}, computed_fields={})[source]: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_extra__: dict[str, Any] | None[source]: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to 'allow'.

__pydantic_fields_set__: set[str][source]: The names of fields explicitly set during instantiation.

__pydantic_generic_metadata__: ClassVar[_generics.PydanticGenericMetadata] = {'args': (), 'origin': None, 'parameters': ()}[source]: 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.

classmethod __pydantic_init_subclass__(**kwargs)[source]

This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.

This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.

This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.

Parameters:: **kwargs (Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.
Return type:: None

__pydantic_parent_namespace__: ClassVar[Dict[str, Any] | None] = None[source]: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__: ClassVar[None | Literal['model_post_init']] = None[source]: The name of the post-init method for the model, if defined.

__pydantic_private__: dict[str, Any] | None[source]: Values of private attributes set on the model instance.

__pydantic_root_model__: ClassVar[bool] = False[source]: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__: ClassVar[SchemaSerializer] = SchemaSerializer(serializer=Model( ModelSerializer { class: Py( 0x000056196da66a00, ), serializer: Fields( GeneralFieldsSerializer { fields: { "type": SerField { key_py: Py( 0x00007f903823d958, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f9034697690, ), ), serializer: Literal( LiteralSerializer { expected_int: {}, expected_str: { "path_get_sketch_target_uuid", }, expected_py: None, name: "literal['path_get_sketch_target_uuid']", }, ), }, ), ), required: true, }, "data": SerField { key_py: Py( 0x00007f9038238fa0, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196d9298a0, ), serializer: Fields( GeneralFieldsSerializer { fields: { "target_id": SerField { key_py: Py( 0x00007f903822a460, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f9038148100, ), ), serializer: Nullable( NullableSerializer { serializer: Str( StrSerializer, ), }, ), }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 1, }, ), has_extra: false, root_model: false, name: "PathGetSketchTargetUuid", }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "OptionPathGetSketchTargetUuid", }, ), definitions=[])[source]: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__: ClassVar[SchemaValidator | PluggableSchemaValidator] = SchemaValidator(title="OptionPathGetSketchTargetUuid", validator=Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "data", lookup_key: Simple { key: "data", py_key: Py( 0x00007f90333a86f0, ), path: LookupPath( [ S( "data", Py( 0x00007f90333a8720, ), ), ], ), }, name_py: Py( 0x00007f9038238fa0, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "target_id", lookup_key: Simple { key: "target_id", py_key: Py( 0x00007f90333ae8b0, ), path: LookupPath( [ S( "target_id", Py( 0x00007f90333ae870, ), ), ], ), }, name_py: Py( 0x00007f903822a460, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f9038148100, ), ), on_error: Raise, validator: Nullable( NullableValidator { validator: Str( StrValidator { strict: false, coerce_numbers_to_str: false, }, ), name: "nullable[str]", }, ), validate_default: false, copy_default: false, name: "default[nullable[str]]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "PathGetSketchTargetUuid", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d9298a0, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "PathGetSketchTargetUuid", }, ), frozen: false, }, Field { name: "type", lookup_key: Simple { key: "type", py_key: Py( 0x00007f90333a8750, ), path: LookupPath( [ S( "type", Py( 0x00007f90333a8780, ), ), ], ), }, name_py: Py( 0x00007f903823d958, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f9034697690, ), ), on_error: Raise, validator: Literal( LiteralValidator { lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "path_get_sketch_target_uuid": 0, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f9034697690, ), ], }, expected_repr: "'path_get_sketch_target_uuid'", name: "literal['path_get_sketch_target_uuid']", }, ), validate_default: false, copy_default: false, name: "default[literal['path_get_sketch_target_uuid']]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "OptionPathGetSketchTargetUuid", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196da66a00, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "OptionPathGetSketchTargetUuid", }, ), definitions=[], cache_strings=True)[source]: The pydantic-core SchemaValidator used to validate instances of the model.

__repr__()[source]

Return repr(self).

Return type:: str

__repr_args__()[source]

Return type:: Iterable[tuple[str | None, Any]]

__repr_name__()[source]

Name of the instance’s class, used in __repr__.

Return type:: str

__repr_str__(join_str)[source]

Return type:: str

__rich_repr__()[source]

Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.

Return type:: Iterable[Any | tuple[Any] | tuple[str, Any] | tuple[str, Any, Any]]

__setattr__(name, value)[source]

Implement setattr(self, name, value).

Return type:: None

__setstate__(state)[source]

Return type:: None

__signature__: ClassVar[Signature] = <Signature (*, data: kittycad.models.path_get_sketch_target_uuid.PathGetSketchTargetUuid, type: Literal['path_get_sketch_target_uuid'] = 'path_get_sketch_target_uuid') -> None>[source]: The synthesized __init__ [Signature][inspect.Signature] of the model.

__slots__ = ('__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__')[source]

__str__()[source]

Return str(self).

Return type:: str

_abc_impl = <_abc._abc_data object>[source]

_calculate_keys(*args, **kwargs)[source]

Return type:: Any

_check_frozen(name, value)[source]

Return type:: None

_copy_and_set_values(*args, **kwargs)[source]

Return type:: Any

classmethod _get_value(*args, **kwargs)[source]

Return type:: Any

_iter(*args, **kwargs)[source]

Return type:: Any

classmethod construct(_fields_set=None, **values)[source]

Return type:: Self

copy(*, include=None, exclude=None, update=None, deep=False)[source]

Returns a copy of the model.

!!! warning “Deprecated”: This method is now deprecated; use model_copy instead.

If you need include or exclude, use:

`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `

Parameters:

include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.

Returns:

A copy of the model with included, excluded and updated fields as specified.

data: PathGetSketchTargetUuid[source]

dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)[source]

Return type:: Dict[str, Any]

classmethod from_orm(obj)[source]

Return type:: Self

json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)[source]

Return type:: str

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}[source]: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'protected_namespaces': ()}[source]: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod model_construct(_fields_set=None, **values)[source]

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note: model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == 'allow', then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == 'ignore' (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == 'forbid' does not result in an error if extra values are passed, but they will be ignored.

Parameters:

_fields_set (set[str] | None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.
values (Any) – Trusted or pre-validated data dictionary.

Return type:

Self

Returns:

A new instance of the Model class with validated data.

model_copy(*, update=None, deep=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy

Returns a copy of the model.

Parameters:

update (dict[str, Any] | None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.
deep (bool) – Set to True to make a deep copy of the model.

Return type:

Self

Returns:

New model instance.

model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters:

mode (Union[Literal['json', 'python'], str]) – The mode in which to_python 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.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to include in the output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to exclude from the output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to use the field’s alias in the dictionary key if defined.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A dictionary representation of the model.

model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

Generates a JSON representation of the model using Pydantic’s to_json method.

Parameters:

indent (int | None) – Indentation to use in the JSON output. If None is passed, the output will be compact.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to include in the JSON output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to exclude from the JSON output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to serialize using field aliases.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A JSON string representation of the model.

property model_extra: dict[str, Any] | None[source]

Get extra fields set during validation.

Returns:: A dictionary of extra fields, or None if config.extra is not set to "allow".

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=PathGetSketchTargetUuid, required=True), 'type': FieldInfo(annotation=Literal['path_get_sketch_target_uuid'], required=False, default='path_get_sketch_target_uuid')}[source]

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

property model_fields_set: set[str][source]

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,: i.e. that were not filled from defaults.

classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')[source]

Generates a JSON schema for a model class.

Parameters:

by_alias (bool) – Whether to use attribute aliases or not.
ref_template (str) – The reference template.
schema_generator (type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modifications
mode (Literal['validation', 'serialization']) – The mode in which to generate the schema.

Return type:

Returns:

The JSON schema for the given model class.

classmethod model_parametrized_name(params)[source]

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

Parameters:: params (tuple[type[Any], ...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.
Return type:: str
Returns:: String representing the new class where params are passed to cls as type variables.
Raises:: TypeError – Raised when trying to generate concrete names for non-generic models.

model_post_init(_BaseModel__context)[source]

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

Return type:: None

classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)[source]

Try to rebuild the pydantic-core schema for the model.

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.

Parameters:

force (bool) – Whether to force the rebuilding of the model schema, defaults to False.
raise_errors (bool) – Whether to raise errors, defaults to True.
_parent_namespace_depth (int) – The depth level of the parent namespace, defaults to 2.
_types_namespace (dict[str, Any] | None) – The types namespace, defaults to None.

Return type:

Returns:

Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.

classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)[source]

Validate a pydantic model instance.

Parameters:

obj (Any) – The object to validate.
strict (bool | None) – Whether to enforce types strictly.
from_attributes (bool | None) – Whether to extract data from object attributes.
context (Any | None) – Additional context to pass to the validator.

Raises:

ValidationError – If the object could not be validated.

Return type:

Self

Returns:

The validated model instance.

classmethod model_validate_json(json_data, *, strict=None, context=None)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing

Validate the given JSON data against the Pydantic model.

Parameters:

json_data (str | bytes | bytearray) – The JSON data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

Raises:

ValidationError – If json_data is not a JSON string or the object could not be validated.

classmethod model_validate_strings(obj, *, strict=None, context=None)[source]

Validate the given object with string data against the Pydantic model.

Parameters:

obj (Any) – The object containing string data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod parse_obj(obj)[source]

Return type:: Self

classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod schema(by_alias=True, ref_template='#/$defs/{model}')[source]

Return type:: Dict[str, Any]

classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)[source]

Return type:: str

type: Literal['path_get_sketch_target_uuid'][source]

classmethod update_forward_refs(**localns)[source]

Return type:: None

classmethod validate(value)[source]

Return type:: Self

class kittycad.models.ok_modeling_cmd_response.OptionPathGetVertexUuids(**data)[source][source]

The response to the ‘PathGetVertexUuids’ endpoint

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__abstractmethods__ = frozenset({})[source]

__annotations__ = {'__class_vars__': 'ClassVar[set[str]]', '__private_attributes__': 'ClassVar[Dict[str, ModelPrivateAttr]]', '__pydantic_complete__': 'ClassVar[bool]', '__pydantic_core_schema__': 'ClassVar[CoreSchema]', '__pydantic_custom_init__': 'ClassVar[bool]', '__pydantic_decorators__': 'ClassVar[_decorators.DecoratorInfos]', '__pydantic_extra__': 'dict[str, Any] | None', '__pydantic_fields_set__': 'set[str]', '__pydantic_generic_metadata__': 'ClassVar[_generics.PydanticGenericMetadata]', '__pydantic_parent_namespace__': 'ClassVar[Dict[str, Any] | None]', '__pydantic_post_init__': "ClassVar[None | Literal['model_post_init']]", '__pydantic_private__': 'dict[str, Any] | None', '__pydantic_root_model__': 'ClassVar[bool]', '__pydantic_serializer__': 'ClassVar[SchemaSerializer]', '__pydantic_validator__': 'ClassVar[SchemaValidator | PluggableSchemaValidator]', '__signature__': 'ClassVar[Signature]', 'data': <class 'kittycad.models.path_get_vertex_uuids.PathGetVertexUuids'>, 'model_computed_fields': 'ClassVar[Dict[str, ComputedFieldInfo]]', 'model_config': 'ClassVar[ConfigDict]', 'model_fields': 'ClassVar[Dict[str, FieldInfo]]', 'type': typing.Literal['path_get_vertex_uuids']}[source]

classmethod __class_getitem__(typevar_values)[source]

Return type:: type[BaseModel] | PydanticRecursiveRef

__class_vars__: ClassVar[set[str]] = {}[source]: The names of the class variables defined on the model.

__copy__()[source]

Returns a shallow copy of the model.

Return type:: Self

__deepcopy__(memo=None)[source]

Returns a deep copy of the model.

Return type:: Self

__delattr__(item)[source]

Implement delattr(self, name).

Return type:: Any

__dict__[source]

__eq__(other)[source]

Return self==value.

Return type:: bool

property __fields_set__: set[str][source]

classmethod __get_pydantic_core_schema__(source, handler, /)[source]

Hook into generating the model’s CoreSchema.

Parameters:

source (type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.
handler (GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.

Return type:

Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]

Returns:

A pydantic-core CoreSchema.

classmethod __get_pydantic_json_schema__(core_schema, handler, /)[source]

Hook into generating the model’s JSON schema.

Parameters:

core_schema (Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({'type': 'nullable', 'schema': current_schema}), or just call the handler with the original schema.
handler (GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.

Return type:

Returns:

A JSON schema, as a Python object.

__getattr__(item)[source]

Return type:: Any

__getstate__()[source]

Helper for pickle.

Return type:: dict[Any, Any]

__hash__ = None[source]

__init__(**data)[source]

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__iter__()[source]

So dict(model) works.

Return type:: Generator[Tuple[str, Any], None, None]

__module__ = 'kittycad.models.ok_modeling_cmd_response'[source]

__pretty__(fmt, **kwargs)[source]

Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.

Return type:: Generator[Any, None, None]

__private_attributes__: ClassVar[Dict[str, ModelPrivateAttr]] = {}[source]: Metadata about the private attributes of the model.

__pydantic_complete__: ClassVar[bool] = True[source]: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__: ClassVar[CoreSchema] = {'cls': <class 'kittycad.models.ok_modeling_cmd_response.OptionPathGetVertexUuids'>, 'config': {'title': 'OptionPathGetVertexUuids'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.ok_modeling_cmd_response.OptionPathGetVertexUuids'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.ok_modeling_cmd_response.OptionPathGetVertexUuids'>>]}, 'ref': 'kittycad.models.ok_modeling_cmd_response.OptionPathGetVertexUuids:94667213782512', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'data': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.path_get_vertex_uuids.PathGetVertexUuids'>, 'config': {'title': 'PathGetVertexUuids'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.path_get_vertex_uuids.PathGetVertexUuids'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.path_get_vertex_uuids.PathGetVertexUuids'>>]}, 'ref': 'kittycad.models.path_get_vertex_uuids.PathGetVertexUuids:94667212371328', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'vertex_ids': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'items_schema': {'type': 'str'}, 'type': 'list'}, 'type': 'model-field'}}, 'model_name': 'PathGetVertexUuids', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}, 'type': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': 'path_get_vertex_uuids', 'schema': {'expected': ['path_get_vertex_uuids'], 'type': 'literal'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'OptionPathGetVertexUuids', 'type': 'model-fields'}, 'type': 'model'}[source]: The core schema of the model.

__pydantic_custom_init__: ClassVar[bool] = False[source]: Whether the model has a custom __init__ method.

__pydantic_decorators__: ClassVar[_decorators.DecoratorInfos] = DecoratorInfos(validators={}, field_validators={}, root_validators={}, field_serializers={}, model_serializers={}, model_validators={}, computed_fields={})[source]: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_extra__: dict[str, Any] | None[source]: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to 'allow'.

__pydantic_fields_set__: set[str][source]: The names of fields explicitly set during instantiation.

__pydantic_generic_metadata__: ClassVar[_generics.PydanticGenericMetadata] = {'args': (), 'origin': None, 'parameters': ()}[source]: 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.

classmethod __pydantic_init_subclass__(**kwargs)[source]

This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.

This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.

This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.

Parameters:: **kwargs (Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.
Return type:: None

__pydantic_parent_namespace__: ClassVar[Dict[str, Any] | None] = None[source]: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__: ClassVar[None | Literal['model_post_init']] = None[source]: The name of the post-init method for the model, if defined.

__pydantic_private__: dict[str, Any] | None[source]: Values of private attributes set on the model instance.

__pydantic_root_model__: ClassVar[bool] = False[source]: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__: ClassVar[SchemaSerializer] = SchemaSerializer(serializer=Model( ModelSerializer { class: Py( 0x000056196da63df0, ), serializer: Fields( GeneralFieldsSerializer { fields: { "type": SerField { key_py: Py( 0x00007f903823d958, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f90346e49f0, ), ), serializer: Literal( LiteralSerializer { expected_int: {}, expected_str: { "path_get_vertex_uuids", }, expected_py: None, name: "literal['path_get_vertex_uuids']", }, ), }, ), ), required: true, }, "data": SerField { key_py: Py( 0x00007f9038238fa0, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196d90b580, ), serializer: Fields( GeneralFieldsSerializer { fields: { "vertex_ids": SerField { key_py: Py( 0x00007f90338f4570, ), alias: None, alias_py: None, serializer: Some( List( ListSerializer { item_serializer: Str( StrSerializer, ), filter: SchemaFilter { include: None, exclude: None, }, name: "list[str]", }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 1, }, ), has_extra: false, root_model: false, name: "PathGetVertexUuids", }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "OptionPathGetVertexUuids", }, ), definitions=[])[source]: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__: ClassVar[SchemaValidator | PluggableSchemaValidator] = SchemaValidator(title="OptionPathGetVertexUuids", validator=Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "data", lookup_key: Simple { key: "data", py_key: Py( 0x00007f90333a81e0, ), path: LookupPath( [ S( "data", Py( 0x00007f90333a8210, ), ), ], ), }, name_py: Py( 0x00007f9038238fa0, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "vertex_ids", lookup_key: Simple { key: "vertex_ids", py_key: Py( 0x00007f90333ad3b0, ), path: LookupPath( [ S( "vertex_ids", Py( 0x00007f90333ad370, ), ), ], ), }, name_py: Py( 0x00007f90338f4570, ), validator: List( ListValidator { strict: false, item_validator: Some( Str( StrValidator { strict: false, coerce_numbers_to_str: false, }, ), ), min_length: None, max_length: None, name: OnceLock( <uninit>, ), fail_fast: false, }, ), frozen: false, }, ], model_name: "PathGetVertexUuids", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d90b580, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "PathGetVertexUuids", }, ), frozen: false, }, Field { name: "type", lookup_key: Simple { key: "type", py_key: Py( 0x00007f90333a8240, ), path: LookupPath( [ S( "type", Py( 0x00007f90333a8270, ), ), ], ), }, name_py: Py( 0x00007f903823d958, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f90346e49f0, ), ), on_error: Raise, validator: Literal( LiteralValidator { lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "path_get_vertex_uuids": 0, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f90346e49f0, ), ], }, expected_repr: "'path_get_vertex_uuids'", name: "literal['path_get_vertex_uuids']", }, ), validate_default: false, copy_default: false, name: "default[literal['path_get_vertex_uuids']]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "OptionPathGetVertexUuids", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196da63df0, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "OptionPathGetVertexUuids", }, ), definitions=[], cache_strings=True)[source]: The pydantic-core SchemaValidator used to validate instances of the model.

__repr__()[source]

Return repr(self).

Return type:: str

__repr_args__()[source]

Return type:: Iterable[tuple[str | None, Any]]

__repr_name__()[source]

Name of the instance’s class, used in __repr__.

Return type:: str

__repr_str__(join_str)[source]

Return type:: str

__rich_repr__()[source]

Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.

Return type:: Iterable[Any | tuple[Any] | tuple[str, Any] | tuple[str, Any, Any]]

__setattr__(name, value)[source]

Implement setattr(self, name, value).

Return type:: None

__setstate__(state)[source]

Return type:: None

__signature__: ClassVar[Signature] = <Signature (*, data: kittycad.models.path_get_vertex_uuids.PathGetVertexUuids, type: Literal['path_get_vertex_uuids'] = 'path_get_vertex_uuids') -> None>[source]: The synthesized __init__ [Signature][inspect.Signature] of the model.

__slots__ = ('__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__')[source]

__str__()[source]

Return str(self).

Return type:: str

_abc_impl = <_abc._abc_data object>[source]

_calculate_keys(*args, **kwargs)[source]

Return type:: Any

_check_frozen(name, value)[source]

Return type:: None

_copy_and_set_values(*args, **kwargs)[source]

Return type:: Any

classmethod _get_value(*args, **kwargs)[source]

Return type:: Any

_iter(*args, **kwargs)[source]

Return type:: Any

classmethod construct(_fields_set=None, **values)[source]

Return type:: Self

copy(*, include=None, exclude=None, update=None, deep=False)[source]

Returns a copy of the model.

!!! warning “Deprecated”: This method is now deprecated; use model_copy instead.

If you need include or exclude, use:

`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `

Parameters:

include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.

Returns:

A copy of the model with included, excluded and updated fields as specified.

data: PathGetVertexUuids[source]

dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)[source]

Return type:: Dict[str, Any]

classmethod from_orm(obj)[source]

Return type:: Self

json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)[source]

Return type:: str

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}[source]: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'protected_namespaces': ()}[source]: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod model_construct(_fields_set=None, **values)[source]

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note: model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == 'allow', then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == 'ignore' (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == 'forbid' does not result in an error if extra values are passed, but they will be ignored.

Parameters:

_fields_set (set[str] | None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.
values (Any) – Trusted or pre-validated data dictionary.

Return type:

Self

Returns:

A new instance of the Model class with validated data.

model_copy(*, update=None, deep=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy

Returns a copy of the model.

Parameters:

update (dict[str, Any] | None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.
deep (bool) – Set to True to make a deep copy of the model.

Return type:

Self

Returns:

New model instance.

model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters:

mode (Union[Literal['json', 'python'], str]) – The mode in which to_python 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.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to include in the output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to exclude from the output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to use the field’s alias in the dictionary key if defined.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A dictionary representation of the model.

model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

Generates a JSON representation of the model using Pydantic’s to_json method.

Parameters:

indent (int | None) – Indentation to use in the JSON output. If None is passed, the output will be compact.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to include in the JSON output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to exclude from the JSON output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to serialize using field aliases.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A JSON string representation of the model.

property model_extra: dict[str, Any] | None[source]

Get extra fields set during validation.

Returns:: A dictionary of extra fields, or None if config.extra is not set to "allow".

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=PathGetVertexUuids, required=True), 'type': FieldInfo(annotation=Literal['path_get_vertex_uuids'], required=False, default='path_get_vertex_uuids')}[source]

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

property model_fields_set: set[str][source]

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,: i.e. that were not filled from defaults.

classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')[source]

Generates a JSON schema for a model class.

Parameters:

by_alias (bool) – Whether to use attribute aliases or not.
ref_template (str) – The reference template.
schema_generator (type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modifications
mode (Literal['validation', 'serialization']) – The mode in which to generate the schema.

Return type:

Returns:

The JSON schema for the given model class.

classmethod model_parametrized_name(params)[source]

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

Parameters:: params (tuple[type[Any], ...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.
Return type:: str
Returns:: String representing the new class where params are passed to cls as type variables.
Raises:: TypeError – Raised when trying to generate concrete names for non-generic models.

model_post_init(_BaseModel__context)[source]

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

Return type:: None

classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)[source]

Try to rebuild the pydantic-core schema for the model.

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.

Parameters:

force (bool) – Whether to force the rebuilding of the model schema, defaults to False.
raise_errors (bool) – Whether to raise errors, defaults to True.
_parent_namespace_depth (int) – The depth level of the parent namespace, defaults to 2.
_types_namespace (dict[str, Any] | None) – The types namespace, defaults to None.

Return type:

Returns:

Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.

classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)[source]

Validate a pydantic model instance.

Parameters:

obj (Any) – The object to validate.
strict (bool | None) – Whether to enforce types strictly.
from_attributes (bool | None) – Whether to extract data from object attributes.
context (Any | None) – Additional context to pass to the validator.

Raises:

ValidationError – If the object could not be validated.

Return type:

Self

Returns:

The validated model instance.

classmethod model_validate_json(json_data, *, strict=None, context=None)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing

Validate the given JSON data against the Pydantic model.

Parameters:

json_data (str | bytes | bytearray) – The JSON data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

Raises:

ValidationError – If json_data is not a JSON string or the object could not be validated.

classmethod model_validate_strings(obj, *, strict=None, context=None)[source]

Validate the given object with string data against the Pydantic model.

Parameters:

obj (Any) – The object containing string data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod parse_obj(obj)[source]

Return type:: Self

classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod schema(by_alias=True, ref_template='#/$defs/{model}')[source]

Return type:: Dict[str, Any]

classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)[source]

Return type:: str

type: Literal['path_get_vertex_uuids'][source]

classmethod update_forward_refs(**localns)[source]

Return type:: None

classmethod validate(value)[source]

Return type:: Self

class kittycad.models.ok_modeling_cmd_response.OptionPathSegmentInfo(**data)[source][source]

The response to the ‘PathSegmentInfo’ endpoint

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__abstractmethods__ = frozenset({})[source]

__annotations__ = {'__class_vars__': 'ClassVar[set[str]]', '__private_attributes__': 'ClassVar[Dict[str, ModelPrivateAttr]]', '__pydantic_complete__': 'ClassVar[bool]', '__pydantic_core_schema__': 'ClassVar[CoreSchema]', '__pydantic_custom_init__': 'ClassVar[bool]', '__pydantic_decorators__': 'ClassVar[_decorators.DecoratorInfos]', '__pydantic_extra__': 'dict[str, Any] | None', '__pydantic_fields_set__': 'set[str]', '__pydantic_generic_metadata__': 'ClassVar[_generics.PydanticGenericMetadata]', '__pydantic_parent_namespace__': 'ClassVar[Dict[str, Any] | None]', '__pydantic_post_init__': "ClassVar[None | Literal['model_post_init']]", '__pydantic_private__': 'dict[str, Any] | None', '__pydantic_root_model__': 'ClassVar[bool]', '__pydantic_serializer__': 'ClassVar[SchemaSerializer]', '__pydantic_validator__': 'ClassVar[SchemaValidator | PluggableSchemaValidator]', '__signature__': 'ClassVar[Signature]', 'data': <class 'kittycad.models.path_segment_info.PathSegmentInfo'>, 'model_computed_fields': 'ClassVar[Dict[str, ComputedFieldInfo]]', 'model_config': 'ClassVar[ConfigDict]', 'model_fields': 'ClassVar[Dict[str, FieldInfo]]', 'type': typing.Literal['path_segment_info']}[source]

classmethod __class_getitem__(typevar_values)[source]

Return type:: type[BaseModel] | PydanticRecursiveRef

__class_vars__: ClassVar[set[str]] = {}[source]: The names of the class variables defined on the model.

__copy__()[source]

Returns a shallow copy of the model.

Return type:: Self

__deepcopy__(memo=None)[source]

Returns a deep copy of the model.

Return type:: Self

__delattr__(item)[source]

Implement delattr(self, name).

Return type:: Any

__dict__[source]

__eq__(other)[source]

Return self==value.

Return type:: bool

property __fields_set__: set[str][source]

classmethod __get_pydantic_core_schema__(source, handler, /)[source]

Hook into generating the model’s CoreSchema.

Parameters:

source (type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.
handler (GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.

Return type:

Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]

Returns:

A pydantic-core CoreSchema.

classmethod __get_pydantic_json_schema__(core_schema, handler, /)[source]

Hook into generating the model’s JSON schema.

Parameters:

core_schema (Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({'type': 'nullable', 'schema': current_schema}), or just call the handler with the original schema.
handler (GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.

Return type:

Returns:

A JSON schema, as a Python object.

__getattr__(item)[source]

Return type:: Any

__getstate__()[source]

Helper for pickle.

Return type:: dict[Any, Any]

__hash__ = None[source]

__init__(**data)[source]

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__iter__()[source]

So dict(model) works.

Return type:: Generator[Tuple[str, Any], None, None]

__module__ = 'kittycad.models.ok_modeling_cmd_response'[source]

__pretty__(fmt, **kwargs)[source]

Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.

Return type:: Generator[Any, None, None]

__private_attributes__: ClassVar[Dict[str, ModelPrivateAttr]] = {}[source]: Metadata about the private attributes of the model.

__pydantic_complete__: ClassVar[bool] = True[source]: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__: ClassVar[CoreSchema] = {'cls': <class 'kittycad.models.ok_modeling_cmd_response.OptionPathSegmentInfo'>, 'config': {'title': 'OptionPathSegmentInfo'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.ok_modeling_cmd_response.OptionPathSegmentInfo'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.ok_modeling_cmd_response.OptionPathSegmentInfo'>>]}, 'ref': 'kittycad.models.ok_modeling_cmd_response.OptionPathSegmentInfo:94667213733456', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'data': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.path_segment_info.PathSegmentInfo'>, 'config': {'title': 'PathSegmentInfo'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.path_segment_info.PathSegmentInfo'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.path_segment_info.PathSegmentInfo'>>]}, 'ref': 'kittycad.models.path_segment_info.PathSegmentInfo:94667212684112', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'command': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <enum 'PathCommand'>, 'members': [PathCommand.MOVE_TO, PathCommand.LINE_TO, PathCommand.BEZ_CURVE_TO, PathCommand.NURBS_CURVE_TO, PathCommand.ADD_ARC], 'metadata': {'pydantic_js_functions': [<function GenerateSchema._enum_schema.<locals>.get_json_schema>]}, 'ref': 'kittycad.models.path_command.PathCommand:94667212682336', 'sub_type': 'str', 'type': 'enum'}, 'type': 'model-field'}, 'command_id': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': None, 'schema': {'schema': {'function': {'function': <class 'kittycad.models.modeling_cmd_id.ModelingCmdId'>, 'type': 'no-info'}, 'schema': {'type': 'str'}, 'type': 'function-after'}, 'type': 'nullable'}, 'type': 'default'}, 'type': 'model-field'}, 'relative': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'type': 'bool'}, 'type': 'model-field'}}, 'model_name': 'PathSegmentInfo', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}, 'type': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': 'path_segment_info', 'schema': {'expected': ['path_segment_info'], 'type': 'literal'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'OptionPathSegmentInfo', 'type': 'model-fields'}, 'type': 'model'}[source]: The core schema of the model.

__pydantic_custom_init__: ClassVar[bool] = False[source]: Whether the model has a custom __init__ method.

__pydantic_decorators__: ClassVar[_decorators.DecoratorInfos] = DecoratorInfos(validators={}, field_validators={}, root_validators={}, field_serializers={}, model_serializers={}, model_validators={}, computed_fields={})[source]: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_extra__: dict[str, Any] | None[source]: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to 'allow'.

__pydantic_fields_set__: set[str][source]: The names of fields explicitly set during instantiation.

__pydantic_generic_metadata__: ClassVar[_generics.PydanticGenericMetadata] = {'args': (), 'origin': None, 'parameters': ()}[source]: 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.

classmethod __pydantic_init_subclass__(**kwargs)[source]

This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.

This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.

This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.

Parameters:: **kwargs (Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.
Return type:: None

__pydantic_parent_namespace__: ClassVar[Dict[str, Any] | None] = None[source]: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__: ClassVar[None | Literal['model_post_init']] = None[source]: The name of the post-init method for the model, if defined.

__pydantic_private__: dict[str, Any] | None[source]: Values of private attributes set on the model instance.

__pydantic_root_model__: ClassVar[bool] = False[source]: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__: ClassVar[SchemaSerializer] = SchemaSerializer(serializer=Model( ModelSerializer { class: Py( 0x000056196da57e50, ), serializer: Fields( GeneralFieldsSerializer { fields: { "type": SerField { key_py: Py( 0x00007f903823d958, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f90346e4b70, ), ), serializer: Literal( LiteralSerializer { expected_int: {}, expected_str: { "path_segment_info", }, expected_py: None, name: "literal['path_segment_info']", }, ), }, ), ), required: true, }, "data": SerField { key_py: Py( 0x00007f9038238fa0, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196d957b50, ), serializer: Fields( GeneralFieldsSerializer { fields: { "command_id": SerField { key_py: Py( 0x00007f90334b14f0, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f9038148100, ), ), serializer: Nullable( NullableSerializer { serializer: Str( StrSerializer, ), }, ), }, ), ), required: true, }, "relative": SerField { key_py: Py( 0x00007f9036a086f0, ), alias: None, alias_py: None, serializer: Some( Bool( BoolSerializer, ), ), required: true, }, "command": SerField { key_py: Py( 0x00007f9038238ce0, ), alias: None, alias_py: None, serializer: Some( Enum( EnumSerializer { class: Py( 0x000056196d957460, ), serializer: Some( Str( StrSerializer, ), ), }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 3, }, ), has_extra: false, root_model: false, name: "PathSegmentInfo", }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "OptionPathSegmentInfo", }, ), definitions=[])[source]: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__: ClassVar[SchemaValidator | PluggableSchemaValidator] = SchemaValidator(title="OptionPathSegmentInfo", validator=Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "data", lookup_key: Simple { key: "data", py_key: Py( 0x00007f903336ff60, ), path: LookupPath( [ S( "data", Py( 0x00007f903336ff90, ), ), ], ), }, name_py: Py( 0x00007f9038238fa0, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "command", lookup_key: Simple { key: "command", py_key: Py( 0x00007f903336ff00, ), path: LookupPath( [ S( "command", Py( 0x00007f903336ff30, ), ), ], ), }, name_py: Py( 0x00007f9038238ce0, ), validator: StrEnum( EnumValidator { phantom: PhantomData<_pydantic_core::validators::enum_::StrEnumValidator>, class: Py( 0x000056196d957460, ), lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "bez_curve_to": 2, "move_to": 0, "nurbs_curve_to": 3, "line_to": 1, "add_arc": 4, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f90338b6db0, ), Py( 0x00007f90338b6e70, ), Py( 0x00007f90338b6f30, ), Py( 0x00007f90338b6f90, ), Py( 0x00007f90338b7050, ), ], }, missing: None, expected_repr: "'move_to', 'line_to', 'bez_curve_to', 'nurbs_curve_to' or 'add_arc'", strict: false, class_repr: "PathCommand", name: "str-enum[PathCommand]", }, ), frozen: false, }, Field { name: "command_id", lookup_key: Simple { key: "command_id", py_key: Py( 0x00007f90333a38b0, ), path: LookupPath( [ S( "command_id", Py( 0x00007f90333a3870, ), ), ], ), }, name_py: Py( 0x00007f90334b14f0, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f9038148100, ), ), on_error: Raise, validator: Nullable( NullableValidator { validator: FunctionAfter( FunctionAfterValidator { validator: Str( StrValidator { strict: false, coerce_numbers_to_str: false, }, ), func: Py( 0x000056196d4b6c20, ), config: Py( 0x00007f90333a3640, ), name: "function-after[ModelingCmdId(), str]", field_name: None, info_arg: false, }, ), name: "nullable[function-after[ModelingCmdId(), str]]", }, ), validate_default: false, copy_default: false, name: "default[nullable[function-after[ModelingCmdId(), str]]]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, Field { name: "relative", lookup_key: Simple { key: "relative", py_key: Py( 0x00007f90333a3930, ), path: LookupPath( [ S( "relative", Py( 0x00007f90333a38f0, ), ), ], ), }, name_py: Py( 0x00007f9036a086f0, ), validator: Bool( BoolValidator { strict: false, }, ), frozen: false, }, ], model_name: "PathSegmentInfo", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d957b50, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "PathSegmentInfo", }, ), frozen: false, }, Field { name: "type", lookup_key: Simple { key: "type", py_key: Py( 0x00007f903336ffc0, ), path: LookupPath( [ S( "type", Py( 0x00007f90333a8030, ), ), ], ), }, name_py: Py( 0x00007f903823d958, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f90346e4b70, ), ), on_error: Raise, validator: Literal( LiteralValidator { lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "path_segment_info": 0, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f90346e4b70, ), ], }, expected_repr: "'path_segment_info'", name: "literal['path_segment_info']", }, ), validate_default: false, copy_default: false, name: "default[literal['path_segment_info']]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "OptionPathSegmentInfo", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196da57e50, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "OptionPathSegmentInfo", }, ), definitions=[], cache_strings=True)[source]: The pydantic-core SchemaValidator used to validate instances of the model.

__repr__()[source]

Return repr(self).

Return type:: str

__repr_args__()[source]

Return type:: Iterable[tuple[str | None, Any]]

__repr_name__()[source]

Name of the instance’s class, used in __repr__.

Return type:: str

__repr_str__(join_str)[source]

Return type:: str

__rich_repr__()[source]

Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.

Return type:: Iterable[Any | tuple[Any] | tuple[str, Any] | tuple[str, Any, Any]]

__setattr__(name, value)[source]

Implement setattr(self, name, value).

Return type:: None

__setstate__(state)[source]

Return type:: None

__signature__: ClassVar[Signature] = <Signature (*, data: kittycad.models.path_segment_info.PathSegmentInfo, type: Literal['path_segment_info'] = 'path_segment_info') -> None>[source]: The synthesized __init__ [Signature][inspect.Signature] of the model.

__slots__ = ('__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__')[source]

__str__()[source]

Return str(self).

Return type:: str

_abc_impl = <_abc._abc_data object>[source]

_calculate_keys(*args, **kwargs)[source]

Return type:: Any

_check_frozen(name, value)[source]

Return type:: None

_copy_and_set_values(*args, **kwargs)[source]

Return type:: Any

classmethod _get_value(*args, **kwargs)[source]

Return type:: Any

_iter(*args, **kwargs)[source]

Return type:: Any

classmethod construct(_fields_set=None, **values)[source]

Return type:: Self

copy(*, include=None, exclude=None, update=None, deep=False)[source]

Returns a copy of the model.

!!! warning “Deprecated”: This method is now deprecated; use model_copy instead.

If you need include or exclude, use:

`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `

Parameters:

include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.

Returns:

A copy of the model with included, excluded and updated fields as specified.

data: PathSegmentInfo[source]

dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)[source]

Return type:: Dict[str, Any]

classmethod from_orm(obj)[source]

Return type:: Self

json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)[source]

Return type:: str

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}[source]: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'protected_namespaces': ()}[source]: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod model_construct(_fields_set=None, **values)[source]

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note: model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == 'allow', then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == 'ignore' (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == 'forbid' does not result in an error if extra values are passed, but they will be ignored.

Parameters:

_fields_set (set[str] | None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.
values (Any) – Trusted or pre-validated data dictionary.

Return type:

Self

Returns:

A new instance of the Model class with validated data.

model_copy(*, update=None, deep=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy

Returns a copy of the model.

Parameters:

update (dict[str, Any] | None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.
deep (bool) – Set to True to make a deep copy of the model.

Return type:

Self

Returns:

New model instance.

model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters:

mode (Union[Literal['json', 'python'], str]) – The mode in which to_python 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.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to include in the output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to exclude from the output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to use the field’s alias in the dictionary key if defined.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A dictionary representation of the model.

model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

Generates a JSON representation of the model using Pydantic’s to_json method.

Parameters:

indent (int | None) – Indentation to use in the JSON output. If None is passed, the output will be compact.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to include in the JSON output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to exclude from the JSON output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to serialize using field aliases.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A JSON string representation of the model.

property model_extra: dict[str, Any] | None[source]

Get extra fields set during validation.

Returns:: A dictionary of extra fields, or None if config.extra is not set to "allow".

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=PathSegmentInfo, required=True), 'type': FieldInfo(annotation=Literal['path_segment_info'], required=False, default='path_segment_info')}[source]

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

property model_fields_set: set[str][source]

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,: i.e. that were not filled from defaults.

classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')[source]

Generates a JSON schema for a model class.

Parameters:

by_alias (bool) – Whether to use attribute aliases or not.
ref_template (str) – The reference template.
schema_generator (type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modifications
mode (Literal['validation', 'serialization']) – The mode in which to generate the schema.

Return type:

Returns:

The JSON schema for the given model class.

classmethod model_parametrized_name(params)[source]

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

Parameters:: params (tuple[type[Any], ...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.
Return type:: str
Returns:: String representing the new class where params are passed to cls as type variables.
Raises:: TypeError – Raised when trying to generate concrete names for non-generic models.

model_post_init(_BaseModel__context)[source]

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

Return type:: None

classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)[source]

Try to rebuild the pydantic-core schema for the model.

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.

Parameters:

force (bool) – Whether to force the rebuilding of the model schema, defaults to False.
raise_errors (bool) – Whether to raise errors, defaults to True.
_parent_namespace_depth (int) – The depth level of the parent namespace, defaults to 2.
_types_namespace (dict[str, Any] | None) – The types namespace, defaults to None.

Return type:

Returns:

Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.

classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)[source]

Validate a pydantic model instance.

Parameters:

obj (Any) – The object to validate.
strict (bool | None) – Whether to enforce types strictly.
from_attributes (bool | None) – Whether to extract data from object attributes.
context (Any | None) – Additional context to pass to the validator.

Raises:

ValidationError – If the object could not be validated.

Return type:

Self

Returns:

The validated model instance.

classmethod model_validate_json(json_data, *, strict=None, context=None)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing

Validate the given JSON data against the Pydantic model.

Parameters:

json_data (str | bytes | bytearray) – The JSON data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

Raises:

ValidationError – If json_data is not a JSON string or the object could not be validated.

classmethod model_validate_strings(obj, *, strict=None, context=None)[source]

Validate the given object with string data against the Pydantic model.

Parameters:

obj (Any) – The object containing string data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod parse_obj(obj)[source]

Return type:: Self

classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod schema(by_alias=True, ref_template='#/$defs/{model}')[source]

Return type:: Dict[str, Any]

classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)[source]

Return type:: str

type: Literal['path_segment_info'][source]

classmethod update_forward_refs(**localns)[source]

Return type:: None

classmethod validate(value)[source]

Return type:: Self

class kittycad.models.ok_modeling_cmd_response.OptionPlaneIntersectAndProject(**data)[source][source]

The response to the ‘PlaneIntersectAndProject’ endpoint

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__abstractmethods__ = frozenset({})[source]

__annotations__ = {'__class_vars__': 'ClassVar[set[str]]', '__private_attributes__': 'ClassVar[Dict[str, ModelPrivateAttr]]', '__pydantic_complete__': 'ClassVar[bool]', '__pydantic_core_schema__': 'ClassVar[CoreSchema]', '__pydantic_custom_init__': 'ClassVar[bool]', '__pydantic_decorators__': 'ClassVar[_decorators.DecoratorInfos]', '__pydantic_extra__': 'dict[str, Any] | None', '__pydantic_fields_set__': 'set[str]', '__pydantic_generic_metadata__': 'ClassVar[_generics.PydanticGenericMetadata]', '__pydantic_parent_namespace__': 'ClassVar[Dict[str, Any] | None]', '__pydantic_post_init__': "ClassVar[None | Literal['model_post_init']]", '__pydantic_private__': 'dict[str, Any] | None', '__pydantic_root_model__': 'ClassVar[bool]', '__pydantic_serializer__': 'ClassVar[SchemaSerializer]', '__pydantic_validator__': 'ClassVar[SchemaValidator | PluggableSchemaValidator]', '__signature__': 'ClassVar[Signature]', 'data': <class 'kittycad.models.plane_intersect_and_project.PlaneIntersectAndProject'>, 'model_computed_fields': 'ClassVar[Dict[str, ComputedFieldInfo]]', 'model_config': 'ClassVar[ConfigDict]', 'model_fields': 'ClassVar[Dict[str, FieldInfo]]', 'type': typing.Literal['plane_intersect_and_project']}[source]

classmethod __class_getitem__(typevar_values)[source]

Return type:: type[BaseModel] | PydanticRecursiveRef

__class_vars__: ClassVar[set[str]] = {}[source]: The names of the class variables defined on the model.

__copy__()[source]

Returns a shallow copy of the model.

Return type:: Self

__deepcopy__(memo=None)[source]

Returns a deep copy of the model.

Return type:: Self

__delattr__(item)[source]

Implement delattr(self, name).

Return type:: Any

__dict__[source]

__eq__(other)[source]

Return self==value.

Return type:: bool

property __fields_set__: set[str][source]

classmethod __get_pydantic_core_schema__(source, handler, /)[source]

Hook into generating the model’s CoreSchema.

Parameters:

source (type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.
handler (GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.

Return type:

Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]

Returns:

A pydantic-core CoreSchema.

classmethod __get_pydantic_json_schema__(core_schema, handler, /)[source]

Hook into generating the model’s JSON schema.

Parameters:

core_schema (Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({'type': 'nullable', 'schema': current_schema}), or just call the handler with the original schema.
handler (GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.

Return type:

Returns:

A JSON schema, as a Python object.

__getattr__(item)[source]

Return type:: Any

__getstate__()[source]

Helper for pickle.

Return type:: dict[Any, Any]

__hash__ = None[source]

__init__(**data)[source]

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__iter__()[source]

So dict(model) works.

Return type:: Generator[Tuple[str, Any], None, None]

__module__ = 'kittycad.models.ok_modeling_cmd_response'[source]

__pretty__(fmt, **kwargs)[source]

Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.

Return type:: Generator[Any, None, None]

__private_attributes__: ClassVar[Dict[str, ModelPrivateAttr]] = {}[source]: Metadata about the private attributes of the model.

__pydantic_complete__: ClassVar[bool] = True[source]: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__: ClassVar[CoreSchema] = {'cls': <class 'kittycad.models.ok_modeling_cmd_response.OptionPlaneIntersectAndProject'>, 'config': {'title': 'OptionPlaneIntersectAndProject'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.ok_modeling_cmd_response.OptionPlaneIntersectAndProject'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.ok_modeling_cmd_response.OptionPlaneIntersectAndProject'>>]}, 'ref': 'kittycad.models.ok_modeling_cmd_response.OptionPlaneIntersectAndProject:94667213897376', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'data': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.plane_intersect_and_project.PlaneIntersectAndProject'>, 'config': {'title': 'PlaneIntersectAndProject'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.plane_intersect_and_project.PlaneIntersectAndProject'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.plane_intersect_and_project.PlaneIntersectAndProject'>>]}, 'ref': 'kittycad.models.plane_intersect_and_project.PlaneIntersectAndProject:94667212378432', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'plane_coordinates': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': None, 'schema': {'schema': {'cls': <class 'kittycad.models.point2d.Point2d'>, 'config': {'title': 'Point2d'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.point2d.Point2d'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.point2d.Point2d'>>]}, 'ref': 'kittycad.models.point2d.Point2d:94667207725712', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'x': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'function': {'function': <class 'kittycad.models.length_unit.LengthUnit'>, 'type': 'no-info'}, 'schema': {'type': 'float'}, 'type': 'function-after'}, 'type': 'model-field'}, 'y': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'function': {'function': <class 'kittycad.models.length_unit.LengthUnit'>, 'type': 'no-info'}, 'schema': {'type': 'float'}, 'type': 'function-after'}, 'type': 'model-field'}}, 'model_name': 'Point2d', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'nullable'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'PlaneIntersectAndProject', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}, 'type': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': 'plane_intersect_and_project', 'schema': {'expected': ['plane_intersect_and_project'], 'type': 'literal'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'OptionPlaneIntersectAndProject', 'type': 'model-fields'}, 'type': 'model'}[source]: The core schema of the model.

__pydantic_custom_init__: ClassVar[bool] = False[source]: Whether the model has a custom __init__ method.

__pydantic_decorators__: ClassVar[_decorators.DecoratorInfos] = DecoratorInfos(validators={}, field_validators={}, root_validators={}, field_serializers={}, model_serializers={}, model_validators={}, computed_fields={})[source]: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_extra__: dict[str, Any] | None[source]: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to 'allow'.

__pydantic_fields_set__: set[str][source]: The names of fields explicitly set during instantiation.

__pydantic_generic_metadata__: ClassVar[_generics.PydanticGenericMetadata] = {'args': (), 'origin': None, 'parameters': ()}[source]: 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.

classmethod __pydantic_init_subclass__(**kwargs)[source]

This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.

This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.

This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.

Parameters:: **kwargs (Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.
Return type:: None

__pydantic_parent_namespace__: ClassVar[Dict[str, Any] | None] = None[source]: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__: ClassVar[None | Literal['model_post_init']] = None[source]: The name of the post-init method for the model, if defined.

__pydantic_private__: dict[str, Any] | None[source]: Values of private attributes set on the model instance.

__pydantic_root_model__: ClassVar[bool] = False[source]: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__: ClassVar[SchemaSerializer] = SchemaSerializer(serializer=Model( ModelSerializer { class: Py( 0x000056196da7fea0, ), serializer: Fields( GeneralFieldsSerializer { fields: { "data": SerField { key_py: Py( 0x00007f9038238fa0, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196d90d140, ), serializer: Fields( GeneralFieldsSerializer { fields: { "plane_coordinates": SerField { key_py: Py( 0x00007f90334bff70, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f9038148100, ), ), serializer: Nullable( NullableSerializer { serializer: Model( ModelSerializer { class: Py( 0x000056196d49d290, ), serializer: Fields( GeneralFieldsSerializer { fields: { "y": SerField { key_py: Py( 0x00007f903823f558, ), alias: None, alias_py: None, serializer: Some( Float( FloatSerializer { inf_nan_mode: Null, }, ), ), required: true, }, "x": SerField { key_py: Py( 0x00007f903823de18, ), alias: None, alias_py: None, serializer: Some( Float( FloatSerializer { inf_nan_mode: Null, }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "Point2d", }, ), }, ), }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 1, }, ), has_extra: false, root_model: false, name: "PlaneIntersectAndProject", }, ), ), required: true, }, "type": SerField { key_py: Py( 0x00007f903823d958, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f90346977d0, ), ), serializer: Literal( LiteralSerializer { expected_int: {}, expected_str: { "plane_intersect_and_project", }, expected_py: None, name: "literal['plane_intersect_and_project']", }, ), }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "OptionPlaneIntersectAndProject", }, ), definitions=[])[source]: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__: ClassVar[SchemaValidator | PluggableSchemaValidator] = SchemaValidator(title="OptionPlaneIntersectAndProject", validator=Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "data", lookup_key: Simple { key: "data", py_key: Py( 0x00007f90333a9b00, ), path: LookupPath( [ S( "data", Py( 0x00007f90333a9b30, ), ), ], ), }, name_py: Py( 0x00007f9038238fa0, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "plane_coordinates", lookup_key: Simple { key: "plane_coordinates", py_key: Py( 0x00007f90333c30f0, ), path: LookupPath( [ S( "plane_coordinates", Py( 0x00007f90333c30b0, ), ), ], ), }, name_py: Py( 0x00007f90334bff70, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f9038148100, ), ), on_error: Raise, validator: Nullable( NullableValidator { validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "x", lookup_key: Simple { key: "x", py_key: Py( 0x00007f903823f528, ), path: LookupPath( [ S( "x", Py( 0x00007f903823f528, ), ), ], ), }, name_py: Py( 0x00007f903823de18, ), validator: FunctionAfter( FunctionAfterValidator { validator: Float( FloatValidator { strict: false, allow_inf_nan: true, }, ), func: Py( 0x000056196d329300, ), config: Py( 0x00007f90333c2dc0, ), name: "function-after[LengthUnit(), float]", field_name: None, info_arg: false, }, ), frozen: false, }, Field { name: "y", lookup_key: Simple { key: "y", py_key: Py( 0x00007f903823f558, ), path: LookupPath( [ S( "y", Py( 0x00007f903823f558, ), ), ], ), }, name_py: Py( 0x00007f903823f558, ), validator: FunctionAfter( FunctionAfterValidator { validator: Float( FloatValidator { strict: false, allow_inf_nan: true, }, ), func: Py( 0x000056196d329300, ), config: Py( 0x00007f90333c2dc0, ), name: "function-after[LengthUnit(), float]", field_name: None, info_arg: false, }, ), frozen: false, }, ], model_name: "Point2d", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d49d290, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "Point2d", }, ), name: "nullable[Point2d]", }, ), validate_default: false, copy_default: false, name: "default[nullable[Point2d]]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "PlaneIntersectAndProject", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d90d140, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "PlaneIntersectAndProject", }, ), frozen: false, }, Field { name: "type", lookup_key: Simple { key: "type", py_key: Py( 0x00007f90333a9b60, ), path: LookupPath( [ S( "type", Py( 0x00007f90333a9b90, ), ), ], ), }, name_py: Py( 0x00007f903823d958, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f90346977d0, ), ), on_error: Raise, validator: Literal( LiteralValidator { lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "plane_intersect_and_project": 0, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f90346977d0, ), ], }, expected_repr: "'plane_intersect_and_project'", name: "literal['plane_intersect_and_project']", }, ), validate_default: false, copy_default: false, name: "default[literal['plane_intersect_and_project']]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "OptionPlaneIntersectAndProject", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196da7fea0, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "OptionPlaneIntersectAndProject", }, ), definitions=[], cache_strings=True)[source]: The pydantic-core SchemaValidator used to validate instances of the model.

__repr__()[source]

Return repr(self).

Return type:: str

__repr_args__()[source]

Return type:: Iterable[tuple[str | None, Any]]

__repr_name__()[source]

Name of the instance’s class, used in __repr__.

Return type:: str

__repr_str__(join_str)[source]

Return type:: str

__rich_repr__()[source]

Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.

Return type:: Iterable[Any | tuple[Any] | tuple[str, Any] | tuple[str, Any, Any]]

__setattr__(name, value)[source]

Implement setattr(self, name, value).

Return type:: None

__setstate__(state)[source]

Return type:: None

__signature__: ClassVar[Signature] = <Signature (*, data: kittycad.models.plane_intersect_and_project.PlaneIntersectAndProject, type: Literal['plane_intersect_and_project'] = 'plane_intersect_and_project') -> None>[source]: The synthesized __init__ [Signature][inspect.Signature] of the model.

__slots__ = ('__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__')[source]

__str__()[source]

Return str(self).

Return type:: str

_abc_impl = <_abc._abc_data object>[source]

_calculate_keys(*args, **kwargs)[source]

Return type:: Any

_check_frozen(name, value)[source]

Return type:: None

_copy_and_set_values(*args, **kwargs)[source]

Return type:: Any

classmethod _get_value(*args, **kwargs)[source]

Return type:: Any

_iter(*args, **kwargs)[source]

Return type:: Any

classmethod construct(_fields_set=None, **values)[source]

Return type:: Self

copy(*, include=None, exclude=None, update=None, deep=False)[source]

Returns a copy of the model.

!!! warning “Deprecated”: This method is now deprecated; use model_copy instead.

If you need include or exclude, use:

`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `

Parameters:

include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.

Returns:

A copy of the model with included, excluded and updated fields as specified.

data: PlaneIntersectAndProject[source]

dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)[source]

Return type:: Dict[str, Any]

classmethod from_orm(obj)[source]

Return type:: Self

json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)[source]

Return type:: str

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}[source]: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'protected_namespaces': ()}[source]: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod model_construct(_fields_set=None, **values)[source]

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note: model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == 'allow', then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == 'ignore' (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == 'forbid' does not result in an error if extra values are passed, but they will be ignored.

Parameters:

_fields_set (set[str] | None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.
values (Any) – Trusted or pre-validated data dictionary.

Return type:

Self

Returns:

A new instance of the Model class with validated data.

model_copy(*, update=None, deep=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy

Returns a copy of the model.

Parameters:

update (dict[str, Any] | None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.
deep (bool) – Set to True to make a deep copy of the model.

Return type:

Self

Returns:

New model instance.

model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters:

mode (Union[Literal['json', 'python'], str]) – The mode in which to_python 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.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to include in the output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to exclude from the output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to use the field’s alias in the dictionary key if defined.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A dictionary representation of the model.

model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

Generates a JSON representation of the model using Pydantic’s to_json method.

Parameters:

indent (int | None) – Indentation to use in the JSON output. If None is passed, the output will be compact.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to include in the JSON output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to exclude from the JSON output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to serialize using field aliases.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A JSON string representation of the model.

property model_extra: dict[str, Any] | None[source]

Get extra fields set during validation.

Returns:: A dictionary of extra fields, or None if config.extra is not set to "allow".

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=PlaneIntersectAndProject, required=True), 'type': FieldInfo(annotation=Literal['plane_intersect_and_project'], required=False, default='plane_intersect_and_project')}[source]

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

property model_fields_set: set[str][source]

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,: i.e. that were not filled from defaults.

classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')[source]

Generates a JSON schema for a model class.

Parameters:

by_alias (bool) – Whether to use attribute aliases or not.
ref_template (str) – The reference template.
schema_generator (type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modifications
mode (Literal['validation', 'serialization']) – The mode in which to generate the schema.

Return type:

Returns:

The JSON schema for the given model class.

classmethod model_parametrized_name(params)[source]

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

Parameters:: params (tuple[type[Any], ...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.
Return type:: str
Returns:: String representing the new class where params are passed to cls as type variables.
Raises:: TypeError – Raised when trying to generate concrete names for non-generic models.

model_post_init(_BaseModel__context)[source]

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

Return type:: None

classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)[source]

Try to rebuild the pydantic-core schema for the model.

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.

Parameters:

force (bool) – Whether to force the rebuilding of the model schema, defaults to False.
raise_errors (bool) – Whether to raise errors, defaults to True.
_parent_namespace_depth (int) – The depth level of the parent namespace, defaults to 2.
_types_namespace (dict[str, Any] | None) – The types namespace, defaults to None.

Return type:

Returns:

Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.

classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)[source]

Validate a pydantic model instance.

Parameters:

obj (Any) – The object to validate.
strict (bool | None) – Whether to enforce types strictly.
from_attributes (bool | None) – Whether to extract data from object attributes.
context (Any | None) – Additional context to pass to the validator.

Raises:

ValidationError – If the object could not be validated.

Return type:

Self

Returns:

The validated model instance.

classmethod model_validate_json(json_data, *, strict=None, context=None)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing

Validate the given JSON data against the Pydantic model.

Parameters:

json_data (str | bytes | bytearray) – The JSON data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

Raises:

ValidationError – If json_data is not a JSON string or the object could not be validated.

classmethod model_validate_strings(obj, *, strict=None, context=None)[source]

Validate the given object with string data against the Pydantic model.

Parameters:

obj (Any) – The object containing string data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod parse_obj(obj)[source]

Return type:: Self

classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod schema(by_alias=True, ref_template='#/$defs/{model}')[source]

Return type:: Dict[str, Any]

classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)[source]

Return type:: str

type: Literal['plane_intersect_and_project'][source]

classmethod update_forward_refs(**localns)[source]

Return type:: None

classmethod validate(value)[source]

Return type:: Self

class kittycad.models.ok_modeling_cmd_response.OptionPlaneSetColor(**data)[source][source]

The response to the ‘PlaneSetColor’ endpoint

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__abstractmethods__ = frozenset({})[source]

__annotations__ = {'__class_vars__': 'ClassVar[set[str]]', '__private_attributes__': 'ClassVar[Dict[str, ModelPrivateAttr]]', '__pydantic_complete__': 'ClassVar[bool]', '__pydantic_core_schema__': 'ClassVar[CoreSchema]', '__pydantic_custom_init__': 'ClassVar[bool]', '__pydantic_decorators__': 'ClassVar[_decorators.DecoratorInfos]', '__pydantic_extra__': 'dict[str, Any] | None', '__pydantic_fields_set__': 'set[str]', '__pydantic_generic_metadata__': 'ClassVar[_generics.PydanticGenericMetadata]', '__pydantic_parent_namespace__': 'ClassVar[Dict[str, Any] | None]', '__pydantic_post_init__': "ClassVar[None | Literal['model_post_init']]", '__pydantic_private__': 'dict[str, Any] | None', '__pydantic_root_model__': 'ClassVar[bool]', '__pydantic_serializer__': 'ClassVar[SchemaSerializer]', '__pydantic_validator__': 'ClassVar[SchemaValidator | PluggableSchemaValidator]', '__signature__': 'ClassVar[Signature]', 'data': <class 'kittycad.models.plane_set_color.PlaneSetColor'>, 'model_computed_fields': 'ClassVar[Dict[str, ComputedFieldInfo]]', 'model_config': 'ClassVar[ConfigDict]', 'model_fields': 'ClassVar[Dict[str, FieldInfo]]', 'type': typing.Literal['plane_set_color']}[source]

classmethod __class_getitem__(typevar_values)[source]

Return type:: type[BaseModel] | PydanticRecursiveRef

__class_vars__: ClassVar[set[str]] = {}[source]: The names of the class variables defined on the model.

__copy__()[source]

Returns a shallow copy of the model.

Return type:: Self

__deepcopy__(memo=None)[source]

Returns a deep copy of the model.

Return type:: Self

__delattr__(item)[source]

Implement delattr(self, name).

Return type:: Any

__dict__[source]

__eq__(other)[source]

Return self==value.

Return type:: bool

property __fields_set__: set[str][source]

classmethod __get_pydantic_core_schema__(source, handler, /)[source]

Hook into generating the model’s CoreSchema.

Parameters:

source (type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.
handler (GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.

Return type:

Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]

Returns:

A pydantic-core CoreSchema.

classmethod __get_pydantic_json_schema__(core_schema, handler, /)[source]

Hook into generating the model’s JSON schema.

Parameters:

core_schema (Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({'type': 'nullable', 'schema': current_schema}), or just call the handler with the original schema.
handler (GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.

Return type:

Returns:

A JSON schema, as a Python object.

__getattr__(item)[source]

Return type:: Any

__getstate__()[source]

Helper for pickle.

Return type:: dict[Any, Any]

__hash__ = None[source]

__init__(**data)[source]

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__iter__()[source]

So dict(model) works.

Return type:: Generator[Tuple[str, Any], None, None]

__module__ = 'kittycad.models.ok_modeling_cmd_response'[source]

__pretty__(fmt, **kwargs)[source]

Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.

Return type:: Generator[Any, None, None]

__private_attributes__: ClassVar[Dict[str, ModelPrivateAttr]] = {}[source]: Metadata about the private attributes of the model.

__pydantic_complete__: ClassVar[bool] = True[source]: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__: ClassVar[CoreSchema] = {'cls': <class 'kittycad.models.ok_modeling_cmd_response.OptionPlaneSetColor'>, 'config': {'title': 'OptionPlaneSetColor'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.ok_modeling_cmd_response.OptionPlaneSetColor'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.ok_modeling_cmd_response.OptionPlaneSetColor'>>]}, 'ref': 'kittycad.models.ok_modeling_cmd_response.OptionPlaneSetColor:94667212989968', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'data': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.plane_set_color.PlaneSetColor'>, 'config': {'title': 'PlaneSetColor'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.plane_set_color.PlaneSetColor'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.plane_set_color.PlaneSetColor'>>]}, 'ref': 'kittycad.models.plane_set_color.PlaneSetColor:94667212383840', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {}, 'model_name': 'PlaneSetColor', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}, 'type': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': 'plane_set_color', 'schema': {'expected': ['plane_set_color'], 'type': 'literal'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'OptionPlaneSetColor', 'type': 'model-fields'}, 'type': 'model'}[source]: The core schema of the model.

__pydantic_custom_init__: ClassVar[bool] = False[source]: Whether the model has a custom __init__ method.

__pydantic_decorators__: ClassVar[_decorators.DecoratorInfos] = DecoratorInfos(validators={}, field_validators={}, root_validators={}, field_serializers={}, model_serializers={}, model_validators={}, computed_fields={})[source]: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_extra__: dict[str, Any] | None[source]: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to 'allow'.

__pydantic_fields_set__: set[str][source]: The names of fields explicitly set during instantiation.

__pydantic_generic_metadata__: ClassVar[_generics.PydanticGenericMetadata] = {'args': (), 'origin': None, 'parameters': ()}[source]: 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.

classmethod __pydantic_init_subclass__(**kwargs)[source]

This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.

This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.

This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.

Parameters:: **kwargs (Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.
Return type:: None

__pydantic_parent_namespace__: ClassVar[Dict[str, Any] | None] = None[source]: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__: ClassVar[None | Literal['model_post_init']] = None[source]: The name of the post-init method for the model, if defined.

__pydantic_private__: dict[str, Any] | None[source]: Values of private attributes set on the model instance.

__pydantic_root_model__: ClassVar[bool] = False[source]: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__: ClassVar[SchemaSerializer] = SchemaSerializer(serializer=Model( ModelSerializer { class: Py( 0x000056196d9a2610, ), serializer: Fields( GeneralFieldsSerializer { fields: { "type": SerField { key_py: Py( 0x00007f903823d958, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f90346e5030, ), ), serializer: Literal( LiteralSerializer { expected_int: {}, expected_str: { "plane_set_color", }, expected_py: None, name: "literal['plane_set_color']", }, ), }, ), ), required: true, }, "data": SerField { key_py: Py( 0x00007f9038238fa0, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196d90e660, ), serializer: Fields( GeneralFieldsSerializer { fields: {}, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 0, }, ), has_extra: false, root_model: false, name: "PlaneSetColor", }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "OptionPlaneSetColor", }, ), definitions=[])[source]: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__: ClassVar[SchemaValidator | PluggableSchemaValidator] = SchemaValidator(title="OptionPlaneSetColor", validator=Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "data", lookup_key: Simple { key: "data", py_key: Py( 0x00007f90334d6700, ), path: LookupPath( [ S( "data", Py( 0x00007f90334d6730, ), ), ], ), }, name_py: Py( 0x00007f9038238fa0, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [], model_name: "PlaneSetColor", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d90e660, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "PlaneSetColor", }, ), frozen: false, }, Field { name: "type", lookup_key: Simple { key: "type", py_key: Py( 0x00007f90334d6760, ), path: LookupPath( [ S( "type", Py( 0x00007f90334d6790, ), ), ], ), }, name_py: Py( 0x00007f903823d958, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f90346e5030, ), ), on_error: Raise, validator: Literal( LiteralValidator { lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "plane_set_color": 0, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f90346e5030, ), ], }, expected_repr: "'plane_set_color'", name: "literal['plane_set_color']", }, ), validate_default: false, copy_default: false, name: "default[literal['plane_set_color']]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "OptionPlaneSetColor", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d9a2610, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "OptionPlaneSetColor", }, ), definitions=[], cache_strings=True)[source]: The pydantic-core SchemaValidator used to validate instances of the model.

__repr__()[source]

Return repr(self).

Return type:: str

__repr_args__()[source]

Return type:: Iterable[tuple[str | None, Any]]

__repr_name__()[source]

Name of the instance’s class, used in __repr__.

Return type:: str

__repr_str__(join_str)[source]

Return type:: str

__rich_repr__()[source]

Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.

Return type:: Iterable[Any | tuple[Any] | tuple[str, Any] | tuple[str, Any, Any]]

__setattr__(name, value)[source]

Implement setattr(self, name, value).

Return type:: None

__setstate__(state)[source]

Return type:: None

__signature__: ClassVar[Signature] = <Signature (*, data: kittycad.models.plane_set_color.PlaneSetColor, type: Literal['plane_set_color'] = 'plane_set_color') -> None>[source]: The synthesized __init__ [Signature][inspect.Signature] of the model.

__slots__ = ('__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__')[source]

__str__()[source]

Return str(self).

Return type:: str

_abc_impl = <_abc._abc_data object>[source]

_calculate_keys(*args, **kwargs)[source]

Return type:: Any

_check_frozen(name, value)[source]

Return type:: None

_copy_and_set_values(*args, **kwargs)[source]

Return type:: Any

classmethod _get_value(*args, **kwargs)[source]

Return type:: Any

_iter(*args, **kwargs)[source]

Return type:: Any

classmethod construct(_fields_set=None, **values)[source]

Return type:: Self

copy(*, include=None, exclude=None, update=None, deep=False)[source]

Returns a copy of the model.

!!! warning “Deprecated”: This method is now deprecated; use model_copy instead.

If you need include or exclude, use:

`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `

Parameters:

include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.

Returns:

A copy of the model with included, excluded and updated fields as specified.

data: PlaneSetColor[source]

dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)[source]

Return type:: Dict[str, Any]

classmethod from_orm(obj)[source]

Return type:: Self

json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)[source]

Return type:: str

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}[source]: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'protected_namespaces': ()}[source]: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod model_construct(_fields_set=None, **values)[source]

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note: model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == 'allow', then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == 'ignore' (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == 'forbid' does not result in an error if extra values are passed, but they will be ignored.

Parameters:

_fields_set (set[str] | None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.
values (Any) – Trusted or pre-validated data dictionary.

Return type:

Self

Returns:

A new instance of the Model class with validated data.

model_copy(*, update=None, deep=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy

Returns a copy of the model.

Parameters:

update (dict[str, Any] | None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.
deep (bool) – Set to True to make a deep copy of the model.

Return type:

Self

Returns:

New model instance.

model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters:

mode (Union[Literal['json', 'python'], str]) – The mode in which to_python 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.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to include in the output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to exclude from the output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to use the field’s alias in the dictionary key if defined.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A dictionary representation of the model.

model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

Generates a JSON representation of the model using Pydantic’s to_json method.

Parameters:

indent (int | None) – Indentation to use in the JSON output. If None is passed, the output will be compact.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to include in the JSON output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to exclude from the JSON output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to serialize using field aliases.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A JSON string representation of the model.

property model_extra: dict[str, Any] | None[source]

Get extra fields set during validation.

Returns:: A dictionary of extra fields, or None if config.extra is not set to "allow".

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=PlaneSetColor, required=True), 'type': FieldInfo(annotation=Literal['plane_set_color'], required=False, default='plane_set_color')}[source]

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

property model_fields_set: set[str][source]

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,: i.e. that were not filled from defaults.

classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')[source]

Generates a JSON schema for a model class.

Parameters:

by_alias (bool) – Whether to use attribute aliases or not.
ref_template (str) – The reference template.
schema_generator (type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modifications
mode (Literal['validation', 'serialization']) – The mode in which to generate the schema.

Return type:

Returns:

The JSON schema for the given model class.

classmethod model_parametrized_name(params)[source]

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

Parameters:: params (tuple[type[Any], ...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.
Return type:: str
Returns:: String representing the new class where params are passed to cls as type variables.
Raises:: TypeError – Raised when trying to generate concrete names for non-generic models.

model_post_init(_BaseModel__context)[source]

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

Return type:: None

classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)[source]

Try to rebuild the pydantic-core schema for the model.

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.

Parameters:

force (bool) – Whether to force the rebuilding of the model schema, defaults to False.
raise_errors (bool) – Whether to raise errors, defaults to True.
_parent_namespace_depth (int) – The depth level of the parent namespace, defaults to 2.
_types_namespace (dict[str, Any] | None) – The types namespace, defaults to None.

Return type:

Returns:

Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.

classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)[source]

Validate a pydantic model instance.

Parameters:

obj (Any) – The object to validate.
strict (bool | None) – Whether to enforce types strictly.
from_attributes (bool | None) – Whether to extract data from object attributes.
context (Any | None) – Additional context to pass to the validator.

Raises:

ValidationError – If the object could not be validated.

Return type:

Self

Returns:

The validated model instance.

classmethod model_validate_json(json_data, *, strict=None, context=None)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing

Validate the given JSON data against the Pydantic model.

Parameters:

json_data (str | bytes | bytearray) – The JSON data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

Raises:

ValidationError – If json_data is not a JSON string or the object could not be validated.

classmethod model_validate_strings(obj, *, strict=None, context=None)[source]

Validate the given object with string data against the Pydantic model.

Parameters:

obj (Any) – The object containing string data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod parse_obj(obj)[source]

Return type:: Self

classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod schema(by_alias=True, ref_template='#/$defs/{model}')[source]

Return type:: Dict[str, Any]

classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)[source]

Return type:: str

type: Literal['plane_set_color'][source]

classmethod update_forward_refs(**localns)[source]

Return type:: None

classmethod validate(value)[source]

Return type:: Self

class kittycad.models.ok_modeling_cmd_response.OptionReconfigureStream(**data)[source][source]

The response to the ‘ReconfigureStream’ endpoint

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__abstractmethods__ = frozenset({})[source]

__annotations__ = {'__class_vars__': 'ClassVar[set[str]]', '__private_attributes__': 'ClassVar[Dict[str, ModelPrivateAttr]]', '__pydantic_complete__': 'ClassVar[bool]', '__pydantic_core_schema__': 'ClassVar[CoreSchema]', '__pydantic_custom_init__': 'ClassVar[bool]', '__pydantic_decorators__': 'ClassVar[_decorators.DecoratorInfos]', '__pydantic_extra__': 'dict[str, Any] | None', '__pydantic_fields_set__': 'set[str]', '__pydantic_generic_metadata__': 'ClassVar[_generics.PydanticGenericMetadata]', '__pydantic_parent_namespace__': 'ClassVar[Dict[str, Any] | None]', '__pydantic_post_init__': "ClassVar[None | Literal['model_post_init']]", '__pydantic_private__': 'dict[str, Any] | None', '__pydantic_root_model__': 'ClassVar[bool]', '__pydantic_serializer__': 'ClassVar[SchemaSerializer]', '__pydantic_validator__': 'ClassVar[SchemaValidator | PluggableSchemaValidator]', '__signature__': 'ClassVar[Signature]', 'data': <class 'kittycad.models.reconfigure_stream.ReconfigureStream'>, 'model_computed_fields': 'ClassVar[Dict[str, ComputedFieldInfo]]', 'model_config': 'ClassVar[ConfigDict]', 'model_fields': 'ClassVar[Dict[str, FieldInfo]]', 'type': typing.Literal['reconfigure_stream']}[source]

classmethod __class_getitem__(typevar_values)[source]

Return type:: type[BaseModel] | PydanticRecursiveRef

__class_vars__: ClassVar[set[str]] = {}[source]: The names of the class variables defined on the model.

__copy__()[source]

Returns a shallow copy of the model.

Return type:: Self

__deepcopy__(memo=None)[source]

Returns a deep copy of the model.

Return type:: Self

__delattr__(item)[source]

Implement delattr(self, name).

Return type:: Any

__dict__[source]

__eq__(other)[source]

Return self==value.

Return type:: bool

property __fields_set__: set[str][source]

classmethod __get_pydantic_core_schema__(source, handler, /)[source]

Hook into generating the model’s CoreSchema.

Parameters:

source (type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.
handler (GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.

Return type:

Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]

Returns:

A pydantic-core CoreSchema.

classmethod __get_pydantic_json_schema__(core_schema, handler, /)[source]

Hook into generating the model’s JSON schema.

Parameters:

core_schema (Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({'type': 'nullable', 'schema': current_schema}), or just call the handler with the original schema.
handler (GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.

Return type:

Returns:

A JSON schema, as a Python object.

__getattr__(item)[source]

Return type:: Any

__getstate__()[source]

Helper for pickle.

Return type:: dict[Any, Any]

__hash__ = None[source]

__init__(**data)[source]

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__iter__()[source]

So dict(model) works.

Return type:: Generator[Tuple[str, Any], None, None]

__module__ = 'kittycad.models.ok_modeling_cmd_response'[source]

__pretty__(fmt, **kwargs)[source]

Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.

Return type:: Generator[Any, None, None]

__private_attributes__: ClassVar[Dict[str, ModelPrivateAttr]] = {}[source]: Metadata about the private attributes of the model.

__pydantic_complete__: ClassVar[bool] = True[source]: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__: ClassVar[CoreSchema] = {'cls': <class 'kittycad.models.ok_modeling_cmd_response.OptionReconfigureStream'>, 'config': {'title': 'OptionReconfigureStream'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.ok_modeling_cmd_response.OptionReconfigureStream'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.ok_modeling_cmd_response.OptionReconfigureStream'>>]}, 'ref': 'kittycad.models.ok_modeling_cmd_response.OptionReconfigureStream:94667213124160', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'data': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.reconfigure_stream.ReconfigureStream'>, 'config': {'title': 'ReconfigureStream'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.reconfigure_stream.ReconfigureStream'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.reconfigure_stream.ReconfigureStream'>>]}, 'ref': 'kittycad.models.reconfigure_stream.ReconfigureStream:94667212386688', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {}, 'model_name': 'ReconfigureStream', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}, 'type': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': 'reconfigure_stream', 'schema': {'expected': ['reconfigure_stream'], 'type': 'literal'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'OptionReconfigureStream', 'type': 'model-fields'}, 'type': 'model'}[source]: The core schema of the model.

__pydantic_custom_init__: ClassVar[bool] = False[source]: Whether the model has a custom __init__ method.

__pydantic_decorators__: ClassVar[_decorators.DecoratorInfos] = DecoratorInfos(validators={}, field_validators={}, root_validators={}, field_serializers={}, model_serializers={}, model_validators={}, computed_fields={})[source]: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_extra__: dict[str, Any] | None[source]: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to 'allow'.

__pydantic_fields_set__: set[str][source]: The names of fields explicitly set during instantiation.

__pydantic_generic_metadata__: ClassVar[_generics.PydanticGenericMetadata] = {'args': (), 'origin': None, 'parameters': ()}[source]: 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.

classmethod __pydantic_init_subclass__(**kwargs)[source]

This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.

This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.

This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.

Parameters:: **kwargs (Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.
Return type:: None

__pydantic_parent_namespace__: ClassVar[Dict[str, Any] | None] = None[source]: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__: ClassVar[None | Literal['model_post_init']] = None[source]: The name of the post-init method for the model, if defined.

__pydantic_private__: dict[str, Any] | None[source]: Values of private attributes set on the model instance.

__pydantic_root_model__: ClassVar[bool] = False[source]: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__: ClassVar[SchemaSerializer] = SchemaSerializer(serializer=Model( ModelSerializer { class: Py( 0x000056196d9c3240, ), serializer: Fields( GeneralFieldsSerializer { fields: { "type": SerField { key_py: Py( 0x00007f903823d958, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f90346e52f0, ), ), serializer: Literal( LiteralSerializer { expected_int: {}, expected_str: { "reconfigure_stream", }, expected_py: None, name: "literal['reconfigure_stream']", }, ), }, ), ), required: true, }, "data": SerField { key_py: Py( 0x00007f9038238fa0, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196d90f180, ), serializer: Fields( GeneralFieldsSerializer { fields: {}, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 0, }, ), has_extra: false, root_model: false, name: "ReconfigureStream", }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "OptionReconfigureStream", }, ), definitions=[])[source]: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__: ClassVar[SchemaValidator | PluggableSchemaValidator] = SchemaValidator(title="OptionReconfigureStream", validator=Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "data", lookup_key: Simple { key: "data", py_key: Py( 0x00007f9033520ba0, ), path: LookupPath( [ S( "data", Py( 0x00007f9033520bd0, ), ), ], ), }, name_py: Py( 0x00007f9038238fa0, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [], model_name: "ReconfigureStream", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d90f180, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "ReconfigureStream", }, ), frozen: false, }, Field { name: "type", lookup_key: Simple { key: "type", py_key: Py( 0x00007f9033520c00, ), path: LookupPath( [ S( "type", Py( 0x00007f9033520c30, ), ), ], ), }, name_py: Py( 0x00007f903823d958, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f90346e52f0, ), ), on_error: Raise, validator: Literal( LiteralValidator { lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "reconfigure_stream": 0, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f90346e52f0, ), ], }, expected_repr: "'reconfigure_stream'", name: "literal['reconfigure_stream']", }, ), validate_default: false, copy_default: false, name: "default[literal['reconfigure_stream']]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "OptionReconfigureStream", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d9c3240, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "OptionReconfigureStream", }, ), definitions=[], cache_strings=True)[source]: The pydantic-core SchemaValidator used to validate instances of the model.

__repr__()[source]

Return repr(self).

Return type:: str

__repr_args__()[source]

Return type:: Iterable[tuple[str | None, Any]]

__repr_name__()[source]

Name of the instance’s class, used in __repr__.

Return type:: str

__repr_str__(join_str)[source]

Return type:: str

__rich_repr__()[source]

Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.

Return type:: Iterable[Any | tuple[Any] | tuple[str, Any] | tuple[str, Any, Any]]

__setattr__(name, value)[source]

Implement setattr(self, name, value).

Return type:: None

__setstate__(state)[source]

Return type:: None

__signature__: ClassVar[Signature] = <Signature (*, data: kittycad.models.reconfigure_stream.ReconfigureStream, type: Literal['reconfigure_stream'] = 'reconfigure_stream') -> None>[source]: The synthesized __init__ [Signature][inspect.Signature] of the model.

__slots__ = ('__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__')[source]

__str__()[source]

Return str(self).

Return type:: str

_abc_impl = <_abc._abc_data object>[source]

_calculate_keys(*args, **kwargs)[source]

Return type:: Any

_check_frozen(name, value)[source]

Return type:: None

_copy_and_set_values(*args, **kwargs)[source]

Return type:: Any

classmethod _get_value(*args, **kwargs)[source]

Return type:: Any

_iter(*args, **kwargs)[source]

Return type:: Any

classmethod construct(_fields_set=None, **values)[source]

Return type:: Self

copy(*, include=None, exclude=None, update=None, deep=False)[source]

Returns a copy of the model.

!!! warning “Deprecated”: This method is now deprecated; use model_copy instead.

If you need include or exclude, use:

`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `

Parameters:

include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.

Returns:

A copy of the model with included, excluded and updated fields as specified.

data: ReconfigureStream[source]

dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)[source]

Return type:: Dict[str, Any]

classmethod from_orm(obj)[source]

Return type:: Self

json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)[source]

Return type:: str

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}[source]: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'protected_namespaces': ()}[source]: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod model_construct(_fields_set=None, **values)[source]

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note: model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == 'allow', then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == 'ignore' (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == 'forbid' does not result in an error if extra values are passed, but they will be ignored.

Parameters:

_fields_set (set[str] | None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.
values (Any) – Trusted or pre-validated data dictionary.

Return type:

Self

Returns:

A new instance of the Model class with validated data.

model_copy(*, update=None, deep=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy

Returns a copy of the model.

Parameters:

update (dict[str, Any] | None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.
deep (bool) – Set to True to make a deep copy of the model.

Return type:

Self

Returns:

New model instance.

model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters:

mode (Union[Literal['json', 'python'], str]) – The mode in which to_python 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.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to include in the output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to exclude from the output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to use the field’s alias in the dictionary key if defined.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A dictionary representation of the model.

model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

Generates a JSON representation of the model using Pydantic’s to_json method.

Parameters:

indent (int | None) – Indentation to use in the JSON output. If None is passed, the output will be compact.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to include in the JSON output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to exclude from the JSON output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to serialize using field aliases.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A JSON string representation of the model.

property model_extra: dict[str, Any] | None[source]

Get extra fields set during validation.

Returns:: A dictionary of extra fields, or None if config.extra is not set to "allow".

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=ReconfigureStream, required=True), 'type': FieldInfo(annotation=Literal['reconfigure_stream'], required=False, default='reconfigure_stream')}[source]

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

property model_fields_set: set[str][source]

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,: i.e. that were not filled from defaults.

classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')[source]

Generates a JSON schema for a model class.

Parameters:

by_alias (bool) – Whether to use attribute aliases or not.
ref_template (str) – The reference template.
schema_generator (type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modifications
mode (Literal['validation', 'serialization']) – The mode in which to generate the schema.

Return type:

Returns:

The JSON schema for the given model class.

classmethod model_parametrized_name(params)[source]

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

Parameters:: params (tuple[type[Any], ...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.
Return type:: str
Returns:: String representing the new class where params are passed to cls as type variables.
Raises:: TypeError – Raised when trying to generate concrete names for non-generic models.

model_post_init(_BaseModel__context)[source]

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

Return type:: None

classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)[source]

Try to rebuild the pydantic-core schema for the model.

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.

Parameters:

force (bool) – Whether to force the rebuilding of the model schema, defaults to False.
raise_errors (bool) – Whether to raise errors, defaults to True.
_parent_namespace_depth (int) – The depth level of the parent namespace, defaults to 2.
_types_namespace (dict[str, Any] | None) – The types namespace, defaults to None.

Return type:

Returns:

Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.

classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)[source]

Validate a pydantic model instance.

Parameters:

obj (Any) – The object to validate.
strict (bool | None) – Whether to enforce types strictly.
from_attributes (bool | None) – Whether to extract data from object attributes.
context (Any | None) – Additional context to pass to the validator.

Raises:

ValidationError – If the object could not be validated.

Return type:

Self

Returns:

The validated model instance.

classmethod model_validate_json(json_data, *, strict=None, context=None)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing

Validate the given JSON data against the Pydantic model.

Parameters:

json_data (str | bytes | bytearray) – The JSON data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

Raises:

ValidationError – If json_data is not a JSON string or the object could not be validated.

classmethod model_validate_strings(obj, *, strict=None, context=None)[source]

Validate the given object with string data against the Pydantic model.

Parameters:

obj (Any) – The object containing string data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod parse_obj(obj)[source]

Return type:: Self

classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod schema(by_alias=True, ref_template='#/$defs/{model}')[source]

Return type:: Dict[str, Any]

classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)[source]

Return type:: str

type: Literal['reconfigure_stream'][source]

classmethod update_forward_refs(**localns)[source]

Return type:: None

classmethod validate(value)[source]

Return type:: Self

class kittycad.models.ok_modeling_cmd_response.OptionRemoveSceneObjects(**data)[source][source]

The response to the ‘RemoveSceneObjects’ endpoint

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__abstractmethods__ = frozenset({})[source]

__annotations__ = {'__class_vars__': 'ClassVar[set[str]]', '__private_attributes__': 'ClassVar[Dict[str, ModelPrivateAttr]]', '__pydantic_complete__': 'ClassVar[bool]', '__pydantic_core_schema__': 'ClassVar[CoreSchema]', '__pydantic_custom_init__': 'ClassVar[bool]', '__pydantic_decorators__': 'ClassVar[_decorators.DecoratorInfos]', '__pydantic_extra__': 'dict[str, Any] | None', '__pydantic_fields_set__': 'set[str]', '__pydantic_generic_metadata__': 'ClassVar[_generics.PydanticGenericMetadata]', '__pydantic_parent_namespace__': 'ClassVar[Dict[str, Any] | None]', '__pydantic_post_init__': "ClassVar[None | Literal['model_post_init']]", '__pydantic_private__': 'dict[str, Any] | None', '__pydantic_root_model__': 'ClassVar[bool]', '__pydantic_serializer__': 'ClassVar[SchemaSerializer]', '__pydantic_validator__': 'ClassVar[SchemaValidator | PluggableSchemaValidator]', '__signature__': 'ClassVar[Signature]', 'data': <class 'kittycad.models.remove_scene_objects.RemoveSceneObjects'>, 'model_computed_fields': 'ClassVar[Dict[str, ComputedFieldInfo]]', 'model_config': 'ClassVar[ConfigDict]', 'model_fields': 'ClassVar[Dict[str, FieldInfo]]', 'type': typing.Literal['remove_scene_objects']}[source]

classmethod __class_getitem__(typevar_values)[source]

Return type:: type[BaseModel] | PydanticRecursiveRef

__class_vars__: ClassVar[set[str]] = {}[source]: The names of the class variables defined on the model.

__copy__()[source]

Returns a shallow copy of the model.

Return type:: Self

__deepcopy__(memo=None)[source]

Returns a deep copy of the model.

Return type:: Self

__delattr__(item)[source]

Implement delattr(self, name).

Return type:: Any

__dict__[source]

__eq__(other)[source]

Return self==value.

Return type:: bool

property __fields_set__: set[str][source]

classmethod __get_pydantic_core_schema__(source, handler, /)[source]

Hook into generating the model’s CoreSchema.

Parameters:

source (type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.
handler (GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.

Return type:

Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]

Returns:

A pydantic-core CoreSchema.

classmethod __get_pydantic_json_schema__(core_schema, handler, /)[source]

Hook into generating the model’s JSON schema.

Parameters:

core_schema (Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({'type': 'nullable', 'schema': current_schema}), or just call the handler with the original schema.
handler (GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.

Return type:

Returns:

A JSON schema, as a Python object.

__getattr__(item)[source]

Return type:: Any

__getstate__()[source]

Helper for pickle.

Return type:: dict[Any, Any]

__hash__ = None[source]

__init__(**data)[source]

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__iter__()[source]

So dict(model) works.

Return type:: Generator[Tuple[str, Any], None, None]

__module__ = 'kittycad.models.ok_modeling_cmd_response'[source]

__pretty__(fmt, **kwargs)[source]

Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.

Return type:: Generator[Any, None, None]

__private_attributes__: ClassVar[Dict[str, ModelPrivateAttr]] = {}[source]: Metadata about the private attributes of the model.

__pydantic_complete__: ClassVar[bool] = True[source]: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__: ClassVar[CoreSchema] = {'cls': <class 'kittycad.models.ok_modeling_cmd_response.OptionRemoveSceneObjects'>, 'config': {'title': 'OptionRemoveSceneObjects'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.ok_modeling_cmd_response.OptionRemoveSceneObjects'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.ok_modeling_cmd_response.OptionRemoveSceneObjects'>>]}, 'ref': 'kittycad.models.ok_modeling_cmd_response.OptionRemoveSceneObjects:94667213114848', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'data': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.remove_scene_objects.RemoveSceneObjects'>, 'config': {'title': 'RemoveSceneObjects'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.remove_scene_objects.RemoveSceneObjects'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.remove_scene_objects.RemoveSceneObjects'>>]}, 'ref': 'kittycad.models.remove_scene_objects.RemoveSceneObjects:94667212404176', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {}, 'model_name': 'RemoveSceneObjects', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}, 'type': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': 'remove_scene_objects', 'schema': {'expected': ['remove_scene_objects'], 'type': 'literal'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'OptionRemoveSceneObjects', 'type': 'model-fields'}, 'type': 'model'}[source]: The core schema of the model.

__pydantic_custom_init__: ClassVar[bool] = False[source]: Whether the model has a custom __init__ method.

__pydantic_decorators__: ClassVar[_decorators.DecoratorInfos] = DecoratorInfos(validators={}, field_validators={}, root_validators={}, field_serializers={}, model_serializers={}, model_validators={}, computed_fields={})[source]: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_extra__: dict[str, Any] | None[source]: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to 'allow'.

__pydantic_fields_set__: set[str][source]: The names of fields explicitly set during instantiation.

__pydantic_generic_metadata__: ClassVar[_generics.PydanticGenericMetadata] = {'args': (), 'origin': None, 'parameters': ()}[source]: 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.

classmethod __pydantic_init_subclass__(**kwargs)[source]

This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.

This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.

This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.

Parameters:: **kwargs (Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.
Return type:: None

__pydantic_parent_namespace__: ClassVar[Dict[str, Any] | None] = None[source]: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__: ClassVar[None | Literal['model_post_init']] = None[source]: The name of the post-init method for the model, if defined.

__pydantic_private__: dict[str, Any] | None[source]: Values of private attributes set on the model instance.

__pydantic_root_model__: ClassVar[bool] = False[source]: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__: ClassVar[SchemaSerializer] = SchemaSerializer(serializer=Model( ModelSerializer { class: Py( 0x000056196d9c0de0, ), serializer: Fields( GeneralFieldsSerializer { fields: { "type": SerField { key_py: Py( 0x00007f903823d958, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f90346e53f0, ), ), serializer: Literal( LiteralSerializer { expected_int: {}, expected_str: { "remove_scene_objects", }, expected_py: None, name: "literal['remove_scene_objects']", }, ), }, ), ), required: true, }, "data": SerField { key_py: Py( 0x00007f9038238fa0, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196d9135d0, ), serializer: Fields( GeneralFieldsSerializer { fields: {}, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 0, }, ), has_extra: false, root_model: false, name: "RemoveSceneObjects", }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "OptionRemoveSceneObjects", }, ), definitions=[])[source]: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__: ClassVar[SchemaValidator | PluggableSchemaValidator] = SchemaValidator(title="OptionRemoveSceneObjects", validator=Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "data", lookup_key: Simple { key: "data", py_key: Py( 0x00007f90335206f0, ), path: LookupPath( [ S( "data", Py( 0x00007f9033520720, ), ), ], ), }, name_py: Py( 0x00007f9038238fa0, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [], model_name: "RemoveSceneObjects", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d9135d0, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "RemoveSceneObjects", }, ), frozen: false, }, Field { name: "type", lookup_key: Simple { key: "type", py_key: Py( 0x00007f9033520750, ), path: LookupPath( [ S( "type", Py( 0x00007f9033520780, ), ), ], ), }, name_py: Py( 0x00007f903823d958, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f90346e53f0, ), ), on_error: Raise, validator: Literal( LiteralValidator { lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "remove_scene_objects": 0, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f90346e53f0, ), ], }, expected_repr: "'remove_scene_objects'", name: "literal['remove_scene_objects']", }, ), validate_default: false, copy_default: false, name: "default[literal['remove_scene_objects']]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "OptionRemoveSceneObjects", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d9c0de0, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "OptionRemoveSceneObjects", }, ), definitions=[], cache_strings=True)[source]: The pydantic-core SchemaValidator used to validate instances of the model.

__repr__()[source]

Return repr(self).

Return type:: str

__repr_args__()[source]

Return type:: Iterable[tuple[str | None, Any]]

__repr_name__()[source]

Name of the instance’s class, used in __repr__.

Return type:: str

__repr_str__(join_str)[source]

Return type:: str

__rich_repr__()[source]

Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.

Return type:: Iterable[Any | tuple[Any] | tuple[str, Any] | tuple[str, Any, Any]]

__setattr__(name, value)[source]

Implement setattr(self, name, value).

Return type:: None

__setstate__(state)[source]

Return type:: None

__signature__: ClassVar[Signature] = <Signature (*, data: kittycad.models.remove_scene_objects.RemoveSceneObjects, type: Literal['remove_scene_objects'] = 'remove_scene_objects') -> None>[source]: The synthesized __init__ [Signature][inspect.Signature] of the model.

__slots__ = ('__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__')[source]

__str__()[source]

Return str(self).

Return type:: str

_abc_impl = <_abc._abc_data object>[source]

_calculate_keys(*args, **kwargs)[source]

Return type:: Any

_check_frozen(name, value)[source]

Return type:: None

_copy_and_set_values(*args, **kwargs)[source]

Return type:: Any

classmethod _get_value(*args, **kwargs)[source]

Return type:: Any

_iter(*args, **kwargs)[source]

Return type:: Any

classmethod construct(_fields_set=None, **values)[source]

Return type:: Self

copy(*, include=None, exclude=None, update=None, deep=False)[source]

Returns a copy of the model.

!!! warning “Deprecated”: This method is now deprecated; use model_copy instead.

If you need include or exclude, use:

`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `

Parameters:

include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.

Returns:

A copy of the model with included, excluded and updated fields as specified.

data: RemoveSceneObjects[source]

dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)[source]

Return type:: Dict[str, Any]

classmethod from_orm(obj)[source]

Return type:: Self

json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)[source]

Return type:: str

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}[source]: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'protected_namespaces': ()}[source]: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod model_construct(_fields_set=None, **values)[source]

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note: model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == 'allow', then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == 'ignore' (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == 'forbid' does not result in an error if extra values are passed, but they will be ignored.

Parameters:

_fields_set (set[str] | None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.
values (Any) – Trusted or pre-validated data dictionary.

Return type:

Self

Returns:

A new instance of the Model class with validated data.

model_copy(*, update=None, deep=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy

Returns a copy of the model.

Parameters:

update (dict[str, Any] | None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.
deep (bool) – Set to True to make a deep copy of the model.

Return type:

Self

Returns:

New model instance.

model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters:

mode (Union[Literal['json', 'python'], str]) – The mode in which to_python 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.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to include in the output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to exclude from the output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to use the field’s alias in the dictionary key if defined.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A dictionary representation of the model.

model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

Generates a JSON representation of the model using Pydantic’s to_json method.

Parameters:

indent (int | None) – Indentation to use in the JSON output. If None is passed, the output will be compact.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to include in the JSON output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to exclude from the JSON output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to serialize using field aliases.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A JSON string representation of the model.

property model_extra: dict[str, Any] | None[source]

Get extra fields set during validation.

Returns:: A dictionary of extra fields, or None if config.extra is not set to "allow".

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=RemoveSceneObjects, required=True), 'type': FieldInfo(annotation=Literal['remove_scene_objects'], required=False, default='remove_scene_objects')}[source]

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

property model_fields_set: set[str][source]

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,: i.e. that were not filled from defaults.

classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')[source]

Generates a JSON schema for a model class.

Parameters:

by_alias (bool) – Whether to use attribute aliases or not.
ref_template (str) – The reference template.
schema_generator (type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modifications
mode (Literal['validation', 'serialization']) – The mode in which to generate the schema.

Return type:

Returns:

The JSON schema for the given model class.

classmethod model_parametrized_name(params)[source]

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

Parameters:: params (tuple[type[Any], ...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.
Return type:: str
Returns:: String representing the new class where params are passed to cls as type variables.
Raises:: TypeError – Raised when trying to generate concrete names for non-generic models.

model_post_init(_BaseModel__context)[source]

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

Return type:: None

classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)[source]

Try to rebuild the pydantic-core schema for the model.

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.

Parameters:

force (bool) – Whether to force the rebuilding of the model schema, defaults to False.
raise_errors (bool) – Whether to raise errors, defaults to True.
_parent_namespace_depth (int) – The depth level of the parent namespace, defaults to 2.
_types_namespace (dict[str, Any] | None) – The types namespace, defaults to None.

Return type:

Returns:

Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.

classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)[source]

Validate a pydantic model instance.

Parameters:

obj (Any) – The object to validate.
strict (bool | None) – Whether to enforce types strictly.
from_attributes (bool | None) – Whether to extract data from object attributes.
context (Any | None) – Additional context to pass to the validator.

Raises:

ValidationError – If the object could not be validated.

Return type:

Self

Returns:

The validated model instance.

classmethod model_validate_json(json_data, *, strict=None, context=None)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing

Validate the given JSON data against the Pydantic model.

Parameters:

json_data (str | bytes | bytearray) – The JSON data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

Raises:

ValidationError – If json_data is not a JSON string or the object could not be validated.

classmethod model_validate_strings(obj, *, strict=None, context=None)[source]

Validate the given object with string data against the Pydantic model.

Parameters:

obj (Any) – The object containing string data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod parse_obj(obj)[source]

Return type:: Self

classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod schema(by_alias=True, ref_template='#/$defs/{model}')[source]

Return type:: Dict[str, Any]

classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)[source]

Return type:: str

type: Literal['remove_scene_objects'][source]

classmethod update_forward_refs(**localns)[source]

Return type:: None

classmethod validate(value)[source]

Return type:: Self

class kittycad.models.ok_modeling_cmd_response.OptionRevolve(**data)[source][source]

The response to the ‘Revolve’ endpoint

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__abstractmethods__ = frozenset({})[source]

__annotations__ = {'__class_vars__': 'ClassVar[set[str]]', '__private_attributes__': 'ClassVar[Dict[str, ModelPrivateAttr]]', '__pydantic_complete__': 'ClassVar[bool]', '__pydantic_core_schema__': 'ClassVar[CoreSchema]', '__pydantic_custom_init__': 'ClassVar[bool]', '__pydantic_decorators__': 'ClassVar[_decorators.DecoratorInfos]', '__pydantic_extra__': 'dict[str, Any] | None', '__pydantic_fields_set__': 'set[str]', '__pydantic_generic_metadata__': 'ClassVar[_generics.PydanticGenericMetadata]', '__pydantic_parent_namespace__': 'ClassVar[Dict[str, Any] | None]', '__pydantic_post_init__': "ClassVar[None | Literal['model_post_init']]", '__pydantic_private__': 'dict[str, Any] | None', '__pydantic_root_model__': 'ClassVar[bool]', '__pydantic_serializer__': 'ClassVar[SchemaSerializer]', '__pydantic_validator__': 'ClassVar[SchemaValidator | PluggableSchemaValidator]', '__signature__': 'ClassVar[Signature]', 'data': <class 'kittycad.models.revolve.Revolve'>, 'model_computed_fields': 'ClassVar[Dict[str, ComputedFieldInfo]]', 'model_config': 'ClassVar[ConfigDict]', 'model_fields': 'ClassVar[Dict[str, FieldInfo]]', 'type': typing.Literal['revolve']}[source]

classmethod __class_getitem__(typevar_values)[source]

Return type:: type[BaseModel] | PydanticRecursiveRef

__class_vars__: ClassVar[set[str]] = {}[source]: The names of the class variables defined on the model.

__copy__()[source]

Returns a shallow copy of the model.

Return type:: Self

__deepcopy__(memo=None)[source]

Returns a deep copy of the model.

Return type:: Self

__delattr__(item)[source]

Implement delattr(self, name).

Return type:: Any

__dict__[source]

__eq__(other)[source]

Return self==value.

Return type:: bool

property __fields_set__: set[str][source]

classmethod __get_pydantic_core_schema__(source, handler, /)[source]

Hook into generating the model’s CoreSchema.

Parameters:

source (type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.
handler (GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.

Return type:

Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]

Returns:

A pydantic-core CoreSchema.

classmethod __get_pydantic_json_schema__(core_schema, handler, /)[source]

Hook into generating the model’s JSON schema.

Parameters:

core_schema (Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({'type': 'nullable', 'schema': current_schema}), or just call the handler with the original schema.
handler (GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.

Return type:

Returns:

A JSON schema, as a Python object.

__getattr__(item)[source]

Return type:: Any

__getstate__()[source]

Helper for pickle.

Return type:: dict[Any, Any]

__hash__ = None[source]

__init__(**data)[source]

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__iter__()[source]

So dict(model) works.

Return type:: Generator[Tuple[str, Any], None, None]

__module__ = 'kittycad.models.ok_modeling_cmd_response'[source]

__pretty__(fmt, **kwargs)[source]

Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.

Return type:: Generator[Any, None, None]

__private_attributes__: ClassVar[Dict[str, ModelPrivateAttr]] = {}[source]: Metadata about the private attributes of the model.

__pydantic_complete__: ClassVar[bool] = True[source]: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__: ClassVar[CoreSchema] = {'cls': <class 'kittycad.models.ok_modeling_cmd_response.OptionRevolve'>, 'config': {'title': 'OptionRevolve'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.ok_modeling_cmd_response.OptionRevolve'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.ok_modeling_cmd_response.OptionRevolve'>>]}, 'ref': 'kittycad.models.ok_modeling_cmd_response.OptionRevolve:94667212738512', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'data': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.revolve.Revolve'>, 'config': {'title': 'Revolve'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.revolve.Revolve'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.revolve.Revolve'>>]}, 'ref': 'kittycad.models.revolve.Revolve:94667212405952', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {}, 'model_name': 'Revolve', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}, 'type': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': 'revolve', 'schema': {'expected': ['revolve'], 'type': 'literal'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'OptionRevolve', 'type': 'model-fields'}, 'type': 'model'}[source]: The core schema of the model.

__pydantic_custom_init__: ClassVar[bool] = False[source]: Whether the model has a custom __init__ method.

__pydantic_decorators__: ClassVar[_decorators.DecoratorInfos] = DecoratorInfos(validators={}, field_validators={}, root_validators={}, field_serializers={}, model_serializers={}, model_validators={}, computed_fields={})[source]: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_extra__: dict[str, Any] | None[source]: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to 'allow'.

__pydantic_fields_set__: set[str][source]: The names of fields explicitly set during instantiation.

__pydantic_generic_metadata__: ClassVar[_generics.PydanticGenericMetadata] = {'args': (), 'origin': None, 'parameters': ()}[source]: 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.

classmethod __pydantic_init_subclass__(**kwargs)[source]

This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.

This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.

This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.

Parameters:: **kwargs (Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.
Return type:: None

__pydantic_parent_namespace__: ClassVar[Dict[str, Any] | None] = None[source]: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__: ClassVar[None | Literal['model_post_init']] = None[source]: The name of the post-init method for the model, if defined.

__pydantic_private__: dict[str, Any] | None[source]: Values of private attributes set on the model instance.

__pydantic_root_model__: ClassVar[bool] = False[source]: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__: ClassVar[SchemaSerializer] = SchemaSerializer(serializer=Model( ModelSerializer { class: Py( 0x000056196d964fd0, ), serializer: Fields( GeneralFieldsSerializer { fields: { "data": SerField { key_py: Py( 0x00007f9038238fa0, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196d913cc0, ), serializer: Fields( GeneralFieldsSerializer { fields: {}, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 0, }, ), has_extra: false, root_model: false, name: "Revolve", }, ), ), required: true, }, "type": SerField { key_py: Py( 0x00007f903823d958, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f9034d2d0e0, ), ), serializer: Literal( LiteralSerializer { expected_int: {}, expected_str: { "revolve", }, expected_py: None, name: "literal['revolve']", }, ), }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "OptionRevolve", }, ), definitions=[])[source]: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__: ClassVar[SchemaValidator | PluggableSchemaValidator] = SchemaValidator(title="OptionRevolve", validator=Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "data", lookup_key: Simple { key: "data", py_key: Py( 0x00007f9033604b10, ), path: LookupPath( [ S( "data", Py( 0x00007f9033605260, ), ), ], ), }, name_py: Py( 0x00007f9038238fa0, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [], model_name: "Revolve", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d913cc0, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "Revolve", }, ), frozen: false, }, Field { name: "type", lookup_key: Simple { key: "type", py_key: Py( 0x00007f9033605a40, ), path: LookupPath( [ S( "type", Py( 0x00007f9033605650, ), ), ], ), }, name_py: Py( 0x00007f903823d958, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f9034d2d0e0, ), ), on_error: Raise, validator: Literal( LiteralValidator { lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "revolve": 0, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f9034d2d0e0, ), ], }, expected_repr: "'revolve'", name: "literal['revolve']", }, ), validate_default: false, copy_default: false, name: "default[literal['revolve']]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "OptionRevolve", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d964fd0, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "OptionRevolve", }, ), definitions=[], cache_strings=True)[source]: The pydantic-core SchemaValidator used to validate instances of the model.

__repr__()[source]

Return repr(self).

Return type:: str

__repr_args__()[source]

Return type:: Iterable[tuple[str | None, Any]]

__repr_name__()[source]

Name of the instance’s class, used in __repr__.

Return type:: str

__repr_str__(join_str)[source]

Return type:: str

__rich_repr__()[source]

Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.

Return type:: Iterable[Any | tuple[Any] | tuple[str, Any] | tuple[str, Any, Any]]

__setattr__(name, value)[source]

Implement setattr(self, name, value).

Return type:: None

__setstate__(state)[source]

Return type:: None

__signature__: ClassVar[Signature] = <Signature (*, data: kittycad.models.revolve.Revolve, type: Literal['revolve'] = 'revolve') -> None>[source]: The synthesized __init__ [Signature][inspect.Signature] of the model.

__slots__ = ('__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__')[source]

__str__()[source]

Return str(self).

Return type:: str

_abc_impl = <_abc._abc_data object>[source]

_calculate_keys(*args, **kwargs)[source]

Return type:: Any

_check_frozen(name, value)[source]

Return type:: None

_copy_and_set_values(*args, **kwargs)[source]

Return type:: Any

classmethod _get_value(*args, **kwargs)[source]

Return type:: Any

_iter(*args, **kwargs)[source]

Return type:: Any

classmethod construct(_fields_set=None, **values)[source]

Return type:: Self

copy(*, include=None, exclude=None, update=None, deep=False)[source]

Returns a copy of the model.

!!! warning “Deprecated”: This method is now deprecated; use model_copy instead.

If you need include or exclude, use:

`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `

Parameters:

include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.

Returns:

A copy of the model with included, excluded and updated fields as specified.

data: Revolve[source]

dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)[source]

Return type:: Dict[str, Any]

classmethod from_orm(obj)[source]

Return type:: Self

json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)[source]

Return type:: str

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}[source]: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'protected_namespaces': ()}[source]: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod model_construct(_fields_set=None, **values)[source]

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note: model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == 'allow', then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == 'ignore' (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == 'forbid' does not result in an error if extra values are passed, but they will be ignored.

Parameters:

_fields_set (set[str] | None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.
values (Any) – Trusted or pre-validated data dictionary.

Return type:

Self

Returns:

A new instance of the Model class with validated data.

model_copy(*, update=None, deep=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy

Returns a copy of the model.

Parameters:

update (dict[str, Any] | None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.
deep (bool) – Set to True to make a deep copy of the model.

Return type:

Self

Returns:

New model instance.

model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters:

mode (Union[Literal['json', 'python'], str]) – The mode in which to_python 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.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to include in the output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to exclude from the output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to use the field’s alias in the dictionary key if defined.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A dictionary representation of the model.

model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

Generates a JSON representation of the model using Pydantic’s to_json method.

Parameters:

indent (int | None) – Indentation to use in the JSON output. If None is passed, the output will be compact.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to include in the JSON output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to exclude from the JSON output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to serialize using field aliases.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A JSON string representation of the model.

property model_extra: dict[str, Any] | None[source]

Get extra fields set during validation.

Returns:: A dictionary of extra fields, or None if config.extra is not set to "allow".

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=Revolve, required=True), 'type': FieldInfo(annotation=Literal['revolve'], required=False, default='revolve')}[source]

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

property model_fields_set: set[str][source]

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,: i.e. that were not filled from defaults.

classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')[source]

Generates a JSON schema for a model class.

Parameters:

by_alias (bool) – Whether to use attribute aliases or not.
ref_template (str) – The reference template.
schema_generator (type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modifications
mode (Literal['validation', 'serialization']) – The mode in which to generate the schema.

Return type:

Returns:

The JSON schema for the given model class.

classmethod model_parametrized_name(params)[source]

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

Parameters:: params (tuple[type[Any], ...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.
Return type:: str
Returns:: String representing the new class where params are passed to cls as type variables.
Raises:: TypeError – Raised when trying to generate concrete names for non-generic models.

model_post_init(_BaseModel__context)[source]

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

Return type:: None

classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)[source]

Try to rebuild the pydantic-core schema for the model.

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.

Parameters:

force (bool) – Whether to force the rebuilding of the model schema, defaults to False.
raise_errors (bool) – Whether to raise errors, defaults to True.
_parent_namespace_depth (int) – The depth level of the parent namespace, defaults to 2.
_types_namespace (dict[str, Any] | None) – The types namespace, defaults to None.

Return type:

Returns:

Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.

classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)[source]

Validate a pydantic model instance.

Parameters:

obj (Any) – The object to validate.
strict (bool | None) – Whether to enforce types strictly.
from_attributes (bool | None) – Whether to extract data from object attributes.
context (Any | None) – Additional context to pass to the validator.

Raises:

ValidationError – If the object could not be validated.

Return type:

Self

Returns:

The validated model instance.

classmethod model_validate_json(json_data, *, strict=None, context=None)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing

Validate the given JSON data against the Pydantic model.

Parameters:

json_data (str | bytes | bytearray) – The JSON data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

Raises:

ValidationError – If json_data is not a JSON string or the object could not be validated.

classmethod model_validate_strings(obj, *, strict=None, context=None)[source]

Validate the given object with string data against the Pydantic model.

Parameters:

obj (Any) – The object containing string data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod parse_obj(obj)[source]

Return type:: Self

classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod schema(by_alias=True, ref_template='#/$defs/{model}')[source]

Return type:: Dict[str, Any]

classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)[source]

Return type:: str

type: Literal['revolve'][source]

classmethod update_forward_refs(**localns)[source]

Return type:: None

classmethod validate(value)[source]

Return type:: Self

class kittycad.models.ok_modeling_cmd_response.OptionRevolveAboutEdge(**data)[source][source]

The response to the ‘RevolveAboutEdge’ endpoint

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__abstractmethods__ = frozenset({})[source]

__annotations__ = {'__class_vars__': 'ClassVar[set[str]]', '__private_attributes__': 'ClassVar[Dict[str, ModelPrivateAttr]]', '__pydantic_complete__': 'ClassVar[bool]', '__pydantic_core_schema__': 'ClassVar[CoreSchema]', '__pydantic_custom_init__': 'ClassVar[bool]', '__pydantic_decorators__': 'ClassVar[_decorators.DecoratorInfos]', '__pydantic_extra__': 'dict[str, Any] | None', '__pydantic_fields_set__': 'set[str]', '__pydantic_generic_metadata__': 'ClassVar[_generics.PydanticGenericMetadata]', '__pydantic_parent_namespace__': 'ClassVar[Dict[str, Any] | None]', '__pydantic_post_init__': "ClassVar[None | Literal['model_post_init']]", '__pydantic_private__': 'dict[str, Any] | None', '__pydantic_root_model__': 'ClassVar[bool]', '__pydantic_serializer__': 'ClassVar[SchemaSerializer]', '__pydantic_validator__': 'ClassVar[SchemaValidator | PluggableSchemaValidator]', '__signature__': 'ClassVar[Signature]', 'data': <class 'kittycad.models.revolve_about_edge.RevolveAboutEdge'>, 'model_computed_fields': 'ClassVar[Dict[str, ComputedFieldInfo]]', 'model_config': 'ClassVar[ConfigDict]', 'model_fields': 'ClassVar[Dict[str, FieldInfo]]', 'type': typing.Literal['revolve_about_edge']}[source]

classmethod __class_getitem__(typevar_values)[source]

Return type:: type[BaseModel] | PydanticRecursiveRef

__class_vars__: ClassVar[set[str]] = {}[source]: The names of the class variables defined on the model.

__copy__()[source]

Returns a shallow copy of the model.

Return type:: Self

__deepcopy__(memo=None)[source]

Returns a deep copy of the model.

Return type:: Self

__delattr__(item)[source]

Implement delattr(self, name).

Return type:: Any

__dict__[source]

__eq__(other)[source]

Return self==value.

Return type:: bool

property __fields_set__: set[str][source]

classmethod __get_pydantic_core_schema__(source, handler, /)[source]

Hook into generating the model’s CoreSchema.

Parameters:

source (type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.
handler (GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.

Return type:

Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]

Returns:

A pydantic-core CoreSchema.

classmethod __get_pydantic_json_schema__(core_schema, handler, /)[source]

Hook into generating the model’s JSON schema.

Parameters:

core_schema (Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({'type': 'nullable', 'schema': current_schema}), or just call the handler with the original schema.
handler (GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.

Return type:

Returns:

A JSON schema, as a Python object.

__getattr__(item)[source]

Return type:: Any

__getstate__()[source]

Helper for pickle.

Return type:: dict[Any, Any]

__hash__ = None[source]

__init__(**data)[source]

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__iter__()[source]

So dict(model) works.

Return type:: Generator[Tuple[str, Any], None, None]

__module__ = 'kittycad.models.ok_modeling_cmd_response'[source]

__pretty__(fmt, **kwargs)[source]

Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.

Return type:: Generator[Any, None, None]

__private_attributes__: ClassVar[Dict[str, ModelPrivateAttr]] = {}[source]: Metadata about the private attributes of the model.

__pydantic_complete__: ClassVar[bool] = True[source]: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__: ClassVar[CoreSchema] = {'cls': <class 'kittycad.models.ok_modeling_cmd_response.OptionRevolveAboutEdge'>, 'config': {'title': 'OptionRevolveAboutEdge'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.ok_modeling_cmd_response.OptionRevolveAboutEdge'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.ok_modeling_cmd_response.OptionRevolveAboutEdge'>>]}, 'ref': 'kittycad.models.ok_modeling_cmd_response.OptionRevolveAboutEdge:94667212756992', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'data': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.revolve_about_edge.RevolveAboutEdge'>, 'config': {'title': 'RevolveAboutEdge'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.revolve_about_edge.RevolveAboutEdge'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.revolve_about_edge.RevolveAboutEdge'>>]}, 'ref': 'kittycad.models.revolve_about_edge.RevolveAboutEdge:94667212392512', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {}, 'model_name': 'RevolveAboutEdge', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}, 'type': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': 'revolve_about_edge', 'schema': {'expected': ['revolve_about_edge'], 'type': 'literal'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'OptionRevolveAboutEdge', 'type': 'model-fields'}, 'type': 'model'}[source]: The core schema of the model.

__pydantic_custom_init__: ClassVar[bool] = False[source]: Whether the model has a custom __init__ method.

__pydantic_decorators__: ClassVar[_decorators.DecoratorInfos] = DecoratorInfos(validators={}, field_validators={}, root_validators={}, field_serializers={}, model_serializers={}, model_validators={}, computed_fields={})[source]: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_extra__: dict[str, Any] | None[source]: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to 'allow'.

__pydantic_fields_set__: set[str][source]: The names of fields explicitly set during instantiation.

__pydantic_generic_metadata__: ClassVar[_generics.PydanticGenericMetadata] = {'args': (), 'origin': None, 'parameters': ()}[source]: 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.

classmethod __pydantic_init_subclass__(**kwargs)[source]

This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.

This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.

This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.

Parameters:: **kwargs (Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.
Return type:: None

__pydantic_parent_namespace__: ClassVar[Dict[str, Any] | None] = None[source]: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__: ClassVar[None | Literal['model_post_init']] = None[source]: The name of the post-init method for the model, if defined.

__pydantic_private__: dict[str, Any] | None[source]: Values of private attributes set on the model instance.

__pydantic_root_model__: ClassVar[bool] = False[source]: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__: ClassVar[SchemaSerializer] = SchemaSerializer(serializer=Model( ModelSerializer { class: Py( 0x000056196d969800, ), serializer: Fields( GeneralFieldsSerializer { fields: { "type": SerField { key_py: Py( 0x00007f903823d958, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f90346e54f0, ), ), serializer: Literal( LiteralSerializer { expected_int: {}, expected_str: { "revolve_about_edge", }, expected_py: None, name: "literal['revolve_about_edge']", }, ), }, ), ), required: true, }, "data": SerField { key_py: Py( 0x00007f9038238fa0, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196d910840, ), serializer: Fields( GeneralFieldsSerializer { fields: {}, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 0, }, ), has_extra: false, root_model: false, name: "RevolveAboutEdge", }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "OptionRevolveAboutEdge", }, ), definitions=[])[source]: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__: ClassVar[SchemaValidator | PluggableSchemaValidator] = SchemaValidator(title="OptionRevolveAboutEdge", validator=Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "data", lookup_key: Simple { key: "data", py_key: Py( 0x00007f9033606cd0, ), path: LookupPath( [ S( "data", Py( 0x00007f9033606d90, ), ), ], ), }, name_py: Py( 0x00007f9038238fa0, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [], model_name: "RevolveAboutEdge", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d910840, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "RevolveAboutEdge", }, ), frozen: false, }, Field { name: "type", lookup_key: Simple { key: "type", py_key: Py( 0x00007f9033606dc0, ), path: LookupPath( [ S( "type", Py( 0x00007f9033606df0, ), ), ], ), }, name_py: Py( 0x00007f903823d958, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f90346e54f0, ), ), on_error: Raise, validator: Literal( LiteralValidator { lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "revolve_about_edge": 0, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f90346e54f0, ), ], }, expected_repr: "'revolve_about_edge'", name: "literal['revolve_about_edge']", }, ), validate_default: false, copy_default: false, name: "default[literal['revolve_about_edge']]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "OptionRevolveAboutEdge", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d969800, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "OptionRevolveAboutEdge", }, ), definitions=[], cache_strings=True)[source]: The pydantic-core SchemaValidator used to validate instances of the model.

__repr__()[source]

Return repr(self).

Return type:: str

__repr_args__()[source]

Return type:: Iterable[tuple[str | None, Any]]

__repr_name__()[source]

Name of the instance’s class, used in __repr__.

Return type:: str

__repr_str__(join_str)[source]

Return type:: str

__rich_repr__()[source]

Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.

Return type:: Iterable[Any | tuple[Any] | tuple[str, Any] | tuple[str, Any, Any]]

__setattr__(name, value)[source]

Implement setattr(self, name, value).

Return type:: None

__setstate__(state)[source]

Return type:: None

__signature__: ClassVar[Signature] = <Signature (*, data: kittycad.models.revolve_about_edge.RevolveAboutEdge, type: Literal['revolve_about_edge'] = 'revolve_about_edge') -> None>[source]: The synthesized __init__ [Signature][inspect.Signature] of the model.

__slots__ = ('__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__')[source]

__str__()[source]

Return str(self).

Return type:: str

_abc_impl = <_abc._abc_data object>[source]

_calculate_keys(*args, **kwargs)[source]

Return type:: Any

_check_frozen(name, value)[source]

Return type:: None

_copy_and_set_values(*args, **kwargs)[source]

Return type:: Any

classmethod _get_value(*args, **kwargs)[source]

Return type:: Any

_iter(*args, **kwargs)[source]

Return type:: Any

classmethod construct(_fields_set=None, **values)[source]

Return type:: Self

copy(*, include=None, exclude=None, update=None, deep=False)[source]

Returns a copy of the model.

!!! warning “Deprecated”: This method is now deprecated; use model_copy instead.

If you need include or exclude, use:

`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `

Parameters:

include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.

Returns:

A copy of the model with included, excluded and updated fields as specified.

data: RevolveAboutEdge[source]

dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)[source]

Return type:: Dict[str, Any]

classmethod from_orm(obj)[source]

Return type:: Self

json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)[source]

Return type:: str

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}[source]: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'protected_namespaces': ()}[source]: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod model_construct(_fields_set=None, **values)[source]

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note: model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == 'allow', then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == 'ignore' (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == 'forbid' does not result in an error if extra values are passed, but they will be ignored.

Parameters:

_fields_set (set[str] | None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.
values (Any) – Trusted or pre-validated data dictionary.

Return type:

Self

Returns:

A new instance of the Model class with validated data.

model_copy(*, update=None, deep=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy

Returns a copy of the model.

Parameters:

update (dict[str, Any] | None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.
deep (bool) – Set to True to make a deep copy of the model.

Return type:

Self

Returns:

New model instance.

model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters:

mode (Union[Literal['json', 'python'], str]) – The mode in which to_python 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.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to include in the output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to exclude from the output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to use the field’s alias in the dictionary key if defined.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A dictionary representation of the model.

model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

Generates a JSON representation of the model using Pydantic’s to_json method.

Parameters:

indent (int | None) – Indentation to use in the JSON output. If None is passed, the output will be compact.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to include in the JSON output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to exclude from the JSON output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to serialize using field aliases.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A JSON string representation of the model.

property model_extra: dict[str, Any] | None[source]

Get extra fields set during validation.

Returns:: A dictionary of extra fields, or None if config.extra is not set to "allow".

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=RevolveAboutEdge, required=True), 'type': FieldInfo(annotation=Literal['revolve_about_edge'], required=False, default='revolve_about_edge')}[source]

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

property model_fields_set: set[str][source]

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,: i.e. that were not filled from defaults.

classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')[source]

Generates a JSON schema for a model class.

Parameters:

by_alias (bool) – Whether to use attribute aliases or not.
ref_template (str) – The reference template.
schema_generator (type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modifications
mode (Literal['validation', 'serialization']) – The mode in which to generate the schema.

Return type:

Returns:

The JSON schema for the given model class.

classmethod model_parametrized_name(params)[source]

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

Parameters:: params (tuple[type[Any], ...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.
Return type:: str
Returns:: String representing the new class where params are passed to cls as type variables.
Raises:: TypeError – Raised when trying to generate concrete names for non-generic models.

model_post_init(_BaseModel__context)[source]

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

Return type:: None

classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)[source]

Try to rebuild the pydantic-core schema for the model.

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.

Parameters:

force (bool) – Whether to force the rebuilding of the model schema, defaults to False.
raise_errors (bool) – Whether to raise errors, defaults to True.
_parent_namespace_depth (int) – The depth level of the parent namespace, defaults to 2.
_types_namespace (dict[str, Any] | None) – The types namespace, defaults to None.

Return type:

Returns:

Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.

classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)[source]

Validate a pydantic model instance.

Parameters:

obj (Any) – The object to validate.
strict (bool | None) – Whether to enforce types strictly.
from_attributes (bool | None) – Whether to extract data from object attributes.
context (Any | None) – Additional context to pass to the validator.

Raises:

ValidationError – If the object could not be validated.

Return type:

Self

Returns:

The validated model instance.

classmethod model_validate_json(json_data, *, strict=None, context=None)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing

Validate the given JSON data against the Pydantic model.

Parameters:

json_data (str | bytes | bytearray) – The JSON data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

Raises:

ValidationError – If json_data is not a JSON string or the object could not be validated.

classmethod model_validate_strings(obj, *, strict=None, context=None)[source]

Validate the given object with string data against the Pydantic model.

Parameters:

obj (Any) – The object containing string data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod parse_obj(obj)[source]

Return type:: Self

classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod schema(by_alias=True, ref_template='#/$defs/{model}')[source]

Return type:: Dict[str, Any]

classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)[source]

Return type:: str

type: Literal['revolve_about_edge'][source]

classmethod update_forward_refs(**localns)[source]

Return type:: None

classmethod validate(value)[source]

Return type:: Self

class kittycad.models.ok_modeling_cmd_response.OptionSceneClearAll(**data)[source][source]

The response to the ‘SceneClearAll’ endpoint

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__abstractmethods__ = frozenset({})[source]

__annotations__ = {'__class_vars__': 'ClassVar[set[str]]', '__private_attributes__': 'ClassVar[Dict[str, ModelPrivateAttr]]', '__pydantic_complete__': 'ClassVar[bool]', '__pydantic_core_schema__': 'ClassVar[CoreSchema]', '__pydantic_custom_init__': 'ClassVar[bool]', '__pydantic_decorators__': 'ClassVar[_decorators.DecoratorInfos]', '__pydantic_extra__': 'dict[str, Any] | None', '__pydantic_fields_set__': 'set[str]', '__pydantic_generic_metadata__': 'ClassVar[_generics.PydanticGenericMetadata]', '__pydantic_parent_namespace__': 'ClassVar[Dict[str, Any] | None]', '__pydantic_post_init__': "ClassVar[None | Literal['model_post_init']]", '__pydantic_private__': 'dict[str, Any] | None', '__pydantic_root_model__': 'ClassVar[bool]', '__pydantic_serializer__': 'ClassVar[SchemaSerializer]', '__pydantic_validator__': 'ClassVar[SchemaValidator | PluggableSchemaValidator]', '__signature__': 'ClassVar[Signature]', 'data': <class 'kittycad.models.scene_clear_all.SceneClearAll'>, 'model_computed_fields': 'ClassVar[Dict[str, ComputedFieldInfo]]', 'model_config': 'ClassVar[ConfigDict]', 'model_fields': 'ClassVar[Dict[str, FieldInfo]]', 'type': typing.Literal['scene_clear_all']}[source]

classmethod __class_getitem__(typevar_values)[source]

Return type:: type[BaseModel] | PydanticRecursiveRef

__class_vars__: ClassVar[set[str]] = {}[source]: The names of the class variables defined on the model.

__copy__()[source]

Returns a shallow copy of the model.

Return type:: Self

__deepcopy__(memo=None)[source]

Returns a deep copy of the model.

Return type:: Self

__delattr__(item)[source]

Implement delattr(self, name).

Return type:: Any

__dict__[source]

__eq__(other)[source]

Return self==value.

Return type:: bool

property __fields_set__: set[str][source]

classmethod __get_pydantic_core_schema__(source, handler, /)[source]

Hook into generating the model’s CoreSchema.

Parameters:

source (type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.
handler (GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.

Return type:

Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]

Returns:

A pydantic-core CoreSchema.

classmethod __get_pydantic_json_schema__(core_schema, handler, /)[source]

Hook into generating the model’s JSON schema.

Parameters:

core_schema (Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({'type': 'nullable', 'schema': current_schema}), or just call the handler with the original schema.
handler (GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.

Return type:

Returns:

A JSON schema, as a Python object.

__getattr__(item)[source]

Return type:: Any

__getstate__()[source]

Helper for pickle.

Return type:: dict[Any, Any]

__hash__ = None[source]

__init__(**data)[source]

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__iter__()[source]

So dict(model) works.

Return type:: Generator[Tuple[str, Any], None, None]

__module__ = 'kittycad.models.ok_modeling_cmd_response'[source]

__pretty__(fmt, **kwargs)[source]

Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.

Return type:: Generator[Any, None, None]

__private_attributes__: ClassVar[Dict[str, ModelPrivateAttr]] = {}[source]: Metadata about the private attributes of the model.

__pydantic_complete__: ClassVar[bool] = True[source]: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__: ClassVar[CoreSchema] = {'cls': <class 'kittycad.models.ok_modeling_cmd_response.OptionSceneClearAll'>, 'config': {'title': 'OptionSceneClearAll'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.ok_modeling_cmd_response.OptionSceneClearAll'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.ok_modeling_cmd_response.OptionSceneClearAll'>>]}, 'ref': 'kittycad.models.ok_modeling_cmd_response.OptionSceneClearAll:94667212850224', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'data': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.scene_clear_all.SceneClearAll'>, 'config': {'title': 'SceneClearAll'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.scene_clear_all.SceneClearAll'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.scene_clear_all.SceneClearAll'>>]}, 'ref': 'kittycad.models.scene_clear_all.SceneClearAll:94667212395760', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {}, 'model_name': 'SceneClearAll', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}, 'type': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': 'scene_clear_all', 'schema': {'expected': ['scene_clear_all'], 'type': 'literal'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'OptionSceneClearAll', 'type': 'model-fields'}, 'type': 'model'}[source]: The core schema of the model.

__pydantic_custom_init__: ClassVar[bool] = False[source]: Whether the model has a custom __init__ method.

__pydantic_decorators__: ClassVar[_decorators.DecoratorInfos] = DecoratorInfos(validators={}, field_validators={}, root_validators={}, field_serializers={}, model_serializers={}, model_validators={}, computed_fields={})[source]: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_extra__: dict[str, Any] | None[source]: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to 'allow'.

__pydantic_fields_set__: set[str][source]: The names of fields explicitly set during instantiation.

__pydantic_generic_metadata__: ClassVar[_generics.PydanticGenericMetadata] = {'args': (), 'origin': None, 'parameters': ()}[source]: 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.

classmethod __pydantic_init_subclass__(**kwargs)[source]

This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.

This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.

This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.

Parameters:: **kwargs (Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.
Return type:: None

__pydantic_parent_namespace__: ClassVar[Dict[str, Any] | None] = None[source]: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__: ClassVar[None | Literal['model_post_init']] = None[source]: The name of the post-init method for the model, if defined.

__pydantic_private__: dict[str, Any] | None[source]: Values of private attributes set on the model instance.

__pydantic_root_model__: ClassVar[bool] = False[source]: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__: ClassVar[SchemaSerializer] = SchemaSerializer(serializer=Model( ModelSerializer { class: Py( 0x000056196d980430, ), serializer: Fields( GeneralFieldsSerializer { fields: { "type": SerField { key_py: Py( 0x00007f903823d958, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f90346e59f0, ), ), serializer: Literal( LiteralSerializer { expected_int: {}, expected_str: { "scene_clear_all", }, expected_py: None, name: "literal['scene_clear_all']", }, ), }, ), ), required: true, }, "data": SerField { key_py: Py( 0x00007f9038238fa0, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196d9114f0, ), serializer: Fields( GeneralFieldsSerializer { fields: {}, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 0, }, ), has_extra: false, root_model: false, name: "SceneClearAll", }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "OptionSceneClearAll", }, ), definitions=[])[source]: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__: ClassVar[SchemaValidator | PluggableSchemaValidator] = SchemaValidator(title="OptionSceneClearAll", validator=Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "data", lookup_key: Simple { key: "data", py_key: Py( 0x00007f9033606550, ), path: LookupPath( [ S( "data", Py( 0x00007f9033604600, ), ), ], ), }, name_py: Py( 0x00007f9038238fa0, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [], model_name: "SceneClearAll", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d9114f0, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "SceneClearAll", }, ), frozen: false, }, Field { name: "type", lookup_key: Simple { key: "type", py_key: Py( 0x00007f9033606670, ), path: LookupPath( [ S( "type", Py( 0x00007f9033606610, ), ), ], ), }, name_py: Py( 0x00007f903823d958, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f90346e59f0, ), ), on_error: Raise, validator: Literal( LiteralValidator { lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "scene_clear_all": 0, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f90346e59f0, ), ], }, expected_repr: "'scene_clear_all'", name: "literal['scene_clear_all']", }, ), validate_default: false, copy_default: false, name: "default[literal['scene_clear_all']]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "OptionSceneClearAll", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d980430, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "OptionSceneClearAll", }, ), definitions=[], cache_strings=True)[source]: The pydantic-core SchemaValidator used to validate instances of the model.

__repr__()[source]

Return repr(self).

Return type:: str

__repr_args__()[source]

Return type:: Iterable[tuple[str | None, Any]]

__repr_name__()[source]

Name of the instance’s class, used in __repr__.

Return type:: str

__repr_str__(join_str)[source]

Return type:: str

__rich_repr__()[source]

Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.

Return type:: Iterable[Any | tuple[Any] | tuple[str, Any] | tuple[str, Any, Any]]

__setattr__(name, value)[source]

Implement setattr(self, name, value).

Return type:: None

__setstate__(state)[source]

Return type:: None

__signature__: ClassVar[Signature] = <Signature (*, data: kittycad.models.scene_clear_all.SceneClearAll, type: Literal['scene_clear_all'] = 'scene_clear_all') -> None>[source]: The synthesized __init__ [Signature][inspect.Signature] of the model.

__slots__ = ('__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__')[source]

__str__()[source]

Return str(self).

Return type:: str

_abc_impl = <_abc._abc_data object>[source]

_calculate_keys(*args, **kwargs)[source]

Return type:: Any

_check_frozen(name, value)[source]

Return type:: None

_copy_and_set_values(*args, **kwargs)[source]

Return type:: Any

classmethod _get_value(*args, **kwargs)[source]

Return type:: Any

_iter(*args, **kwargs)[source]

Return type:: Any

classmethod construct(_fields_set=None, **values)[source]

Return type:: Self

copy(*, include=None, exclude=None, update=None, deep=False)[source]

Returns a copy of the model.

!!! warning “Deprecated”: This method is now deprecated; use model_copy instead.

If you need include or exclude, use:

`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `

Parameters:

include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.

Returns:

A copy of the model with included, excluded and updated fields as specified.

data: SceneClearAll[source]

dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)[source]

Return type:: Dict[str, Any]

classmethod from_orm(obj)[source]

Return type:: Self

json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)[source]

Return type:: str

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}[source]: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'protected_namespaces': ()}[source]: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod model_construct(_fields_set=None, **values)[source]

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note: model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == 'allow', then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == 'ignore' (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == 'forbid' does not result in an error if extra values are passed, but they will be ignored.

Parameters:

_fields_set (set[str] | None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.
values (Any) – Trusted or pre-validated data dictionary.

Return type:

Self

Returns:

A new instance of the Model class with validated data.

model_copy(*, update=None, deep=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy

Returns a copy of the model.

Parameters:

update (dict[str, Any] | None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.
deep (bool) – Set to True to make a deep copy of the model.

Return type:

Self

Returns:

New model instance.

model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters:

mode (Union[Literal['json', 'python'], str]) – The mode in which to_python 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.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to include in the output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to exclude from the output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to use the field’s alias in the dictionary key if defined.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A dictionary representation of the model.

model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

Generates a JSON representation of the model using Pydantic’s to_json method.

Parameters:

indent (int | None) – Indentation to use in the JSON output. If None is passed, the output will be compact.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to include in the JSON output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to exclude from the JSON output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to serialize using field aliases.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A JSON string representation of the model.

property model_extra: dict[str, Any] | None[source]

Get extra fields set during validation.

Returns:: A dictionary of extra fields, or None if config.extra is not set to "allow".

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=SceneClearAll, required=True), 'type': FieldInfo(annotation=Literal['scene_clear_all'], required=False, default='scene_clear_all')}[source]

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

property model_fields_set: set[str][source]

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,: i.e. that were not filled from defaults.

classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')[source]

Generates a JSON schema for a model class.

Parameters:

by_alias (bool) – Whether to use attribute aliases or not.
ref_template (str) – The reference template.
schema_generator (type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modifications
mode (Literal['validation', 'serialization']) – The mode in which to generate the schema.

Return type:

Returns:

The JSON schema for the given model class.

classmethod model_parametrized_name(params)[source]

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

Parameters:: params (tuple[type[Any], ...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.
Return type:: str
Returns:: String representing the new class where params are passed to cls as type variables.
Raises:: TypeError – Raised when trying to generate concrete names for non-generic models.

model_post_init(_BaseModel__context)[source]

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

Return type:: None

classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)[source]

Try to rebuild the pydantic-core schema for the model.

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.

Parameters:

force (bool) – Whether to force the rebuilding of the model schema, defaults to False.
raise_errors (bool) – Whether to raise errors, defaults to True.
_parent_namespace_depth (int) – The depth level of the parent namespace, defaults to 2.
_types_namespace (dict[str, Any] | None) – The types namespace, defaults to None.

Return type:

Returns:

Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.

classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)[source]

Validate a pydantic model instance.

Parameters:

obj (Any) – The object to validate.
strict (bool | None) – Whether to enforce types strictly.
from_attributes (bool | None) – Whether to extract data from object attributes.
context (Any | None) – Additional context to pass to the validator.

Raises:

ValidationError – If the object could not be validated.

Return type:

Self

Returns:

The validated model instance.

classmethod model_validate_json(json_data, *, strict=None, context=None)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing

Validate the given JSON data against the Pydantic model.

Parameters:

json_data (str | bytes | bytearray) – The JSON data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

Raises:

ValidationError – If json_data is not a JSON string or the object could not be validated.

classmethod model_validate_strings(obj, *, strict=None, context=None)[source]

Validate the given object with string data against the Pydantic model.

Parameters:

obj (Any) – The object containing string data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod parse_obj(obj)[source]

Return type:: Self

classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod schema(by_alias=True, ref_template='#/$defs/{model}')[source]

Return type:: Dict[str, Any]

classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)[source]

Return type:: str

type: Literal['scene_clear_all'][source]

classmethod update_forward_refs(**localns)[source]

Return type:: None

classmethod validate(value)[source]

Return type:: Self

class kittycad.models.ok_modeling_cmd_response.OptionSelectAdd(**data)[source][source]

The response to the ‘SelectAdd’ endpoint

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__abstractmethods__ = frozenset({})[source]

__annotations__ = {'__class_vars__': 'ClassVar[set[str]]', '__private_attributes__': 'ClassVar[Dict[str, ModelPrivateAttr]]', '__pydantic_complete__': 'ClassVar[bool]', '__pydantic_core_schema__': 'ClassVar[CoreSchema]', '__pydantic_custom_init__': 'ClassVar[bool]', '__pydantic_decorators__': 'ClassVar[_decorators.DecoratorInfos]', '__pydantic_extra__': 'dict[str, Any] | None', '__pydantic_fields_set__': 'set[str]', '__pydantic_generic_metadata__': 'ClassVar[_generics.PydanticGenericMetadata]', '__pydantic_parent_namespace__': 'ClassVar[Dict[str, Any] | None]', '__pydantic_post_init__': "ClassVar[None | Literal['model_post_init']]", '__pydantic_private__': 'dict[str, Any] | None', '__pydantic_root_model__': 'ClassVar[bool]', '__pydantic_serializer__': 'ClassVar[SchemaSerializer]', '__pydantic_validator__': 'ClassVar[SchemaValidator | PluggableSchemaValidator]', '__signature__': 'ClassVar[Signature]', 'data': <class 'kittycad.models.select_add.SelectAdd'>, 'model_computed_fields': 'ClassVar[Dict[str, ComputedFieldInfo]]', 'model_config': 'ClassVar[ConfigDict]', 'model_fields': 'ClassVar[Dict[str, FieldInfo]]', 'type': typing.Literal['select_add']}[source]

classmethod __class_getitem__(typevar_values)[source]

Return type:: type[BaseModel] | PydanticRecursiveRef

__class_vars__: ClassVar[set[str]] = {}[source]: The names of the class variables defined on the model.

__copy__()[source]

Returns a shallow copy of the model.

Return type:: Self

__deepcopy__(memo=None)[source]

Returns a deep copy of the model.

Return type:: Self

__delattr__(item)[source]

Implement delattr(self, name).

Return type:: Any

__dict__[source]

__eq__(other)[source]

Return self==value.

Return type:: bool

property __fields_set__: set[str][source]

classmethod __get_pydantic_core_schema__(source, handler, /)[source]

Hook into generating the model’s CoreSchema.

Parameters:

source (type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.
handler (GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.

Return type:

Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]

Returns:

A pydantic-core CoreSchema.

classmethod __get_pydantic_json_schema__(core_schema, handler, /)[source]

Hook into generating the model’s JSON schema.

Parameters:

core_schema (Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({'type': 'nullable', 'schema': current_schema}), or just call the handler with the original schema.
handler (GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.

Return type:

Returns:

A JSON schema, as a Python object.

__getattr__(item)[source]

Return type:: Any

__getstate__()[source]

Helper for pickle.

Return type:: dict[Any, Any]

__hash__ = None[source]

__init__(**data)[source]

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__iter__()[source]

So dict(model) works.

Return type:: Generator[Tuple[str, Any], None, None]

__module__ = 'kittycad.models.ok_modeling_cmd_response'[source]

__pretty__(fmt, **kwargs)[source]

Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.

Return type:: Generator[Any, None, None]

__private_attributes__: ClassVar[Dict[str, ModelPrivateAttr]] = {}[source]: Metadata about the private attributes of the model.

__pydantic_complete__: ClassVar[bool] = True[source]: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__: ClassVar[CoreSchema] = {'cls': <class 'kittycad.models.ok_modeling_cmd_response.OptionSelectAdd'>, 'config': {'title': 'OptionSelectAdd'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.ok_modeling_cmd_response.OptionSelectAdd'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.ok_modeling_cmd_response.OptionSelectAdd'>>]}, 'ref': 'kittycad.models.ok_modeling_cmd_response.OptionSelectAdd:94667212831824', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'data': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.select_add.SelectAdd'>, 'config': {'title': 'SelectAdd'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.select_add.SelectAdd'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.select_add.SelectAdd'>>]}, 'ref': 'kittycad.models.select_add.SelectAdd:94667212401024', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {}, 'model_name': 'SelectAdd', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}, 'type': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': 'select_add', 'schema': {'expected': ['select_add'], 'type': 'literal'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'OptionSelectAdd', 'type': 'model-fields'}, 'type': 'model'}[source]: The core schema of the model.

__pydantic_custom_init__: ClassVar[bool] = False[source]: Whether the model has a custom __init__ method.

__pydantic_decorators__: ClassVar[_decorators.DecoratorInfos] = DecoratorInfos(validators={}, field_validators={}, root_validators={}, field_serializers={}, model_serializers={}, model_validators={}, computed_fields={})[source]: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_extra__: dict[str, Any] | None[source]: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to 'allow'.

__pydantic_fields_set__: set[str][source]: The names of fields explicitly set during instantiation.

__pydantic_generic_metadata__: ClassVar[_generics.PydanticGenericMetadata] = {'args': (), 'origin': None, 'parameters': ()}[source]: 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.

classmethod __pydantic_init_subclass__(**kwargs)[source]

This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.

This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.

This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.

Parameters:: **kwargs (Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.
Return type:: None

__pydantic_parent_namespace__: ClassVar[Dict[str, Any] | None] = None[source]: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__: ClassVar[None | Literal['model_post_init']] = None[source]: The name of the post-init method for the model, if defined.

__pydantic_private__: dict[str, Any] | None[source]: Values of private attributes set on the model instance.

__pydantic_root_model__: ClassVar[bool] = False[source]: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__: ClassVar[SchemaSerializer] = SchemaSerializer(serializer=Model( ModelSerializer { class: Py( 0x000056196d97bc50, ), serializer: Fields( GeneralFieldsSerializer { fields: { "type": SerField { key_py: Py( 0x00007f903823d958, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f90346e5bf0, ), ), serializer: Literal( LiteralSerializer { expected_int: {}, expected_str: { "select_add", }, expected_py: None, name: "literal['select_add']", }, ), }, ), ), required: true, }, "data": SerField { key_py: Py( 0x00007f9038238fa0, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196d912980, ), serializer: Fields( GeneralFieldsSerializer { fields: {}, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 0, }, ), has_extra: false, root_model: false, name: "SelectAdd", }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "OptionSelectAdd", }, ), definitions=[])[source]: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__: ClassVar[SchemaValidator | PluggableSchemaValidator] = SchemaValidator(title="OptionSelectAdd", validator=Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "data", lookup_key: Simple { key: "data", py_key: Py( 0x00007f90334d45d0, ), path: LookupPath( [ S( "data", Py( 0x00007f90334d4600, ), ), ], ), }, name_py: Py( 0x00007f9038238fa0, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [], model_name: "SelectAdd", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d912980, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "SelectAdd", }, ), frozen: false, }, Field { name: "type", lookup_key: Simple { key: "type", py_key: Py( 0x00007f90334d4630, ), path: LookupPath( [ S( "type", Py( 0x00007f90334d4660, ), ), ], ), }, name_py: Py( 0x00007f903823d958, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f90346e5bf0, ), ), on_error: Raise, validator: Literal( LiteralValidator { lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "select_add": 0, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f90346e5bf0, ), ], }, expected_repr: "'select_add'", name: "literal['select_add']", }, ), validate_default: false, copy_default: false, name: "default[literal['select_add']]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "OptionSelectAdd", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d97bc50, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "OptionSelectAdd", }, ), definitions=[], cache_strings=True)[source]: The pydantic-core SchemaValidator used to validate instances of the model.

__repr__()[source]

Return repr(self).

Return type:: str

__repr_args__()[source]

Return type:: Iterable[tuple[str | None, Any]]

__repr_name__()[source]

Name of the instance’s class, used in __repr__.

Return type:: str

__repr_str__(join_str)[source]

Return type:: str

__rich_repr__()[source]

Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.

Return type:: Iterable[Any | tuple[Any] | tuple[str, Any] | tuple[str, Any, Any]]

__setattr__(name, value)[source]

Implement setattr(self, name, value).

Return type:: None

__setstate__(state)[source]

Return type:: None

__signature__: ClassVar[Signature] = <Signature (*, data: kittycad.models.select_add.SelectAdd, type: Literal['select_add'] = 'select_add') -> None>[source]: The synthesized __init__ [Signature][inspect.Signature] of the model.

__slots__ = ('__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__')[source]

__str__()[source]

Return str(self).

Return type:: str

_abc_impl = <_abc._abc_data object>[source]

_calculate_keys(*args, **kwargs)[source]

Return type:: Any

_check_frozen(name, value)[source]

Return type:: None

_copy_and_set_values(*args, **kwargs)[source]

Return type:: Any

classmethod _get_value(*args, **kwargs)[source]

Return type:: Any

_iter(*args, **kwargs)[source]

Return type:: Any

classmethod construct(_fields_set=None, **values)[source]

Return type:: Self

copy(*, include=None, exclude=None, update=None, deep=False)[source]

Returns a copy of the model.

!!! warning “Deprecated”: This method is now deprecated; use model_copy instead.

If you need include or exclude, use:

`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `

Parameters:

include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.

Returns:

A copy of the model with included, excluded and updated fields as specified.

data: SelectAdd[source]

dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)[source]

Return type:: Dict[str, Any]

classmethod from_orm(obj)[source]

Return type:: Self

json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)[source]

Return type:: str

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}[source]: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'protected_namespaces': ()}[source]: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod model_construct(_fields_set=None, **values)[source]

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note: model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == 'allow', then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == 'ignore' (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == 'forbid' does not result in an error if extra values are passed, but they will be ignored.

Parameters:

_fields_set (set[str] | None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.
values (Any) – Trusted or pre-validated data dictionary.

Return type:

Self

Returns:

A new instance of the Model class with validated data.

model_copy(*, update=None, deep=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy

Returns a copy of the model.

Parameters:

update (dict[str, Any] | None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.
deep (bool) – Set to True to make a deep copy of the model.

Return type:

Self

Returns:

New model instance.

model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters:

mode (Union[Literal['json', 'python'], str]) – The mode in which to_python 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.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to include in the output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to exclude from the output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to use the field’s alias in the dictionary key if defined.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A dictionary representation of the model.

model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

Generates a JSON representation of the model using Pydantic’s to_json method.

Parameters:

indent (int | None) – Indentation to use in the JSON output. If None is passed, the output will be compact.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to include in the JSON output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to exclude from the JSON output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to serialize using field aliases.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A JSON string representation of the model.

property model_extra: dict[str, Any] | None[source]

Get extra fields set during validation.

Returns:: A dictionary of extra fields, or None if config.extra is not set to "allow".

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=SelectAdd, required=True), 'type': FieldInfo(annotation=Literal['select_add'], required=False, default='select_add')}[source]

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

property model_fields_set: set[str][source]

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,: i.e. that were not filled from defaults.

classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')[source]

Generates a JSON schema for a model class.

Parameters:

by_alias (bool) – Whether to use attribute aliases or not.
ref_template (str) – The reference template.
schema_generator (type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modifications
mode (Literal['validation', 'serialization']) – The mode in which to generate the schema.

Return type:

Returns:

The JSON schema for the given model class.

classmethod model_parametrized_name(params)[source]

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

Parameters:: params (tuple[type[Any], ...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.
Return type:: str
Returns:: String representing the new class where params are passed to cls as type variables.
Raises:: TypeError – Raised when trying to generate concrete names for non-generic models.

model_post_init(_BaseModel__context)[source]

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

Return type:: None

classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)[source]

Try to rebuild the pydantic-core schema for the model.

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.

Parameters:

force (bool) – Whether to force the rebuilding of the model schema, defaults to False.
raise_errors (bool) – Whether to raise errors, defaults to True.
_parent_namespace_depth (int) – The depth level of the parent namespace, defaults to 2.
_types_namespace (dict[str, Any] | None) – The types namespace, defaults to None.

Return type:

Returns:

Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.

classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)[source]

Validate a pydantic model instance.

Parameters:

obj (Any) – The object to validate.
strict (bool | None) – Whether to enforce types strictly.
from_attributes (bool | None) – Whether to extract data from object attributes.
context (Any | None) – Additional context to pass to the validator.

Raises:

ValidationError – If the object could not be validated.

Return type:

Self

Returns:

The validated model instance.

classmethod model_validate_json(json_data, *, strict=None, context=None)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing

Validate the given JSON data against the Pydantic model.

Parameters:

json_data (str | bytes | bytearray) – The JSON data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

Raises:

ValidationError – If json_data is not a JSON string or the object could not be validated.

classmethod model_validate_strings(obj, *, strict=None, context=None)[source]

Validate the given object with string data against the Pydantic model.

Parameters:

obj (Any) – The object containing string data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod parse_obj(obj)[source]

Return type:: Self

classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod schema(by_alias=True, ref_template='#/$defs/{model}')[source]

Return type:: Dict[str, Any]

classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)[source]

Return type:: str

type: Literal['select_add'][source]

classmethod update_forward_refs(**localns)[source]

Return type:: None

classmethod validate(value)[source]

Return type:: Self

class kittycad.models.ok_modeling_cmd_response.OptionSelectClear(**data)[source][source]

The response to the ‘SelectClear’ endpoint

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__abstractmethods__ = frozenset({})[source]

__annotations__ = {'__class_vars__': 'ClassVar[set[str]]', '__private_attributes__': 'ClassVar[Dict[str, ModelPrivateAttr]]', '__pydantic_complete__': 'ClassVar[bool]', '__pydantic_core_schema__': 'ClassVar[CoreSchema]', '__pydantic_custom_init__': 'ClassVar[bool]', '__pydantic_decorators__': 'ClassVar[_decorators.DecoratorInfos]', '__pydantic_extra__': 'dict[str, Any] | None', '__pydantic_fields_set__': 'set[str]', '__pydantic_generic_metadata__': 'ClassVar[_generics.PydanticGenericMetadata]', '__pydantic_parent_namespace__': 'ClassVar[Dict[str, Any] | None]', '__pydantic_post_init__': "ClassVar[None | Literal['model_post_init']]", '__pydantic_private__': 'dict[str, Any] | None', '__pydantic_root_model__': 'ClassVar[bool]', '__pydantic_serializer__': 'ClassVar[SchemaSerializer]', '__pydantic_validator__': 'ClassVar[SchemaValidator | PluggableSchemaValidator]', '__signature__': 'ClassVar[Signature]', 'data': <class 'kittycad.models.select_clear.SelectClear'>, 'model_computed_fields': 'ClassVar[Dict[str, ComputedFieldInfo]]', 'model_config': 'ClassVar[ConfigDict]', 'model_fields': 'ClassVar[Dict[str, FieldInfo]]', 'type': typing.Literal['select_clear']}[source]

classmethod __class_getitem__(typevar_values)[source]

Return type:: type[BaseModel] | PydanticRecursiveRef

__class_vars__: ClassVar[set[str]] = {}[source]: The names of the class variables defined on the model.

__copy__()[source]

Returns a shallow copy of the model.

Return type:: Self

__deepcopy__(memo=None)[source]

Returns a deep copy of the model.

Return type:: Self

__delattr__(item)[source]

Implement delattr(self, name).

Return type:: Any

__dict__[source]

__eq__(other)[source]

Return self==value.

Return type:: bool

property __fields_set__: set[str][source]

classmethod __get_pydantic_core_schema__(source, handler, /)[source]

Hook into generating the model’s CoreSchema.

Parameters:

source (type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.
handler (GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.

Return type:

Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]

Returns:

A pydantic-core CoreSchema.

classmethod __get_pydantic_json_schema__(core_schema, handler, /)[source]

Hook into generating the model’s JSON schema.

Parameters:

core_schema (Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({'type': 'nullable', 'schema': current_schema}), or just call the handler with the original schema.
handler (GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.

Return type:

Returns:

A JSON schema, as a Python object.

__getattr__(item)[source]

Return type:: Any

__getstate__()[source]

Helper for pickle.

Return type:: dict[Any, Any]

__hash__ = None[source]

__init__(**data)[source]

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__iter__()[source]

So dict(model) works.

Return type:: Generator[Tuple[str, Any], None, None]

__module__ = 'kittycad.models.ok_modeling_cmd_response'[source]

__pretty__(fmt, **kwargs)[source]

Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.

Return type:: Generator[Any, None, None]

__private_attributes__: ClassVar[Dict[str, ModelPrivateAttr]] = {}[source]: Metadata about the private attributes of the model.

__pydantic_complete__: ClassVar[bool] = True[source]: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__: ClassVar[CoreSchema] = {'cls': <class 'kittycad.models.ok_modeling_cmd_response.OptionSelectClear'>, 'config': {'title': 'OptionSelectClear'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.ok_modeling_cmd_response.OptionSelectClear'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.ok_modeling_cmd_response.OptionSelectClear'>>]}, 'ref': 'kittycad.models.ok_modeling_cmd_response.OptionSelectClear:94667213196304', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'data': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.select_clear.SelectClear'>, 'config': {'title': 'SelectClear'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.select_clear.SelectClear'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.select_clear.SelectClear'>>]}, 'ref': 'kittycad.models.select_clear.SelectClear:94667212399792', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {}, 'model_name': 'SelectClear', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}, 'type': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': 'select_clear', 'schema': {'expected': ['select_clear'], 'type': 'literal'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'OptionSelectClear', 'type': 'model-fields'}, 'type': 'model'}[source]: The core schema of the model.

__pydantic_custom_init__: ClassVar[bool] = False[source]: Whether the model has a custom __init__ method.

__pydantic_decorators__: ClassVar[_decorators.DecoratorInfos] = DecoratorInfos(validators={}, field_validators={}, root_validators={}, field_serializers={}, model_serializers={}, model_validators={}, computed_fields={})[source]: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_extra__: dict[str, Any] | None[source]: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to 'allow'.

__pydantic_fields_set__: set[str][source]: The names of fields explicitly set during instantiation.

__pydantic_generic_metadata__: ClassVar[_generics.PydanticGenericMetadata] = {'args': (), 'origin': None, 'parameters': ()}[source]: 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.

classmethod __pydantic_init_subclass__(**kwargs)[source]

This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.

This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.

This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.

Parameters:: **kwargs (Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.
Return type:: None

__pydantic_parent_namespace__: ClassVar[Dict[str, Any] | None] = None[source]: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__: ClassVar[None | Literal['model_post_init']] = None[source]: The name of the post-init method for the model, if defined.

__pydantic_private__: dict[str, Any] | None[source]: Values of private attributes set on the model instance.

__pydantic_root_model__: ClassVar[bool] = False[source]: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__: ClassVar[SchemaSerializer] = SchemaSerializer(serializer=Model( ModelSerializer { class: Py( 0x000056196d9d4c10, ), serializer: Fields( GeneralFieldsSerializer { fields: { "data": SerField { key_py: Py( 0x00007f9038238fa0, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196d9124b0, ), serializer: Fields( GeneralFieldsSerializer { fields: {}, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 0, }, ), has_extra: false, root_model: false, name: "SelectClear", }, ), ), required: true, }, "type": SerField { key_py: Py( 0x00007f903823d958, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f90346e5c70, ), ), serializer: Literal( LiteralSerializer { expected_int: {}, expected_str: { "select_clear", }, expected_py: None, name: "literal['select_clear']", }, ), }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "OptionSelectClear", }, ), definitions=[])[source]: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__: ClassVar[SchemaValidator | PluggableSchemaValidator] = SchemaValidator(title="OptionSelectClear", validator=Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "data", lookup_key: Simple { key: "data", py_key: Py( 0x00007f9033521f50, ), path: LookupPath( [ S( "data", Py( 0x00007f9033521f80, ), ), ], ), }, name_py: Py( 0x00007f9038238fa0, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [], model_name: "SelectClear", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d9124b0, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "SelectClear", }, ), frozen: false, }, Field { name: "type", lookup_key: Simple { key: "type", py_key: Py( 0x00007f9033521fb0, ), path: LookupPath( [ S( "type", Py( 0x00007f9033521fe0, ), ), ], ), }, name_py: Py( 0x00007f903823d958, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f90346e5c70, ), ), on_error: Raise, validator: Literal( LiteralValidator { lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "select_clear": 0, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f90346e5c70, ), ], }, expected_repr: "'select_clear'", name: "literal['select_clear']", }, ), validate_default: false, copy_default: false, name: "default[literal['select_clear']]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "OptionSelectClear", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d9d4c10, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "OptionSelectClear", }, ), definitions=[], cache_strings=True)[source]: The pydantic-core SchemaValidator used to validate instances of the model.

__repr__()[source]

Return repr(self).

Return type:: str

__repr_args__()[source]

Return type:: Iterable[tuple[str | None, Any]]

__repr_name__()[source]

Name of the instance’s class, used in __repr__.

Return type:: str

__repr_str__(join_str)[source]

Return type:: str

__rich_repr__()[source]

Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.

Return type:: Iterable[Any | tuple[Any] | tuple[str, Any] | tuple[str, Any, Any]]

__setattr__(name, value)[source]

Implement setattr(self, name, value).

Return type:: None

__setstate__(state)[source]

Return type:: None

__signature__: ClassVar[Signature] = <Signature (*, data: kittycad.models.select_clear.SelectClear, type: Literal['select_clear'] = 'select_clear') -> None>[source]: The synthesized __init__ [Signature][inspect.Signature] of the model.

__slots__ = ('__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__')[source]

__str__()[source]

Return str(self).

Return type:: str

_abc_impl = <_abc._abc_data object>[source]

_calculate_keys(*args, **kwargs)[source]

Return type:: Any

_check_frozen(name, value)[source]

Return type:: None

_copy_and_set_values(*args, **kwargs)[source]

Return type:: Any

classmethod _get_value(*args, **kwargs)[source]

Return type:: Any

_iter(*args, **kwargs)[source]

Return type:: Any

classmethod construct(_fields_set=None, **values)[source]

Return type:: Self

copy(*, include=None, exclude=None, update=None, deep=False)[source]

Returns a copy of the model.

!!! warning “Deprecated”: This method is now deprecated; use model_copy instead.

If you need include or exclude, use:

`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `

Parameters:

include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.

Returns:

A copy of the model with included, excluded and updated fields as specified.

data: SelectClear[source]

dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)[source]

Return type:: Dict[str, Any]

classmethod from_orm(obj)[source]

Return type:: Self

json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)[source]

Return type:: str

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}[source]: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'protected_namespaces': ()}[source]: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod model_construct(_fields_set=None, **values)[source]

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note: model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == 'allow', then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == 'ignore' (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == 'forbid' does not result in an error if extra values are passed, but they will be ignored.

Parameters:

_fields_set (set[str] | None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.
values (Any) – Trusted or pre-validated data dictionary.

Return type:

Self

Returns:

A new instance of the Model class with validated data.

model_copy(*, update=None, deep=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy

Returns a copy of the model.

Parameters:

update (dict[str, Any] | None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.
deep (bool) – Set to True to make a deep copy of the model.

Return type:

Self

Returns:

New model instance.

model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters:

mode (Union[Literal['json', 'python'], str]) – The mode in which to_python 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.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to include in the output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to exclude from the output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to use the field’s alias in the dictionary key if defined.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A dictionary representation of the model.

model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

Generates a JSON representation of the model using Pydantic’s to_json method.

Parameters:

indent (int | None) – Indentation to use in the JSON output. If None is passed, the output will be compact.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to include in the JSON output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to exclude from the JSON output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to serialize using field aliases.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A JSON string representation of the model.

property model_extra: dict[str, Any] | None[source]

Get extra fields set during validation.

Returns:: A dictionary of extra fields, or None if config.extra is not set to "allow".

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=SelectClear, required=True), 'type': FieldInfo(annotation=Literal['select_clear'], required=False, default='select_clear')}[source]

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

property model_fields_set: set[str][source]

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,: i.e. that were not filled from defaults.

classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')[source]

Generates a JSON schema for a model class.

Parameters:

by_alias (bool) – Whether to use attribute aliases or not.
ref_template (str) – The reference template.
schema_generator (type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modifications
mode (Literal['validation', 'serialization']) – The mode in which to generate the schema.

Return type:

Returns:

The JSON schema for the given model class.

classmethod model_parametrized_name(params)[source]

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

Parameters:: params (tuple[type[Any], ...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.
Return type:: str
Returns:: String representing the new class where params are passed to cls as type variables.
Raises:: TypeError – Raised when trying to generate concrete names for non-generic models.

model_post_init(_BaseModel__context)[source]

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

Return type:: None

classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)[source]

Try to rebuild the pydantic-core schema for the model.

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.

Parameters:

force (bool) – Whether to force the rebuilding of the model schema, defaults to False.
raise_errors (bool) – Whether to raise errors, defaults to True.
_parent_namespace_depth (int) – The depth level of the parent namespace, defaults to 2.
_types_namespace (dict[str, Any] | None) – The types namespace, defaults to None.

Return type:

Returns:

Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.

classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)[source]

Validate a pydantic model instance.

Parameters:

obj (Any) – The object to validate.
strict (bool | None) – Whether to enforce types strictly.
from_attributes (bool | None) – Whether to extract data from object attributes.
context (Any | None) – Additional context to pass to the validator.

Raises:

ValidationError – If the object could not be validated.

Return type:

Self

Returns:

The validated model instance.

classmethod model_validate_json(json_data, *, strict=None, context=None)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing

Validate the given JSON data against the Pydantic model.

Parameters:

json_data (str | bytes | bytearray) – The JSON data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

Raises:

ValidationError – If json_data is not a JSON string or the object could not be validated.

classmethod model_validate_strings(obj, *, strict=None, context=None)[source]

Validate the given object with string data against the Pydantic model.

Parameters:

obj (Any) – The object containing string data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod parse_obj(obj)[source]

Return type:: Self

classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod schema(by_alias=True, ref_template='#/$defs/{model}')[source]

Return type:: Dict[str, Any]

classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)[source]

Return type:: str

type: Literal['select_clear'][source]

classmethod update_forward_refs(**localns)[source]

Return type:: None

classmethod validate(value)[source]

Return type:: Self

class kittycad.models.ok_modeling_cmd_response.OptionSelectGet(**data)[source][source]

The response to the ‘SelectGet’ endpoint

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__abstractmethods__ = frozenset({})[source]

__annotations__ = {'__class_vars__': 'ClassVar[set[str]]', '__private_attributes__': 'ClassVar[Dict[str, ModelPrivateAttr]]', '__pydantic_complete__': 'ClassVar[bool]', '__pydantic_core_schema__': 'ClassVar[CoreSchema]', '__pydantic_custom_init__': 'ClassVar[bool]', '__pydantic_decorators__': 'ClassVar[_decorators.DecoratorInfos]', '__pydantic_extra__': 'dict[str, Any] | None', '__pydantic_fields_set__': 'set[str]', '__pydantic_generic_metadata__': 'ClassVar[_generics.PydanticGenericMetadata]', '__pydantic_parent_namespace__': 'ClassVar[Dict[str, Any] | None]', '__pydantic_post_init__': "ClassVar[None | Literal['model_post_init']]", '__pydantic_private__': 'dict[str, Any] | None', '__pydantic_root_model__': 'ClassVar[bool]', '__pydantic_serializer__': 'ClassVar[SchemaSerializer]', '__pydantic_validator__': 'ClassVar[SchemaValidator | PluggableSchemaValidator]', '__signature__': 'ClassVar[Signature]', 'data': <class 'kittycad.models.select_get.SelectGet'>, 'model_computed_fields': 'ClassVar[Dict[str, ComputedFieldInfo]]', 'model_config': 'ClassVar[ConfigDict]', 'model_fields': 'ClassVar[Dict[str, FieldInfo]]', 'type': typing.Literal['select_get']}[source]

classmethod __class_getitem__(typevar_values)[source]

Return type:: type[BaseModel] | PydanticRecursiveRef

__class_vars__: ClassVar[set[str]] = {}[source]: The names of the class variables defined on the model.

__copy__()[source]

Returns a shallow copy of the model.

Return type:: Self

__deepcopy__(memo=None)[source]

Returns a deep copy of the model.

Return type:: Self

__delattr__(item)[source]

Implement delattr(self, name).

Return type:: Any

__dict__[source]

__eq__(other)[source]

Return self==value.

Return type:: bool

property __fields_set__: set[str][source]

classmethod __get_pydantic_core_schema__(source, handler, /)[source]

Hook into generating the model’s CoreSchema.

Parameters:

source (type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.
handler (GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.

Return type:

Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]

Returns:

A pydantic-core CoreSchema.

classmethod __get_pydantic_json_schema__(core_schema, handler, /)[source]

Hook into generating the model’s JSON schema.

Parameters:

core_schema (Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({'type': 'nullable', 'schema': current_schema}), or just call the handler with the original schema.
handler (GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.

Return type:

Returns:

A JSON schema, as a Python object.

__getattr__(item)[source]

Return type:: Any

__getstate__()[source]

Helper for pickle.

Return type:: dict[Any, Any]

__hash__ = None[source]

__init__(**data)[source]

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__iter__()[source]

So dict(model) works.

Return type:: Generator[Tuple[str, Any], None, None]

__module__ = 'kittycad.models.ok_modeling_cmd_response'[source]

__pretty__(fmt, **kwargs)[source]

Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.

Return type:: Generator[Any, None, None]

__private_attributes__: ClassVar[Dict[str, ModelPrivateAttr]] = {}[source]: Metadata about the private attributes of the model.

__pydantic_complete__: ClassVar[bool] = True[source]: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__: ClassVar[CoreSchema] = {'cls': <class 'kittycad.models.ok_modeling_cmd_response.OptionSelectGet'>, 'config': {'title': 'OptionSelectGet'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.ok_modeling_cmd_response.OptionSelectGet'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.ok_modeling_cmd_response.OptionSelectGet'>>]}, 'ref': 'kittycad.models.ok_modeling_cmd_response.OptionSelectGet:94667213576928', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'data': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.select_get.SelectGet'>, 'config': {'title': 'SelectGet'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.select_get.SelectGet'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.select_get.SelectGet'>>]}, 'ref': 'kittycad.models.select_get.SelectGet:94667212410224', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'entity_ids': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'items_schema': {'type': 'str'}, 'type': 'list'}, 'type': 'model-field'}}, 'model_name': 'SelectGet', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}, 'type': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': 'select_get', 'schema': {'expected': ['select_get'], 'type': 'literal'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'OptionSelectGet', 'type': 'model-fields'}, 'type': 'model'}[source]: The core schema of the model.

__pydantic_custom_init__: ClassVar[bool] = False[source]: Whether the model has a custom __init__ method.

__pydantic_decorators__: ClassVar[_decorators.DecoratorInfos] = DecoratorInfos(validators={}, field_validators={}, root_validators={}, field_serializers={}, model_serializers={}, model_validators={}, computed_fields={})[source]: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_extra__: dict[str, Any] | None[source]: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to 'allow'.

__pydantic_fields_set__: set[str][source]: The names of fields explicitly set during instantiation.

__pydantic_generic_metadata__: ClassVar[_generics.PydanticGenericMetadata] = {'args': (), 'origin': None, 'parameters': ()}[source]: 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.

classmethod __pydantic_init_subclass__(**kwargs)[source]

This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.

This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.

This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.

Parameters:: **kwargs (Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.
Return type:: None

__pydantic_parent_namespace__: ClassVar[Dict[str, Any] | None] = None[source]: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__: ClassVar[None | Literal['model_post_init']] = None[source]: The name of the post-init method for the model, if defined.

__pydantic_private__: dict[str, Any] | None[source]: Values of private attributes set on the model instance.

__pydantic_root_model__: ClassVar[bool] = False[source]: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__: ClassVar[SchemaSerializer] = SchemaSerializer(serializer=Model( ModelSerializer { class: Py( 0x000056196da31ae0, ), serializer: Fields( GeneralFieldsSerializer { fields: { "data": SerField { key_py: Py( 0x00007f9038238fa0, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196d914d70, ), serializer: Fields( GeneralFieldsSerializer { fields: { "entity_ids": SerField { key_py: Py( 0x00007f9033b07170, ), alias: None, alias_py: None, serializer: Some( List( ListSerializer { item_serializer: Str( StrSerializer, ), filter: SchemaFilter { include: None, exclude: None, }, name: "list[str]", }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 1, }, ), has_extra: false, root_model: false, name: "SelectGet", }, ), ), required: true, }, "type": SerField { key_py: Py( 0x00007f903823d958, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f90346e5cf0, ), ), serializer: Literal( LiteralSerializer { expected_int: {}, expected_str: { "select_get", }, expected_py: None, name: "literal['select_get']", }, ), }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "OptionSelectGet", }, ), definitions=[])[source]: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__: ClassVar[SchemaValidator | PluggableSchemaValidator] = SchemaValidator(title="OptionSelectGet", validator=Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "data", lookup_key: Simple { key: "data", py_key: Py( 0x00007f903336db00, ), path: LookupPath( [ S( "data", Py( 0x00007f903336db30, ), ), ], ), }, name_py: Py( 0x00007f9038238fa0, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "entity_ids", lookup_key: Simple { key: "entity_ids", py_key: Py( 0x00007f9033383a70, ), path: LookupPath( [ S( "entity_ids", Py( 0x00007f9033383a30, ), ), ], ), }, name_py: Py( 0x00007f9033b07170, ), validator: List( ListValidator { strict: false, item_validator: Some( Str( StrValidator { strict: false, coerce_numbers_to_str: false, }, ), ), min_length: None, max_length: None, name: OnceLock( <uninit>, ), fail_fast: false, }, ), frozen: false, }, ], model_name: "SelectGet", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d914d70, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "SelectGet", }, ), frozen: false, }, Field { name: "type", lookup_key: Simple { key: "type", py_key: Py( 0x00007f903336db60, ), path: LookupPath( [ S( "type", Py( 0x00007f903336db90, ), ), ], ), }, name_py: Py( 0x00007f903823d958, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f90346e5cf0, ), ), on_error: Raise, validator: Literal( LiteralValidator { lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "select_get": 0, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f90346e5cf0, ), ], }, expected_repr: "'select_get'", name: "literal['select_get']", }, ), validate_default: false, copy_default: false, name: "default[literal['select_get']]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "OptionSelectGet", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196da31ae0, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "OptionSelectGet", }, ), definitions=[], cache_strings=True)[source]: The pydantic-core SchemaValidator used to validate instances of the model.

__repr__()[source]

Return repr(self).

Return type:: str

__repr_args__()[source]

Return type:: Iterable[tuple[str | None, Any]]

__repr_name__()[source]

Name of the instance’s class, used in __repr__.

Return type:: str

__repr_str__(join_str)[source]

Return type:: str

__rich_repr__()[source]

Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.

Return type:: Iterable[Any | tuple[Any] | tuple[str, Any] | tuple[str, Any, Any]]

__setattr__(name, value)[source]

Implement setattr(self, name, value).

Return type:: None

__setstate__(state)[source]

Return type:: None

__signature__: ClassVar[Signature] = <Signature (*, data: kittycad.models.select_get.SelectGet, type: Literal['select_get'] = 'select_get') -> None>[source]: The synthesized __init__ [Signature][inspect.Signature] of the model.

__slots__ = ('__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__')[source]

__str__()[source]

Return str(self).

Return type:: str

_abc_impl = <_abc._abc_data object>[source]

_calculate_keys(*args, **kwargs)[source]

Return type:: Any

_check_frozen(name, value)[source]

Return type:: None

_copy_and_set_values(*args, **kwargs)[source]

Return type:: Any

classmethod _get_value(*args, **kwargs)[source]

Return type:: Any

_iter(*args, **kwargs)[source]

Return type:: Any

classmethod construct(_fields_set=None, **values)[source]

Return type:: Self

copy(*, include=None, exclude=None, update=None, deep=False)[source]

Returns a copy of the model.

!!! warning “Deprecated”: This method is now deprecated; use model_copy instead.

If you need include or exclude, use:

`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `

Parameters:

include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.

Returns:

A copy of the model with included, excluded and updated fields as specified.

data: SelectGet[source]

dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)[source]

Return type:: Dict[str, Any]

classmethod from_orm(obj)[source]

Return type:: Self

json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)[source]

Return type:: str

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}[source]: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'protected_namespaces': ()}[source]: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod model_construct(_fields_set=None, **values)[source]

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note: model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == 'allow', then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == 'ignore' (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == 'forbid' does not result in an error if extra values are passed, but they will be ignored.

Parameters:

_fields_set (set[str] | None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.
values (Any) – Trusted or pre-validated data dictionary.

Return type:

Self

Returns:

A new instance of the Model class with validated data.

model_copy(*, update=None, deep=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy

Returns a copy of the model.

Parameters:

update (dict[str, Any] | None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.
deep (bool) – Set to True to make a deep copy of the model.

Return type:

Self

Returns:

New model instance.

model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters:

mode (Union[Literal['json', 'python'], str]) – The mode in which to_python 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.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to include in the output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to exclude from the output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to use the field’s alias in the dictionary key if defined.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A dictionary representation of the model.

model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

Generates a JSON representation of the model using Pydantic’s to_json method.

Parameters:

indent (int | None) – Indentation to use in the JSON output. If None is passed, the output will be compact.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to include in the JSON output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to exclude from the JSON output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to serialize using field aliases.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A JSON string representation of the model.

property model_extra: dict[str, Any] | None[source]

Get extra fields set during validation.

Returns:: A dictionary of extra fields, or None if config.extra is not set to "allow".

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=SelectGet, required=True), 'type': FieldInfo(annotation=Literal['select_get'], required=False, default='select_get')}[source]

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

property model_fields_set: set[str][source]

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,: i.e. that were not filled from defaults.

classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')[source]

Generates a JSON schema for a model class.

Parameters:

by_alias (bool) – Whether to use attribute aliases or not.
ref_template (str) – The reference template.
schema_generator (type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modifications
mode (Literal['validation', 'serialization']) – The mode in which to generate the schema.

Return type:

Returns:

The JSON schema for the given model class.

classmethod model_parametrized_name(params)[source]

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

Parameters:: params (tuple[type[Any], ...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.
Return type:: str
Returns:: String representing the new class where params are passed to cls as type variables.
Raises:: TypeError – Raised when trying to generate concrete names for non-generic models.

model_post_init(_BaseModel__context)[source]

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

Return type:: None

classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)[source]

Try to rebuild the pydantic-core schema for the model.

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.

Parameters:

force (bool) – Whether to force the rebuilding of the model schema, defaults to False.
raise_errors (bool) – Whether to raise errors, defaults to True.
_parent_namespace_depth (int) – The depth level of the parent namespace, defaults to 2.
_types_namespace (dict[str, Any] | None) – The types namespace, defaults to None.

Return type:

Returns:

Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.

classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)[source]

Validate a pydantic model instance.

Parameters:

obj (Any) – The object to validate.
strict (bool | None) – Whether to enforce types strictly.
from_attributes (bool | None) – Whether to extract data from object attributes.
context (Any | None) – Additional context to pass to the validator.

Raises:

ValidationError – If the object could not be validated.

Return type:

Self

Returns:

The validated model instance.

classmethod model_validate_json(json_data, *, strict=None, context=None)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing

Validate the given JSON data against the Pydantic model.

Parameters:

json_data (str | bytes | bytearray) – The JSON data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

Raises:

ValidationError – If json_data is not a JSON string or the object could not be validated.

classmethod model_validate_strings(obj, *, strict=None, context=None)[source]

Validate the given object with string data against the Pydantic model.

Parameters:

obj (Any) – The object containing string data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod parse_obj(obj)[source]

Return type:: Self

classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod schema(by_alias=True, ref_template='#/$defs/{model}')[source]

Return type:: Dict[str, Any]

classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)[source]

Return type:: str

type: Literal['select_get'][source]

classmethod update_forward_refs(**localns)[source]

Return type:: None

classmethod validate(value)[source]

Return type:: Self

class kittycad.models.ok_modeling_cmd_response.OptionSelectRemove(**data)[source][source]

The response to the ‘SelectRemove’ endpoint

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__abstractmethods__ = frozenset({})[source]

__annotations__ = {'__class_vars__': 'ClassVar[set[str]]', '__private_attributes__': 'ClassVar[Dict[str, ModelPrivateAttr]]', '__pydantic_complete__': 'ClassVar[bool]', '__pydantic_core_schema__': 'ClassVar[CoreSchema]', '__pydantic_custom_init__': 'ClassVar[bool]', '__pydantic_decorators__': 'ClassVar[_decorators.DecoratorInfos]', '__pydantic_extra__': 'dict[str, Any] | None', '__pydantic_fields_set__': 'set[str]', '__pydantic_generic_metadata__': 'ClassVar[_generics.PydanticGenericMetadata]', '__pydantic_parent_namespace__': 'ClassVar[Dict[str, Any] | None]', '__pydantic_post_init__': "ClassVar[None | Literal['model_post_init']]", '__pydantic_private__': 'dict[str, Any] | None', '__pydantic_root_model__': 'ClassVar[bool]', '__pydantic_serializer__': 'ClassVar[SchemaSerializer]', '__pydantic_validator__': 'ClassVar[SchemaValidator | PluggableSchemaValidator]', '__signature__': 'ClassVar[Signature]', 'data': <class 'kittycad.models.select_remove.SelectRemove'>, 'model_computed_fields': 'ClassVar[Dict[str, ComputedFieldInfo]]', 'model_config': 'ClassVar[ConfigDict]', 'model_fields': 'ClassVar[Dict[str, FieldInfo]]', 'type': typing.Literal['select_remove']}[source]

classmethod __class_getitem__(typevar_values)[source]

Return type:: type[BaseModel] | PydanticRecursiveRef

__class_vars__: ClassVar[set[str]] = {}[source]: The names of the class variables defined on the model.

__copy__()[source]

Returns a shallow copy of the model.

Return type:: Self

__deepcopy__(memo=None)[source]

Returns a deep copy of the model.

Return type:: Self

__delattr__(item)[source]

Implement delattr(self, name).

Return type:: Any

__dict__[source]

__eq__(other)[source]

Return self==value.

Return type:: bool

property __fields_set__: set[str][source]

classmethod __get_pydantic_core_schema__(source, handler, /)[source]

Hook into generating the model’s CoreSchema.

Parameters:

source (type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.
handler (GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.

Return type:

Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]

Returns:

A pydantic-core CoreSchema.

classmethod __get_pydantic_json_schema__(core_schema, handler, /)[source]

Hook into generating the model’s JSON schema.

Parameters:

core_schema (Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({'type': 'nullable', 'schema': current_schema}), or just call the handler with the original schema.
handler (GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.

Return type:

Returns:

A JSON schema, as a Python object.

__getattr__(item)[source]

Return type:: Any

__getstate__()[source]

Helper for pickle.

Return type:: dict[Any, Any]

__hash__ = None[source]

__init__(**data)[source]

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__iter__()[source]

So dict(model) works.

Return type:: Generator[Tuple[str, Any], None, None]

__module__ = 'kittycad.models.ok_modeling_cmd_response'[source]

__pretty__(fmt, **kwargs)[source]

Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.

Return type:: Generator[Any, None, None]

__private_attributes__: ClassVar[Dict[str, ModelPrivateAttr]] = {}[source]: Metadata about the private attributes of the model.

__pydantic_complete__: ClassVar[bool] = True[source]: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__: ClassVar[CoreSchema] = {'cls': <class 'kittycad.models.ok_modeling_cmd_response.OptionSelectRemove'>, 'config': {'title': 'OptionSelectRemove'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.ok_modeling_cmd_response.OptionSelectRemove'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.ok_modeling_cmd_response.OptionSelectRemove'>>]}, 'ref': 'kittycad.models.ok_modeling_cmd_response.OptionSelectRemove:94667212840736', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'data': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.select_remove.SelectRemove'>, 'config': {'title': 'SelectRemove'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.select_remove.SelectRemove'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.select_remove.SelectRemove'>>]}, 'ref': 'kittycad.models.select_remove.SelectRemove:94667212425456', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {}, 'model_name': 'SelectRemove', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}, 'type': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': 'select_remove', 'schema': {'expected': ['select_remove'], 'type': 'literal'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'OptionSelectRemove', 'type': 'model-fields'}, 'type': 'model'}[source]: The core schema of the model.

__pydantic_custom_init__: ClassVar[bool] = False[source]: Whether the model has a custom __init__ method.

__pydantic_decorators__: ClassVar[_decorators.DecoratorInfos] = DecoratorInfos(validators={}, field_validators={}, root_validators={}, field_serializers={}, model_serializers={}, model_validators={}, computed_fields={})[source]: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_extra__: dict[str, Any] | None[source]: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to 'allow'.

__pydantic_fields_set__: set[str][source]: The names of fields explicitly set during instantiation.

__pydantic_generic_metadata__: ClassVar[_generics.PydanticGenericMetadata] = {'args': (), 'origin': None, 'parameters': ()}[source]: 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.

classmethod __pydantic_init_subclass__(**kwargs)[source]

This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.

This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.

This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.

Parameters:: **kwargs (Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.
Return type:: None

__pydantic_parent_namespace__: ClassVar[Dict[str, Any] | None] = None[source]: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__: ClassVar[None | Literal['model_post_init']] = None[source]: The name of the post-init method for the model, if defined.

__pydantic_private__: dict[str, Any] | None[source]: Values of private attributes set on the model instance.

__pydantic_root_model__: ClassVar[bool] = False[source]: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__: ClassVar[SchemaSerializer] = SchemaSerializer(serializer=Model( ModelSerializer { class: Py( 0x000056196d97df20, ), serializer: Fields( GeneralFieldsSerializer { fields: { "type": SerField { key_py: Py( 0x00007f903823d958, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f90346e5d70, ), ), serializer: Literal( LiteralSerializer { expected_int: {}, expected_str: { "select_remove", }, expected_py: None, name: "literal['select_remove']", }, ), }, ), ), required: true, }, "data": SerField { key_py: Py( 0x00007f9038238fa0, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196d9188f0, ), serializer: Fields( GeneralFieldsSerializer { fields: {}, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 0, }, ), has_extra: false, root_model: false, name: "SelectRemove", }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "OptionSelectRemove", }, ), definitions=[])[source]: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__: ClassVar[SchemaValidator | PluggableSchemaValidator] = SchemaValidator(title="OptionSelectRemove", validator=Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "data", lookup_key: Simple { key: "data", py_key: Py( 0x00007f9033607990, ), path: LookupPath( [ S( "data", Py( 0x00007f9033607900, ), ), ], ), }, name_py: Py( 0x00007f9038238fa0, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [], model_name: "SelectRemove", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d9188f0, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "SelectRemove", }, ), frozen: false, }, Field { name: "type", lookup_key: Simple { key: "type", py_key: Py( 0x00007f9033607ae0, ), path: LookupPath( [ S( "type", Py( 0x00007f9033607870, ), ), ], ), }, name_py: Py( 0x00007f903823d958, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f90346e5d70, ), ), on_error: Raise, validator: Literal( LiteralValidator { lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "select_remove": 0, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f90346e5d70, ), ], }, expected_repr: "'select_remove'", name: "literal['select_remove']", }, ), validate_default: false, copy_default: false, name: "default[literal['select_remove']]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "OptionSelectRemove", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d97df20, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "OptionSelectRemove", }, ), definitions=[], cache_strings=True)[source]: The pydantic-core SchemaValidator used to validate instances of the model.

__repr__()[source]

Return repr(self).

Return type:: str

__repr_args__()[source]

Return type:: Iterable[tuple[str | None, Any]]

__repr_name__()[source]

Name of the instance’s class, used in __repr__.

Return type:: str

__repr_str__(join_str)[source]

Return type:: str

__rich_repr__()[source]

Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.

Return type:: Iterable[Any | tuple[Any] | tuple[str, Any] | tuple[str, Any, Any]]

__setattr__(name, value)[source]

Implement setattr(self, name, value).

Return type:: None

__setstate__(state)[source]

Return type:: None

__signature__: ClassVar[Signature] = <Signature (*, data: kittycad.models.select_remove.SelectRemove, type: Literal['select_remove'] = 'select_remove') -> None>[source]: The synthesized __init__ [Signature][inspect.Signature] of the model.

__slots__ = ('__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__')[source]

__str__()[source]

Return str(self).

Return type:: str

_abc_impl = <_abc._abc_data object>[source]

_calculate_keys(*args, **kwargs)[source]

Return type:: Any

_check_frozen(name, value)[source]

Return type:: None

_copy_and_set_values(*args, **kwargs)[source]

Return type:: Any

classmethod _get_value(*args, **kwargs)[source]

Return type:: Any

_iter(*args, **kwargs)[source]

Return type:: Any

classmethod construct(_fields_set=None, **values)[source]

Return type:: Self

copy(*, include=None, exclude=None, update=None, deep=False)[source]

Returns a copy of the model.

!!! warning “Deprecated”: This method is now deprecated; use model_copy instead.

If you need include or exclude, use:

`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `

Parameters:

include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.

Returns:

A copy of the model with included, excluded and updated fields as specified.

data: SelectRemove[source]

dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)[source]

Return type:: Dict[str, Any]

classmethod from_orm(obj)[source]

Return type:: Self

json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)[source]

Return type:: str

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}[source]: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'protected_namespaces': ()}[source]: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod model_construct(_fields_set=None, **values)[source]

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note: model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == 'allow', then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == 'ignore' (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == 'forbid' does not result in an error if extra values are passed, but they will be ignored.

Parameters:

_fields_set (set[str] | None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.
values (Any) – Trusted or pre-validated data dictionary.

Return type:

Self

Returns:

A new instance of the Model class with validated data.

model_copy(*, update=None, deep=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy

Returns a copy of the model.

Parameters:

update (dict[str, Any] | None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.
deep (bool) – Set to True to make a deep copy of the model.

Return type:

Self

Returns:

New model instance.

model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters:

mode (Union[Literal['json', 'python'], str]) – The mode in which to_python 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.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to include in the output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to exclude from the output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to use the field’s alias in the dictionary key if defined.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A dictionary representation of the model.

model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

Generates a JSON representation of the model using Pydantic’s to_json method.

Parameters:

indent (int | None) – Indentation to use in the JSON output. If None is passed, the output will be compact.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to include in the JSON output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to exclude from the JSON output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to serialize using field aliases.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A JSON string representation of the model.

property model_extra: dict[str, Any] | None[source]

Get extra fields set during validation.

Returns:: A dictionary of extra fields, or None if config.extra is not set to "allow".

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=SelectRemove, required=True), 'type': FieldInfo(annotation=Literal['select_remove'], required=False, default='select_remove')}[source]

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

property model_fields_set: set[str][source]

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,: i.e. that were not filled from defaults.

classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')[source]

Generates a JSON schema for a model class.

Parameters:

by_alias (bool) – Whether to use attribute aliases or not.
ref_template (str) – The reference template.
schema_generator (type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modifications
mode (Literal['validation', 'serialization']) – The mode in which to generate the schema.

Return type:

Returns:

The JSON schema for the given model class.

classmethod model_parametrized_name(params)[source]

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

Parameters:: params (tuple[type[Any], ...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.
Return type:: str
Returns:: String representing the new class where params are passed to cls as type variables.
Raises:: TypeError – Raised when trying to generate concrete names for non-generic models.

model_post_init(_BaseModel__context)[source]

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

Return type:: None

classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)[source]

Try to rebuild the pydantic-core schema for the model.

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.

Parameters:

force (bool) – Whether to force the rebuilding of the model schema, defaults to False.
raise_errors (bool) – Whether to raise errors, defaults to True.
_parent_namespace_depth (int) – The depth level of the parent namespace, defaults to 2.
_types_namespace (dict[str, Any] | None) – The types namespace, defaults to None.

Return type:

Returns:

Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.

classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)[source]

Validate a pydantic model instance.

Parameters:

obj (Any) – The object to validate.
strict (bool | None) – Whether to enforce types strictly.
from_attributes (bool | None) – Whether to extract data from object attributes.
context (Any | None) – Additional context to pass to the validator.

Raises:

ValidationError – If the object could not be validated.

Return type:

Self

Returns:

The validated model instance.

classmethod model_validate_json(json_data, *, strict=None, context=None)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing

Validate the given JSON data against the Pydantic model.

Parameters:

json_data (str | bytes | bytearray) – The JSON data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

Raises:

ValidationError – If json_data is not a JSON string or the object could not be validated.

classmethod model_validate_strings(obj, *, strict=None, context=None)[source]

Validate the given object with string data against the Pydantic model.

Parameters:

obj (Any) – The object containing string data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod parse_obj(obj)[source]

Return type:: Self

classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod schema(by_alias=True, ref_template='#/$defs/{model}')[source]

Return type:: Dict[str, Any]

classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)[source]

Return type:: str

type: Literal['select_remove'][source]

classmethod update_forward_refs(**localns)[source]

Return type:: None

classmethod validate(value)[source]

Return type:: Self

class kittycad.models.ok_modeling_cmd_response.OptionSelectReplace(**data)[source][source]

The response to the ‘SelectReplace’ endpoint

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__abstractmethods__ = frozenset({})[source]

__annotations__ = {'__class_vars__': 'ClassVar[set[str]]', '__private_attributes__': 'ClassVar[Dict[str, ModelPrivateAttr]]', '__pydantic_complete__': 'ClassVar[bool]', '__pydantic_core_schema__': 'ClassVar[CoreSchema]', '__pydantic_custom_init__': 'ClassVar[bool]', '__pydantic_decorators__': 'ClassVar[_decorators.DecoratorInfos]', '__pydantic_extra__': 'dict[str, Any] | None', '__pydantic_fields_set__': 'set[str]', '__pydantic_generic_metadata__': 'ClassVar[_generics.PydanticGenericMetadata]', '__pydantic_parent_namespace__': 'ClassVar[Dict[str, Any] | None]', '__pydantic_post_init__': "ClassVar[None | Literal['model_post_init']]", '__pydantic_private__': 'dict[str, Any] | None', '__pydantic_root_model__': 'ClassVar[bool]', '__pydantic_serializer__': 'ClassVar[SchemaSerializer]', '__pydantic_validator__': 'ClassVar[SchemaValidator | PluggableSchemaValidator]', '__signature__': 'ClassVar[Signature]', 'data': <class 'kittycad.models.select_replace.SelectReplace'>, 'model_computed_fields': 'ClassVar[Dict[str, ComputedFieldInfo]]', 'model_config': 'ClassVar[ConfigDict]', 'model_fields': 'ClassVar[Dict[str, FieldInfo]]', 'type': typing.Literal['select_replace']}[source]

classmethod __class_getitem__(typevar_values)[source]

Return type:: type[BaseModel] | PydanticRecursiveRef

__class_vars__: ClassVar[set[str]] = {}[source]: The names of the class variables defined on the model.

__copy__()[source]

Returns a shallow copy of the model.

Return type:: Self

__deepcopy__(memo=None)[source]

Returns a deep copy of the model.

Return type:: Self

__delattr__(item)[source]

Implement delattr(self, name).

Return type:: Any

__dict__[source]

__eq__(other)[source]

Return self==value.

Return type:: bool

property __fields_set__: set[str][source]

classmethod __get_pydantic_core_schema__(source, handler, /)[source]

Hook into generating the model’s CoreSchema.

Parameters:

source (type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.
handler (GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.

Return type:

Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]

Returns:

A pydantic-core CoreSchema.

classmethod __get_pydantic_json_schema__(core_schema, handler, /)[source]

Hook into generating the model’s JSON schema.

Parameters:

core_schema (Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({'type': 'nullable', 'schema': current_schema}), or just call the handler with the original schema.
handler (GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.

Return type:

Returns:

A JSON schema, as a Python object.

__getattr__(item)[source]

Return type:: Any

__getstate__()[source]

Helper for pickle.

Return type:: dict[Any, Any]

__hash__ = None[source]

__init__(**data)[source]

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__iter__()[source]

So dict(model) works.

Return type:: Generator[Tuple[str, Any], None, None]

__module__ = 'kittycad.models.ok_modeling_cmd_response'[source]

__pretty__(fmt, **kwargs)[source]

Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.

Return type:: Generator[Any, None, None]

__private_attributes__: ClassVar[Dict[str, ModelPrivateAttr]] = {}[source]: Metadata about the private attributes of the model.

__pydantic_complete__: ClassVar[bool] = True[source]: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__: ClassVar[CoreSchema] = {'cls': <class 'kittycad.models.ok_modeling_cmd_response.OptionSelectReplace'>, 'config': {'title': 'OptionSelectReplace'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.ok_modeling_cmd_response.OptionSelectReplace'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.ok_modeling_cmd_response.OptionSelectReplace'>>]}, 'ref': 'kittycad.models.ok_modeling_cmd_response.OptionSelectReplace:94667212859456', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'data': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.select_replace.SelectReplace'>, 'config': {'title': 'SelectReplace'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.select_replace.SelectReplace'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.select_replace.SelectReplace'>>]}, 'ref': 'kittycad.models.select_replace.SelectReplace:94667212434032', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {}, 'model_name': 'SelectReplace', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}, 'type': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': 'select_replace', 'schema': {'expected': ['select_replace'], 'type': 'literal'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'OptionSelectReplace', 'type': 'model-fields'}, 'type': 'model'}[source]: The core schema of the model.

__pydantic_custom_init__: ClassVar[bool] = False[source]: Whether the model has a custom __init__ method.

__pydantic_decorators__: ClassVar[_decorators.DecoratorInfos] = DecoratorInfos(validators={}, field_validators={}, root_validators={}, field_serializers={}, model_serializers={}, model_validators={}, computed_fields={})[source]: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_extra__: dict[str, Any] | None[source]: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to 'allow'.

__pydantic_fields_set__: set[str][source]: The names of fields explicitly set during instantiation.

__pydantic_generic_metadata__: ClassVar[_generics.PydanticGenericMetadata] = {'args': (), 'origin': None, 'parameters': ()}[source]: 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.

classmethod __pydantic_init_subclass__(**kwargs)[source]

This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.

This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.

This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.

Parameters:: **kwargs (Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.
Return type:: None

__pydantic_parent_namespace__: ClassVar[Dict[str, Any] | None] = None[source]: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__: ClassVar[None | Literal['model_post_init']] = None[source]: The name of the post-init method for the model, if defined.

__pydantic_private__: dict[str, Any] | None[source]: Values of private attributes set on the model instance.

__pydantic_root_model__: ClassVar[bool] = False[source]: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__: ClassVar[SchemaSerializer] = SchemaSerializer(serializer=Model( ModelSerializer { class: Py( 0x000056196d982840, ), serializer: Fields( GeneralFieldsSerializer { fields: { "data": SerField { key_py: Py( 0x00007f9038238fa0, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196d91aa70, ), serializer: Fields( GeneralFieldsSerializer { fields: {}, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 0, }, ), has_extra: false, root_model: false, name: "SelectReplace", }, ), ), required: true, }, "type": SerField { key_py: Py( 0x00007f903823d958, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f90346e5df0, ), ), serializer: Literal( LiteralSerializer { expected_int: {}, expected_str: { "select_replace", }, expected_py: None, name: "literal['select_replace']", }, ), }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "OptionSelectReplace", }, ), definitions=[])[source]: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__: ClassVar[SchemaValidator | PluggableSchemaValidator] = SchemaValidator(title="OptionSelectReplace", validator=Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "data", lookup_key: Simple { key: "data", py_key: Py( 0x00007f90336074b0, ), path: LookupPath( [ S( "data", Py( 0x00007f90336074e0, ), ), ], ), }, name_py: Py( 0x00007f9038238fa0, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [], model_name: "SelectReplace", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d91aa70, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "SelectReplace", }, ), frozen: false, }, Field { name: "type", lookup_key: Simple { key: "type", py_key: Py( 0x00007f9033607450, ), path: LookupPath( [ S( "type", Py( 0x00007f9033607d20, ), ), ], ), }, name_py: Py( 0x00007f903823d958, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f90346e5df0, ), ), on_error: Raise, validator: Literal( LiteralValidator { lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "select_replace": 0, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f90346e5df0, ), ], }, expected_repr: "'select_replace'", name: "literal['select_replace']", }, ), validate_default: false, copy_default: false, name: "default[literal['select_replace']]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "OptionSelectReplace", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d982840, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "OptionSelectReplace", }, ), definitions=[], cache_strings=True)[source]: The pydantic-core SchemaValidator used to validate instances of the model.

__repr__()[source]

Return repr(self).

Return type:: str

__repr_args__()[source]

Return type:: Iterable[tuple[str | None, Any]]

__repr_name__()[source]

Name of the instance’s class, used in __repr__.

Return type:: str

__repr_str__(join_str)[source]

Return type:: str

__rich_repr__()[source]

Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.

Return type:: Iterable[Any | tuple[Any] | tuple[str, Any] | tuple[str, Any, Any]]

__setattr__(name, value)[source]

Implement setattr(self, name, value).

Return type:: None

__setstate__(state)[source]

Return type:: None

__signature__: ClassVar[Signature] = <Signature (*, data: kittycad.models.select_replace.SelectReplace, type: Literal['select_replace'] = 'select_replace') -> None>[source]: The synthesized __init__ [Signature][inspect.Signature] of the model.

__slots__ = ('__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__')[source]

__str__()[source]

Return str(self).

Return type:: str

_abc_impl = <_abc._abc_data object>[source]

_calculate_keys(*args, **kwargs)[source]

Return type:: Any

_check_frozen(name, value)[source]

Return type:: None

_copy_and_set_values(*args, **kwargs)[source]

Return type:: Any

classmethod _get_value(*args, **kwargs)[source]

Return type:: Any

_iter(*args, **kwargs)[source]

Return type:: Any

classmethod construct(_fields_set=None, **values)[source]

Return type:: Self

copy(*, include=None, exclude=None, update=None, deep=False)[source]

Returns a copy of the model.

!!! warning “Deprecated”: This method is now deprecated; use model_copy instead.

If you need include or exclude, use:

`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `

Parameters:

include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.

Returns:

A copy of the model with included, excluded and updated fields as specified.

data: SelectReplace[source]

dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)[source]

Return type:: Dict[str, Any]

classmethod from_orm(obj)[source]

Return type:: Self

json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)[source]

Return type:: str

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}[source]: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'protected_namespaces': ()}[source]: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod model_construct(_fields_set=None, **values)[source]

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note: model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == 'allow', then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == 'ignore' (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == 'forbid' does not result in an error if extra values are passed, but they will be ignored.

Parameters:

_fields_set (set[str] | None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.
values (Any) – Trusted or pre-validated data dictionary.

Return type:

Self

Returns:

A new instance of the Model class with validated data.

model_copy(*, update=None, deep=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy

Returns a copy of the model.

Parameters:

update (dict[str, Any] | None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.
deep (bool) – Set to True to make a deep copy of the model.

Return type:

Self

Returns:

New model instance.

model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters:

mode (Union[Literal['json', 'python'], str]) – The mode in which to_python 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.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to include in the output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to exclude from the output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to use the field’s alias in the dictionary key if defined.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A dictionary representation of the model.

model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

Generates a JSON representation of the model using Pydantic’s to_json method.

Parameters:

indent (int | None) – Indentation to use in the JSON output. If None is passed, the output will be compact.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to include in the JSON output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to exclude from the JSON output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to serialize using field aliases.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A JSON string representation of the model.

property model_extra: dict[str, Any] | None[source]

Get extra fields set during validation.

Returns:: A dictionary of extra fields, or None if config.extra is not set to "allow".

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=SelectReplace, required=True), 'type': FieldInfo(annotation=Literal['select_replace'], required=False, default='select_replace')}[source]

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

property model_fields_set: set[str][source]

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,: i.e. that were not filled from defaults.

classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')[source]

Generates a JSON schema for a model class.

Parameters:

by_alias (bool) – Whether to use attribute aliases or not.
ref_template (str) – The reference template.
schema_generator (type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modifications
mode (Literal['validation', 'serialization']) – The mode in which to generate the schema.

Return type:

Returns:

The JSON schema for the given model class.

classmethod model_parametrized_name(params)[source]

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

Parameters:: params (tuple[type[Any], ...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.
Return type:: str
Returns:: String representing the new class where params are passed to cls as type variables.
Raises:: TypeError – Raised when trying to generate concrete names for non-generic models.

model_post_init(_BaseModel__context)[source]

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

Return type:: None

classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)[source]

Try to rebuild the pydantic-core schema for the model.

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.

Parameters:

force (bool) – Whether to force the rebuilding of the model schema, defaults to False.
raise_errors (bool) – Whether to raise errors, defaults to True.
_parent_namespace_depth (int) – The depth level of the parent namespace, defaults to 2.
_types_namespace (dict[str, Any] | None) – The types namespace, defaults to None.

Return type:

Returns:

Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.

classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)[source]

Validate a pydantic model instance.

Parameters:

obj (Any) – The object to validate.
strict (bool | None) – Whether to enforce types strictly.
from_attributes (bool | None) – Whether to extract data from object attributes.
context (Any | None) – Additional context to pass to the validator.

Raises:

ValidationError – If the object could not be validated.

Return type:

Self

Returns:

The validated model instance.

classmethod model_validate_json(json_data, *, strict=None, context=None)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing

Validate the given JSON data against the Pydantic model.

Parameters:

json_data (str | bytes | bytearray) – The JSON data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

Raises:

ValidationError – If json_data is not a JSON string or the object could not be validated.

classmethod model_validate_strings(obj, *, strict=None, context=None)[source]

Validate the given object with string data against the Pydantic model.

Parameters:

obj (Any) – The object containing string data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod parse_obj(obj)[source]

Return type:: Self

classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod schema(by_alias=True, ref_template='#/$defs/{model}')[source]

Return type:: Dict[str, Any]

classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)[source]

Return type:: str

type: Literal['select_replace'][source]

classmethod update_forward_refs(**localns)[source]

Return type:: None

classmethod validate(value)[source]

Return type:: Self

class kittycad.models.ok_modeling_cmd_response.OptionSelectWithPoint(**data)[source][source]

The response to the ‘SelectWithPoint’ endpoint

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__abstractmethods__ = frozenset({})[source]

__annotations__ = {'__class_vars__': 'ClassVar[set[str]]', '__private_attributes__': 'ClassVar[Dict[str, ModelPrivateAttr]]', '__pydantic_complete__': 'ClassVar[bool]', '__pydantic_core_schema__': 'ClassVar[CoreSchema]', '__pydantic_custom_init__': 'ClassVar[bool]', '__pydantic_decorators__': 'ClassVar[_decorators.DecoratorInfos]', '__pydantic_extra__': 'dict[str, Any] | None', '__pydantic_fields_set__': 'set[str]', '__pydantic_generic_metadata__': 'ClassVar[_generics.PydanticGenericMetadata]', '__pydantic_parent_namespace__': 'ClassVar[Dict[str, Any] | None]', '__pydantic_post_init__': "ClassVar[None | Literal['model_post_init']]", '__pydantic_private__': 'dict[str, Any] | None', '__pydantic_root_model__': 'ClassVar[bool]', '__pydantic_serializer__': 'ClassVar[SchemaSerializer]', '__pydantic_validator__': 'ClassVar[SchemaValidator | PluggableSchemaValidator]', '__signature__': 'ClassVar[Signature]', 'data': <class 'kittycad.models.select_with_point.SelectWithPoint'>, 'model_computed_fields': 'ClassVar[Dict[str, ComputedFieldInfo]]', 'model_config': 'ClassVar[ConfigDict]', 'model_fields': 'ClassVar[Dict[str, FieldInfo]]', 'type': typing.Literal['select_with_point']}[source]

classmethod __class_getitem__(typevar_values)[source]

Return type:: type[BaseModel] | PydanticRecursiveRef

__class_vars__: ClassVar[set[str]] = {}[source]: The names of the class variables defined on the model.

__copy__()[source]

Returns a shallow copy of the model.

Return type:: Self

__deepcopy__(memo=None)[source]

Returns a deep copy of the model.

Return type:: Self

__delattr__(item)[source]

Implement delattr(self, name).

Return type:: Any

__dict__[source]

__eq__(other)[source]

Return self==value.

Return type:: bool

property __fields_set__: set[str][source]

classmethod __get_pydantic_core_schema__(source, handler, /)[source]

Hook into generating the model’s CoreSchema.

Parameters:

source (type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.
handler (GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.

Return type:

Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]

Returns:

A pydantic-core CoreSchema.

classmethod __get_pydantic_json_schema__(core_schema, handler, /)[source]

Hook into generating the model’s JSON schema.

Parameters:

core_schema (Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({'type': 'nullable', 'schema': current_schema}), or just call the handler with the original schema.
handler (GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.

Return type:

Returns:

A JSON schema, as a Python object.

__getattr__(item)[source]

Return type:: Any

__getstate__()[source]

Helper for pickle.

Return type:: dict[Any, Any]

__hash__ = None[source]

__init__(**data)[source]

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__iter__()[source]

So dict(model) works.

Return type:: Generator[Tuple[str, Any], None, None]

__module__ = 'kittycad.models.ok_modeling_cmd_response'[source]

__pretty__(fmt, **kwargs)[source]

Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.

Return type:: Generator[Any, None, None]

__private_attributes__: ClassVar[Dict[str, ModelPrivateAttr]] = {}[source]: Metadata about the private attributes of the model.

__pydantic_complete__: ClassVar[bool] = True[source]: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__: ClassVar[CoreSchema] = {'cls': <class 'kittycad.models.ok_modeling_cmd_response.OptionSelectWithPoint'>, 'config': {'title': 'OptionSelectWithPoint'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.ok_modeling_cmd_response.OptionSelectWithPoint'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.ok_modeling_cmd_response.OptionSelectWithPoint'>>]}, 'ref': 'kittycad.models.ok_modeling_cmd_response.OptionSelectWithPoint:94667213214896', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'data': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.select_with_point.SelectWithPoint'>, 'config': {'title': 'SelectWithPoint'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.select_with_point.SelectWithPoint'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.select_with_point.SelectWithPoint'>>]}, 'ref': 'kittycad.models.select_with_point.SelectWithPoint:94667212437280', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'entity_id': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': None, 'schema': {'schema': {'type': 'str'}, 'type': 'nullable'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'SelectWithPoint', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}, 'type': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': 'select_with_point', 'schema': {'expected': ['select_with_point'], 'type': 'literal'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'OptionSelectWithPoint', 'type': 'model-fields'}, 'type': 'model'}[source]: The core schema of the model.

__pydantic_custom_init__: ClassVar[bool] = False[source]: Whether the model has a custom __init__ method.

__pydantic_decorators__: ClassVar[_decorators.DecoratorInfos] = DecoratorInfos(validators={}, field_validators={}, root_validators={}, field_serializers={}, model_serializers={}, model_validators={}, computed_fields={})[source]: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_extra__: dict[str, Any] | None[source]: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to 'allow'.

__pydantic_fields_set__: set[str][source]: The names of fields explicitly set during instantiation.

__pydantic_generic_metadata__: ClassVar[_generics.PydanticGenericMetadata] = {'args': (), 'origin': None, 'parameters': ()}[source]: 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.

classmethod __pydantic_init_subclass__(**kwargs)[source]

This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.

This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.

This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.

Parameters:: **kwargs (Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.
Return type:: None

__pydantic_parent_namespace__: ClassVar[Dict[str, Any] | None] = None[source]: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__: ClassVar[None | Literal['model_post_init']] = None[source]: The name of the post-init method for the model, if defined.

__pydantic_private__: dict[str, Any] | None[source]: Values of private attributes set on the model instance.

__pydantic_root_model__: ClassVar[bool] = False[source]: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__: ClassVar[SchemaSerializer] = SchemaSerializer(serializer=Model( ModelSerializer { class: Py( 0x000056196d9d94b0, ), serializer: Fields( GeneralFieldsSerializer { fields: { "type": SerField { key_py: Py( 0x00007f903823d958, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f90346e5eb0, ), ), serializer: Literal( LiteralSerializer { expected_int: {}, expected_str: { "select_with_point", }, expected_py: None, name: "literal['select_with_point']", }, ), }, ), ), required: true, }, "data": SerField { key_py: Py( 0x00007f9038238fa0, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196d91b720, ), serializer: Fields( GeneralFieldsSerializer { fields: { "entity_id": SerField { key_py: Py( 0x00007f9033b11430, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f9038148100, ), ), serializer: Nullable( NullableSerializer { serializer: Str( StrSerializer, ), }, ), }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 1, }, ), has_extra: false, root_model: false, name: "SelectWithPoint", }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "OptionSelectWithPoint", }, ), definitions=[])[source]: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__: ClassVar[SchemaValidator | PluggableSchemaValidator] = SchemaValidator(title="OptionSelectWithPoint", validator=Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "data", lookup_key: Simple { key: "data", py_key: Py( 0x00007f9033521cb0, ), path: LookupPath( [ S( "data", Py( 0x00007f9033521c50, ), ), ], ), }, name_py: Py( 0x00007f9038238fa0, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "entity_id", lookup_key: Simple { key: "entity_id", py_key: Py( 0x00007f9033340f70, ), path: LookupPath( [ S( "entity_id", Py( 0x00007f9033340ef0, ), ), ], ), }, name_py: Py( 0x00007f9033b11430, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f9038148100, ), ), on_error: Raise, validator: Nullable( NullableValidator { validator: Str( StrValidator { strict: false, coerce_numbers_to_str: false, }, ), name: "nullable[str]", }, ), validate_default: false, copy_default: false, name: "default[nullable[str]]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "SelectWithPoint", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d91b720, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "SelectWithPoint", }, ), frozen: false, }, Field { name: "type", lookup_key: Simple { key: "type", py_key: Py( 0x00007f9033521b90, ), path: LookupPath( [ S( "type", Py( 0x00007f9033521bf0, ), ), ], ), }, name_py: Py( 0x00007f903823d958, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f90346e5eb0, ), ), on_error: Raise, validator: Literal( LiteralValidator { lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "select_with_point": 0, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f90346e5eb0, ), ], }, expected_repr: "'select_with_point'", name: "literal['select_with_point']", }, ), validate_default: false, copy_default: false, name: "default[literal['select_with_point']]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "OptionSelectWithPoint", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d9d94b0, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "OptionSelectWithPoint", }, ), definitions=[], cache_strings=True)[source]: The pydantic-core SchemaValidator used to validate instances of the model.

__repr__()[source]

Return repr(self).

Return type:: str

__repr_args__()[source]

Return type:: Iterable[tuple[str | None, Any]]

__repr_name__()[source]

Name of the instance’s class, used in __repr__.

Return type:: str

__repr_str__(join_str)[source]

Return type:: str

__rich_repr__()[source]

Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.

Return type:: Iterable[Any | tuple[Any] | tuple[str, Any] | tuple[str, Any, Any]]

__setattr__(name, value)[source]

Implement setattr(self, name, value).

Return type:: None

__setstate__(state)[source]

Return type:: None

__signature__: ClassVar[Signature] = <Signature (*, data: kittycad.models.select_with_point.SelectWithPoint, type: Literal['select_with_point'] = 'select_with_point') -> None>[source]: The synthesized __init__ [Signature][inspect.Signature] of the model.

__slots__ = ('__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__')[source]

__str__()[source]

Return str(self).

Return type:: str

_abc_impl = <_abc._abc_data object>[source]

_calculate_keys(*args, **kwargs)[source]

Return type:: Any

_check_frozen(name, value)[source]

Return type:: None

_copy_and_set_values(*args, **kwargs)[source]

Return type:: Any

classmethod _get_value(*args, **kwargs)[source]

Return type:: Any

_iter(*args, **kwargs)[source]

Return type:: Any

classmethod construct(_fields_set=None, **values)[source]

Return type:: Self

copy(*, include=None, exclude=None, update=None, deep=False)[source]

Returns a copy of the model.

!!! warning “Deprecated”: This method is now deprecated; use model_copy instead.

If you need include or exclude, use:

`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `

Parameters:

include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.

Returns:

A copy of the model with included, excluded and updated fields as specified.

data: SelectWithPoint[source]

dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)[source]

Return type:: Dict[str, Any]

classmethod from_orm(obj)[source]

Return type:: Self

json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)[source]

Return type:: str

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}[source]: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'protected_namespaces': ()}[source]: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod model_construct(_fields_set=None, **values)[source]

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note: model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == 'allow', then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == 'ignore' (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == 'forbid' does not result in an error if extra values are passed, but they will be ignored.

Parameters:

_fields_set (set[str] | None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.
values (Any) – Trusted or pre-validated data dictionary.

Return type:

Self

Returns:

A new instance of the Model class with validated data.

model_copy(*, update=None, deep=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy

Returns a copy of the model.

Parameters:

update (dict[str, Any] | None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.
deep (bool) – Set to True to make a deep copy of the model.

Return type:

Self

Returns:

New model instance.

model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters:

mode (Union[Literal['json', 'python'], str]) – The mode in which to_python 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.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to include in the output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to exclude from the output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to use the field’s alias in the dictionary key if defined.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A dictionary representation of the model.

model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

Generates a JSON representation of the model using Pydantic’s to_json method.

Parameters:

indent (int | None) – Indentation to use in the JSON output. If None is passed, the output will be compact.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to include in the JSON output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to exclude from the JSON output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to serialize using field aliases.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A JSON string representation of the model.

property model_extra: dict[str, Any] | None[source]

Get extra fields set during validation.

Returns:: A dictionary of extra fields, or None if config.extra is not set to "allow".

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=SelectWithPoint, required=True), 'type': FieldInfo(annotation=Literal['select_with_point'], required=False, default='select_with_point')}[source]

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

property model_fields_set: set[str][source]

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,: i.e. that were not filled from defaults.

classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')[source]

Generates a JSON schema for a model class.

Parameters:

by_alias (bool) – Whether to use attribute aliases or not.
ref_template (str) – The reference template.
schema_generator (type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modifications
mode (Literal['validation', 'serialization']) – The mode in which to generate the schema.

Return type:

Returns:

The JSON schema for the given model class.

classmethod model_parametrized_name(params)[source]

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

Parameters:: params (tuple[type[Any], ...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.
Return type:: str
Returns:: String representing the new class where params are passed to cls as type variables.
Raises:: TypeError – Raised when trying to generate concrete names for non-generic models.

model_post_init(_BaseModel__context)[source]

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

Return type:: None

classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)[source]

Try to rebuild the pydantic-core schema for the model.

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.

Parameters:

force (bool) – Whether to force the rebuilding of the model schema, defaults to False.
raise_errors (bool) – Whether to raise errors, defaults to True.
_parent_namespace_depth (int) – The depth level of the parent namespace, defaults to 2.
_types_namespace (dict[str, Any] | None) – The types namespace, defaults to None.

Return type:

Returns:

Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.

classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)[source]

Validate a pydantic model instance.

Parameters:

obj (Any) – The object to validate.
strict (bool | None) – Whether to enforce types strictly.
from_attributes (bool | None) – Whether to extract data from object attributes.
context (Any | None) – Additional context to pass to the validator.

Raises:

ValidationError – If the object could not be validated.

Return type:

Self

Returns:

The validated model instance.

classmethod model_validate_json(json_data, *, strict=None, context=None)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing

Validate the given JSON data against the Pydantic model.

Parameters:

json_data (str | bytes | bytearray) – The JSON data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

Raises:

ValidationError – If json_data is not a JSON string or the object could not be validated.

classmethod model_validate_strings(obj, *, strict=None, context=None)[source]

Validate the given object with string data against the Pydantic model.

Parameters:

obj (Any) – The object containing string data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod parse_obj(obj)[source]

Return type:: Self

classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod schema(by_alias=True, ref_template='#/$defs/{model}')[source]

Return type:: Dict[str, Any]

classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)[source]

Return type:: str

type: Literal['select_with_point'][source]

classmethod update_forward_refs(**localns)[source]

Return type:: None

classmethod validate(value)[source]

Return type:: Self

class kittycad.models.ok_modeling_cmd_response.OptionSendObject(**data)[source][source]

The response to the ‘SendObject’ endpoint

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__abstractmethods__ = frozenset({})[source]

__annotations__ = {'__class_vars__': 'ClassVar[set[str]]', '__private_attributes__': 'ClassVar[Dict[str, ModelPrivateAttr]]', '__pydantic_complete__': 'ClassVar[bool]', '__pydantic_core_schema__': 'ClassVar[CoreSchema]', '__pydantic_custom_init__': 'ClassVar[bool]', '__pydantic_decorators__': 'ClassVar[_decorators.DecoratorInfos]', '__pydantic_extra__': 'dict[str, Any] | None', '__pydantic_fields_set__': 'set[str]', '__pydantic_generic_metadata__': 'ClassVar[_generics.PydanticGenericMetadata]', '__pydantic_parent_namespace__': 'ClassVar[Dict[str, Any] | None]', '__pydantic_post_init__': "ClassVar[None | Literal['model_post_init']]", '__pydantic_private__': 'dict[str, Any] | None', '__pydantic_root_model__': 'ClassVar[bool]', '__pydantic_serializer__': 'ClassVar[SchemaSerializer]', '__pydantic_validator__': 'ClassVar[SchemaValidator | PluggableSchemaValidator]', '__signature__': 'ClassVar[Signature]', 'data': <class 'kittycad.models.send_object.SendObject'>, 'model_computed_fields': 'ClassVar[Dict[str, ComputedFieldInfo]]', 'model_config': 'ClassVar[ConfigDict]', 'model_fields': 'ClassVar[Dict[str, FieldInfo]]', 'type': typing.Literal['send_object']}[source]

classmethod __class_getitem__(typevar_values)[source]

Return type:: type[BaseModel] | PydanticRecursiveRef

__class_vars__: ClassVar[set[str]] = {}[source]: The names of the class variables defined on the model.

__copy__()[source]

Returns a shallow copy of the model.

Return type:: Self

__deepcopy__(memo=None)[source]

Returns a deep copy of the model.

Return type:: Self

__delattr__(item)[source]

Implement delattr(self, name).

Return type:: Any

__dict__[source]

__eq__(other)[source]

Return self==value.

Return type:: bool

property __fields_set__: set[str][source]

classmethod __get_pydantic_core_schema__(source, handler, /)[source]

Hook into generating the model’s CoreSchema.

Parameters:

source (type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.
handler (GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.

Return type:

Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]

Returns:

A pydantic-core CoreSchema.

classmethod __get_pydantic_json_schema__(core_schema, handler, /)[source]

Hook into generating the model’s JSON schema.

Parameters:

core_schema (Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({'type': 'nullable', 'schema': current_schema}), or just call the handler with the original schema.
handler (GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.

Return type:

Returns:

A JSON schema, as a Python object.

__getattr__(item)[source]

Return type:: Any

__getstate__()[source]

Helper for pickle.

Return type:: dict[Any, Any]

__hash__ = None[source]

__init__(**data)[source]

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__iter__()[source]

So dict(model) works.

Return type:: Generator[Tuple[str, Any], None, None]

__module__ = 'kittycad.models.ok_modeling_cmd_response'[source]

__pretty__(fmt, **kwargs)[source]

Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.

Return type:: Generator[Any, None, None]

__private_attributes__: ClassVar[Dict[str, ModelPrivateAttr]] = {}[source]: Metadata about the private attributes of the model.

__pydantic_complete__: ClassVar[bool] = True[source]: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__: ClassVar[CoreSchema] = {'cls': <class 'kittycad.models.ok_modeling_cmd_response.OptionSendObject'>, 'config': {'title': 'OptionSendObject'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.ok_modeling_cmd_response.OptionSendObject'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.ok_modeling_cmd_response.OptionSendObject'>>]}, 'ref': 'kittycad.models.ok_modeling_cmd_response.OptionSendObject:94667212952752', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'data': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.send_object.SendObject'>, 'config': {'title': 'SendObject'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.send_object.SendObject'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.send_object.SendObject'>>]}, 'ref': 'kittycad.models.send_object.SendObject:94667212416896', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {}, 'model_name': 'SendObject', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}, 'type': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': 'send_object', 'schema': {'expected': ['send_object'], 'type': 'literal'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'OptionSendObject', 'type': 'model-fields'}, 'type': 'model'}[source]: The core schema of the model.

__pydantic_custom_init__: ClassVar[bool] = False[source]: Whether the model has a custom __init__ method.

__pydantic_decorators__: ClassVar[_decorators.DecoratorInfos] = DecoratorInfos(validators={}, field_validators={}, root_validators={}, field_serializers={}, model_serializers={}, model_validators={}, computed_fields={})[source]: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_extra__: dict[str, Any] | None[source]: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to 'allow'.

__pydantic_fields_set__: set[str][source]: The names of fields explicitly set during instantiation.

__pydantic_generic_metadata__: ClassVar[_generics.PydanticGenericMetadata] = {'args': (), 'origin': None, 'parameters': ()}[source]: 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.

classmethod __pydantic_init_subclass__(**kwargs)[source]

This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.

This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.

This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.

Parameters:: **kwargs (Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.
Return type:: None

__pydantic_parent_namespace__: ClassVar[Dict[str, Any] | None] = None[source]: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__: ClassVar[None | Literal['model_post_init']] = None[source]: The name of the post-init method for the model, if defined.

__pydantic_private__: dict[str, Any] | None[source]: Values of private attributes set on the model instance.

__pydantic_root_model__: ClassVar[bool] = False[source]: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__: ClassVar[SchemaSerializer] = SchemaSerializer(serializer=Model( ModelSerializer { class: Py( 0x000056196d9994b0, ), serializer: Fields( GeneralFieldsSerializer { fields: { "data": SerField { key_py: Py( 0x00007f9038238fa0, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196d916780, ), serializer: Fields( GeneralFieldsSerializer { fields: {}, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 0, }, ), has_extra: false, root_model: false, name: "SendObject", }, ), ), required: true, }, "type": SerField { key_py: Py( 0x00007f903823d958, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f90346e5fb0, ), ), serializer: Literal( LiteralSerializer { expected_int: {}, expected_str: { "send_object", }, expected_py: None, name: "literal['send_object']", }, ), }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "OptionSendObject", }, ), definitions=[])[source]: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__: ClassVar[SchemaValidator | PluggableSchemaValidator] = SchemaValidator(title="OptionSendObject", validator=Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "data", lookup_key: Simple { key: "data", py_key: Py( 0x00007f90334d65b0, ), path: LookupPath( [ S( "data", Py( 0x00007f90334d65e0, ), ), ], ), }, name_py: Py( 0x00007f9038238fa0, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [], model_name: "SendObject", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d916780, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "SendObject", }, ), frozen: false, }, Field { name: "type", lookup_key: Simple { key: "type", py_key: Py( 0x00007f90334d6610, ), path: LookupPath( [ S( "type", Py( 0x00007f90334d6640, ), ), ], ), }, name_py: Py( 0x00007f903823d958, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f90346e5fb0, ), ), on_error: Raise, validator: Literal( LiteralValidator { lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "send_object": 0, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f90346e5fb0, ), ], }, expected_repr: "'send_object'", name: "literal['send_object']", }, ), validate_default: false, copy_default: false, name: "default[literal['send_object']]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "OptionSendObject", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d9994b0, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "OptionSendObject", }, ), definitions=[], cache_strings=True)[source]: The pydantic-core SchemaValidator used to validate instances of the model.

__repr__()[source]

Return repr(self).

Return type:: str

__repr_args__()[source]

Return type:: Iterable[tuple[str | None, Any]]

__repr_name__()[source]

Name of the instance’s class, used in __repr__.

Return type:: str

__repr_str__(join_str)[source]

Return type:: str

__rich_repr__()[source]

Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.

Return type:: Iterable[Any | tuple[Any] | tuple[str, Any] | tuple[str, Any, Any]]

__setattr__(name, value)[source]

Implement setattr(self, name, value).

Return type:: None

__setstate__(state)[source]

Return type:: None

__signature__: ClassVar[Signature] = <Signature (*, data: kittycad.models.send_object.SendObject, type: Literal['send_object'] = 'send_object') -> None>[source]: The synthesized __init__ [Signature][inspect.Signature] of the model.

__slots__ = ('__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__')[source]

__str__()[source]

Return str(self).

Return type:: str

_abc_impl = <_abc._abc_data object>[source]

_calculate_keys(*args, **kwargs)[source]

Return type:: Any

_check_frozen(name, value)[source]

Return type:: None

_copy_and_set_values(*args, **kwargs)[source]

Return type:: Any

classmethod _get_value(*args, **kwargs)[source]

Return type:: Any

_iter(*args, **kwargs)[source]

Return type:: Any

classmethod construct(_fields_set=None, **values)[source]

Return type:: Self

copy(*, include=None, exclude=None, update=None, deep=False)[source]

Returns a copy of the model.

!!! warning “Deprecated”: This method is now deprecated; use model_copy instead.

If you need include or exclude, use:

`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `

Parameters:

include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.

Returns:

A copy of the model with included, excluded and updated fields as specified.

data: SendObject[source]

dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)[source]

Return type:: Dict[str, Any]

classmethod from_orm(obj)[source]

Return type:: Self

json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)[source]

Return type:: str

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}[source]: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'protected_namespaces': ()}[source]: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod model_construct(_fields_set=None, **values)[source]

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note: model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == 'allow', then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == 'ignore' (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == 'forbid' does not result in an error if extra values are passed, but they will be ignored.

Parameters:

_fields_set (set[str] | None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.
values (Any) – Trusted or pre-validated data dictionary.

Return type:

Self

Returns:

A new instance of the Model class with validated data.

model_copy(*, update=None, deep=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy

Returns a copy of the model.

Parameters:

update (dict[str, Any] | None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.
deep (bool) – Set to True to make a deep copy of the model.

Return type:

Self

Returns:

New model instance.

model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters:

mode (Union[Literal['json', 'python'], str]) – The mode in which to_python 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.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to include in the output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to exclude from the output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to use the field’s alias in the dictionary key if defined.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A dictionary representation of the model.

model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

Generates a JSON representation of the model using Pydantic’s to_json method.

Parameters:

indent (int | None) – Indentation to use in the JSON output. If None is passed, the output will be compact.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to include in the JSON output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to exclude from the JSON output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to serialize using field aliases.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A JSON string representation of the model.

property model_extra: dict[str, Any] | None[source]

Get extra fields set during validation.

Returns:: A dictionary of extra fields, or None if config.extra is not set to "allow".

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=SendObject, required=True), 'type': FieldInfo(annotation=Literal['send_object'], required=False, default='send_object')}[source]

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

property model_fields_set: set[str][source]

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,: i.e. that were not filled from defaults.

classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')[source]

Generates a JSON schema for a model class.

Parameters:

by_alias (bool) – Whether to use attribute aliases or not.
ref_template (str) – The reference template.
schema_generator (type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modifications
mode (Literal['validation', 'serialization']) – The mode in which to generate the schema.

Return type:

Returns:

The JSON schema for the given model class.

classmethod model_parametrized_name(params)[source]

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

Parameters:: params (tuple[type[Any], ...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.
Return type:: str
Returns:: String representing the new class where params are passed to cls as type variables.
Raises:: TypeError – Raised when trying to generate concrete names for non-generic models.

model_post_init(_BaseModel__context)[source]

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

Return type:: None

classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)[source]

Try to rebuild the pydantic-core schema for the model.

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.

Parameters:

force (bool) – Whether to force the rebuilding of the model schema, defaults to False.
raise_errors (bool) – Whether to raise errors, defaults to True.
_parent_namespace_depth (int) – The depth level of the parent namespace, defaults to 2.
_types_namespace (dict[str, Any] | None) – The types namespace, defaults to None.

Return type:

Returns:

Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.

classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)[source]

Validate a pydantic model instance.

Parameters:

obj (Any) – The object to validate.
strict (bool | None) – Whether to enforce types strictly.
from_attributes (bool | None) – Whether to extract data from object attributes.
context (Any | None) – Additional context to pass to the validator.

Raises:

ValidationError – If the object could not be validated.

Return type:

Self

Returns:

The validated model instance.

classmethod model_validate_json(json_data, *, strict=None, context=None)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing

Validate the given JSON data against the Pydantic model.

Parameters:

json_data (str | bytes | bytearray) – The JSON data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

Raises:

ValidationError – If json_data is not a JSON string or the object could not be validated.

classmethod model_validate_strings(obj, *, strict=None, context=None)[source]

Validate the given object with string data against the Pydantic model.

Parameters:

obj (Any) – The object containing string data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod parse_obj(obj)[source]

Return type:: Self

classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod schema(by_alias=True, ref_template='#/$defs/{model}')[source]

Return type:: Dict[str, Any]

classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)[source]

Return type:: str

type: Literal['send_object'][source]

classmethod update_forward_refs(**localns)[source]

Return type:: None

classmethod validate(value)[source]

Return type:: Self

class kittycad.models.ok_modeling_cmd_response.OptionSetBackgroundColor(**data)[source][source]

The response to the ‘SetBackgroundColor’ endpoint

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__abstractmethods__ = frozenset({})[source]

__annotations__ = {'__class_vars__': 'ClassVar[set[str]]', '__private_attributes__': 'ClassVar[Dict[str, ModelPrivateAttr]]', '__pydantic_complete__': 'ClassVar[bool]', '__pydantic_core_schema__': 'ClassVar[CoreSchema]', '__pydantic_custom_init__': 'ClassVar[bool]', '__pydantic_decorators__': 'ClassVar[_decorators.DecoratorInfos]', '__pydantic_extra__': 'dict[str, Any] | None', '__pydantic_fields_set__': 'set[str]', '__pydantic_generic_metadata__': 'ClassVar[_generics.PydanticGenericMetadata]', '__pydantic_parent_namespace__': 'ClassVar[Dict[str, Any] | None]', '__pydantic_post_init__': "ClassVar[None | Literal['model_post_init']]", '__pydantic_private__': 'dict[str, Any] | None', '__pydantic_root_model__': 'ClassVar[bool]', '__pydantic_serializer__': 'ClassVar[SchemaSerializer]', '__pydantic_validator__': 'ClassVar[SchemaValidator | PluggableSchemaValidator]', '__signature__': 'ClassVar[Signature]', 'data': <class 'kittycad.models.set_background_color.SetBackgroundColor'>, 'model_computed_fields': 'ClassVar[Dict[str, ComputedFieldInfo]]', 'model_config': 'ClassVar[ConfigDict]', 'model_fields': 'ClassVar[Dict[str, FieldInfo]]', 'type': typing.Literal['set_background_color']}[source]

classmethod __class_getitem__(typevar_values)[source]

Return type:: type[BaseModel] | PydanticRecursiveRef

__class_vars__: ClassVar[set[str]] = {}[source]: The names of the class variables defined on the model.

__copy__()[source]

Returns a shallow copy of the model.

Return type:: Self

__deepcopy__(memo=None)[source]

Returns a deep copy of the model.

Return type:: Self

__delattr__(item)[source]

Implement delattr(self, name).

Return type:: Any

__dict__[source]

__eq__(other)[source]

Return self==value.

Return type:: bool

property __fields_set__: set[str][source]

classmethod __get_pydantic_core_schema__(source, handler, /)[source]

Hook into generating the model’s CoreSchema.

Parameters:

source (type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.
handler (GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.

Return type:

Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]

Returns:

A pydantic-core CoreSchema.

classmethod __get_pydantic_json_schema__(core_schema, handler, /)[source]

Hook into generating the model’s JSON schema.

Parameters:

core_schema (Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({'type': 'nullable', 'schema': current_schema}), or just call the handler with the original schema.
handler (GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.

Return type:

Returns:

A JSON schema, as a Python object.

__getattr__(item)[source]

Return type:: Any

__getstate__()[source]

Helper for pickle.

Return type:: dict[Any, Any]

__hash__ = None[source]

__init__(**data)[source]

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__iter__()[source]

So dict(model) works.

Return type:: Generator[Tuple[str, Any], None, None]

__module__ = 'kittycad.models.ok_modeling_cmd_response'[source]

__pretty__(fmt, **kwargs)[source]

Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.

Return type:: Generator[Any, None, None]

__private_attributes__: ClassVar[Dict[str, ModelPrivateAttr]] = {}[source]: Metadata about the private attributes of the model.

__pydantic_complete__: ClassVar[bool] = True[source]: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__: ClassVar[CoreSchema] = {'cls': <class 'kittycad.models.ok_modeling_cmd_response.OptionSetBackgroundColor'>, 'config': {'title': 'OptionSetBackgroundColor'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.ok_modeling_cmd_response.OptionSetBackgroundColor'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.ok_modeling_cmd_response.OptionSetBackgroundColor'>>]}, 'ref': 'kittycad.models.ok_modeling_cmd_response.OptionSetBackgroundColor:94667213045680', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'data': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.set_background_color.SetBackgroundColor'>, 'config': {'title': 'SetBackgroundColor'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.set_background_color.SetBackgroundColor'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.set_background_color.SetBackgroundColor'>>]}, 'ref': 'kittycad.models.set_background_color.SetBackgroundColor:94667212422064', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {}, 'model_name': 'SetBackgroundColor', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}, 'type': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': 'set_background_color', 'schema': {'expected': ['set_background_color'], 'type': 'literal'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'OptionSetBackgroundColor', 'type': 'model-fields'}, 'type': 'model'}[source]: The core schema of the model.

__pydantic_custom_init__: ClassVar[bool] = False[source]: Whether the model has a custom __init__ method.

__pydantic_decorators__: ClassVar[_decorators.DecoratorInfos] = DecoratorInfos(validators={}, field_validators={}, root_validators={}, field_serializers={}, model_serializers={}, model_validators={}, computed_fields={})[source]: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_extra__: dict[str, Any] | None[source]: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to 'allow'.

__pydantic_fields_set__: set[str][source]: The names of fields explicitly set during instantiation.

__pydantic_generic_metadata__: ClassVar[_generics.PydanticGenericMetadata] = {'args': (), 'origin': None, 'parameters': ()}[source]: 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.

classmethod __pydantic_init_subclass__(**kwargs)[source]

This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.

This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.

This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.

Parameters:: **kwargs (Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.
Return type:: None

__pydantic_parent_namespace__: ClassVar[Dict[str, Any] | None] = None[source]: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__: ClassVar[None | Literal['model_post_init']] = None[source]: The name of the post-init method for the model, if defined.

__pydantic_private__: dict[str, Any] | None[source]: Values of private attributes set on the model instance.

__pydantic_root_model__: ClassVar[bool] = False[source]: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__: ClassVar[SchemaSerializer] = SchemaSerializer(serializer=Model( ModelSerializer { class: Py( 0x000056196d9affb0, ), serializer: Fields( GeneralFieldsSerializer { fields: { "type": SerField { key_py: Py( 0x00007f903823d958, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f90346e6330, ), ), serializer: Literal( LiteralSerializer { expected_int: {}, expected_str: { "set_background_color", }, expected_py: None, name: "literal['set_background_color']", }, ), }, ), ), required: true, }, "data": SerField { key_py: Py( 0x00007f9038238fa0, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196d917bb0, ), serializer: Fields( GeneralFieldsSerializer { fields: {}, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 0, }, ), has_extra: false, root_model: false, name: "SetBackgroundColor", }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "OptionSetBackgroundColor", }, ), definitions=[])[source]: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__: ClassVar[SchemaValidator | PluggableSchemaValidator] = SchemaValidator(title="OptionSetBackgroundColor", validator=Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "data", lookup_key: Simple { key: "data", py_key: Py( 0x00007f90334d61c0, ), path: LookupPath( [ S( "data", Py( 0x00007f90334d6550, ), ), ], ), }, name_py: Py( 0x00007f9038238fa0, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [], model_name: "SetBackgroundColor", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d917bb0, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "SetBackgroundColor", }, ), frozen: false, }, Field { name: "type", lookup_key: Simple { key: "type", py_key: Py( 0x00007f90334d6220, ), path: LookupPath( [ S( "type", Py( 0x00007f90334d75d0, ), ), ], ), }, name_py: Py( 0x00007f903823d958, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f90346e6330, ), ), on_error: Raise, validator: Literal( LiteralValidator { lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "set_background_color": 0, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f90346e6330, ), ], }, expected_repr: "'set_background_color'", name: "literal['set_background_color']", }, ), validate_default: false, copy_default: false, name: "default[literal['set_background_color']]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "OptionSetBackgroundColor", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d9affb0, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "OptionSetBackgroundColor", }, ), definitions=[], cache_strings=True)[source]: The pydantic-core SchemaValidator used to validate instances of the model.

__repr__()[source]

Return repr(self).

Return type:: str

__repr_args__()[source]

Return type:: Iterable[tuple[str | None, Any]]

__repr_name__()[source]

Name of the instance’s class, used in __repr__.

Return type:: str

__repr_str__(join_str)[source]

Return type:: str

__rich_repr__()[source]

Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.

Return type:: Iterable[Any | tuple[Any] | tuple[str, Any] | tuple[str, Any, Any]]

__setattr__(name, value)[source]

Implement setattr(self, name, value).

Return type:: None

__setstate__(state)[source]

Return type:: None

__signature__: ClassVar[Signature] = <Signature (*, data: kittycad.models.set_background_color.SetBackgroundColor, type: Literal['set_background_color'] = 'set_background_color') -> None>[source]: The synthesized __init__ [Signature][inspect.Signature] of the model.

__slots__ = ('__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__')[source]

__str__()[source]

Return str(self).

Return type:: str

_abc_impl = <_abc._abc_data object>[source]

_calculate_keys(*args, **kwargs)[source]

Return type:: Any

_check_frozen(name, value)[source]

Return type:: None

_copy_and_set_values(*args, **kwargs)[source]

Return type:: Any

classmethod _get_value(*args, **kwargs)[source]

Return type:: Any

_iter(*args, **kwargs)[source]

Return type:: Any

classmethod construct(_fields_set=None, **values)[source]

Return type:: Self

copy(*, include=None, exclude=None, update=None, deep=False)[source]

Returns a copy of the model.

!!! warning “Deprecated”: This method is now deprecated; use model_copy instead.

If you need include or exclude, use:

`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `

Parameters:

include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.

Returns:

A copy of the model with included, excluded and updated fields as specified.

data: SetBackgroundColor[source]

dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)[source]

Return type:: Dict[str, Any]

classmethod from_orm(obj)[source]

Return type:: Self

json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)[source]

Return type:: str

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}[source]: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'protected_namespaces': ()}[source]: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod model_construct(_fields_set=None, **values)[source]

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note: model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == 'allow', then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == 'ignore' (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == 'forbid' does not result in an error if extra values are passed, but they will be ignored.

Parameters:

_fields_set (set[str] | None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.
values (Any) – Trusted or pre-validated data dictionary.

Return type:

Self

Returns:

A new instance of the Model class with validated data.

model_copy(*, update=None, deep=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy

Returns a copy of the model.

Parameters:

update (dict[str, Any] | None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.
deep (bool) – Set to True to make a deep copy of the model.

Return type:

Self

Returns:

New model instance.

model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters:

mode (Union[Literal['json', 'python'], str]) – The mode in which to_python 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.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to include in the output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to exclude from the output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to use the field’s alias in the dictionary key if defined.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A dictionary representation of the model.

model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

Generates a JSON representation of the model using Pydantic’s to_json method.

Parameters:

indent (int | None) – Indentation to use in the JSON output. If None is passed, the output will be compact.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to include in the JSON output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to exclude from the JSON output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to serialize using field aliases.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A JSON string representation of the model.

property model_extra: dict[str, Any] | None[source]

Get extra fields set during validation.

Returns:: A dictionary of extra fields, or None if config.extra is not set to "allow".

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=SetBackgroundColor, required=True), 'type': FieldInfo(annotation=Literal['set_background_color'], required=False, default='set_background_color')}[source]

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

property model_fields_set: set[str][source]

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,: i.e. that were not filled from defaults.

classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')[source]

Generates a JSON schema for a model class.

Parameters:

by_alias (bool) – Whether to use attribute aliases or not.
ref_template (str) – The reference template.
schema_generator (type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modifications
mode (Literal['validation', 'serialization']) – The mode in which to generate the schema.

Return type:

Returns:

The JSON schema for the given model class.

classmethod model_parametrized_name(params)[source]

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

Parameters:: params (tuple[type[Any], ...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.
Return type:: str
Returns:: String representing the new class where params are passed to cls as type variables.
Raises:: TypeError – Raised when trying to generate concrete names for non-generic models.

model_post_init(_BaseModel__context)[source]

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

Return type:: None

classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)[source]

Try to rebuild the pydantic-core schema for the model.

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.

Parameters:

force (bool) – Whether to force the rebuilding of the model schema, defaults to False.
raise_errors (bool) – Whether to raise errors, defaults to True.
_parent_namespace_depth (int) – The depth level of the parent namespace, defaults to 2.
_types_namespace (dict[str, Any] | None) – The types namespace, defaults to None.

Return type:

Returns:

Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.

classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)[source]

Validate a pydantic model instance.

Parameters:

obj (Any) – The object to validate.
strict (bool | None) – Whether to enforce types strictly.
from_attributes (bool | None) – Whether to extract data from object attributes.
context (Any | None) – Additional context to pass to the validator.

Raises:

ValidationError – If the object could not be validated.

Return type:

Self

Returns:

The validated model instance.

classmethod model_validate_json(json_data, *, strict=None, context=None)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing

Validate the given JSON data against the Pydantic model.

Parameters:

json_data (str | bytes | bytearray) – The JSON data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

Raises:

ValidationError – If json_data is not a JSON string or the object could not be validated.

classmethod model_validate_strings(obj, *, strict=None, context=None)[source]

Validate the given object with string data against the Pydantic model.

Parameters:

obj (Any) – The object containing string data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod parse_obj(obj)[source]

Return type:: Self

classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod schema(by_alias=True, ref_template='#/$defs/{model}')[source]

Return type:: Dict[str, Any]

classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)[source]

Return type:: str

type: Literal['set_background_color'][source]

classmethod update_forward_refs(**localns)[source]

Return type:: None

classmethod validate(value)[source]

Return type:: Self

class kittycad.models.ok_modeling_cmd_response.OptionSetCurrentToolProperties(**data)[source][source]

The response to the ‘SetCurrentToolProperties’ endpoint

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__abstractmethods__ = frozenset({})[source]

__annotations__ = {'__class_vars__': 'ClassVar[set[str]]', '__private_attributes__': 'ClassVar[Dict[str, ModelPrivateAttr]]', '__pydantic_complete__': 'ClassVar[bool]', '__pydantic_core_schema__': 'ClassVar[CoreSchema]', '__pydantic_custom_init__': 'ClassVar[bool]', '__pydantic_decorators__': 'ClassVar[_decorators.DecoratorInfos]', '__pydantic_extra__': 'dict[str, Any] | None', '__pydantic_fields_set__': 'set[str]', '__pydantic_generic_metadata__': 'ClassVar[_generics.PydanticGenericMetadata]', '__pydantic_parent_namespace__': 'ClassVar[Dict[str, Any] | None]', '__pydantic_post_init__': "ClassVar[None | Literal['model_post_init']]", '__pydantic_private__': 'dict[str, Any] | None', '__pydantic_root_model__': 'ClassVar[bool]', '__pydantic_serializer__': 'ClassVar[SchemaSerializer]', '__pydantic_validator__': 'ClassVar[SchemaValidator | PluggableSchemaValidator]', '__signature__': 'ClassVar[Signature]', 'data': <class 'kittycad.models.set_current_tool_properties.SetCurrentToolProperties'>, 'model_computed_fields': 'ClassVar[Dict[str, ComputedFieldInfo]]', 'model_config': 'ClassVar[ConfigDict]', 'model_fields': 'ClassVar[Dict[str, FieldInfo]]', 'type': typing.Literal['set_current_tool_properties']}[source]

classmethod __class_getitem__(typevar_values)[source]

Return type:: type[BaseModel] | PydanticRecursiveRef

__class_vars__: ClassVar[set[str]] = {}[source]: The names of the class variables defined on the model.

__copy__()[source]

Returns a shallow copy of the model.

Return type:: Self

__deepcopy__(memo=None)[source]

Returns a deep copy of the model.

Return type:: Self

__delattr__(item)[source]

Implement delattr(self, name).

Return type:: Any

__dict__[source]

__eq__(other)[source]

Return self==value.

Return type:: bool

property __fields_set__: set[str][source]

classmethod __get_pydantic_core_schema__(source, handler, /)[source]

Hook into generating the model’s CoreSchema.

Parameters:

source (type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.
handler (GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.

Return type:

Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]

Returns:

A pydantic-core CoreSchema.

classmethod __get_pydantic_json_schema__(core_schema, handler, /)[source]

Hook into generating the model’s JSON schema.

Parameters:

core_schema (Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({'type': 'nullable', 'schema': current_schema}), or just call the handler with the original schema.
handler (GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.

Return type:

Returns:

A JSON schema, as a Python object.

__getattr__(item)[source]

Return type:: Any

__getstate__()[source]

Helper for pickle.

Return type:: dict[Any, Any]

__hash__ = None[source]

__init__(**data)[source]

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__iter__()[source]

So dict(model) works.

Return type:: Generator[Tuple[str, Any], None, None]

__module__ = 'kittycad.models.ok_modeling_cmd_response'[source]

__pretty__(fmt, **kwargs)[source]

Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.

Return type:: Generator[Any, None, None]

__private_attributes__: ClassVar[Dict[str, ModelPrivateAttr]] = {}[source]: Metadata about the private attributes of the model.

__pydantic_complete__: ClassVar[bool] = True[source]: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__: ClassVar[CoreSchema] = {'cls': <class 'kittycad.models.ok_modeling_cmd_response.OptionSetCurrentToolProperties'>, 'config': {'title': 'OptionSetCurrentToolProperties'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.ok_modeling_cmd_response.OptionSetCurrentToolProperties'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.ok_modeling_cmd_response.OptionSetCurrentToolProperties'>>]}, 'ref': 'kittycad.models.ok_modeling_cmd_response.OptionSetCurrentToolProperties:94667213055216', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'data': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.set_current_tool_properties.SetCurrentToolProperties'>, 'config': {'title': 'SetCurrentToolProperties'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.set_current_tool_properties.SetCurrentToolProperties'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.set_current_tool_properties.SetCurrentToolProperties'>>]}, 'ref': 'kittycad.models.set_current_tool_properties.SetCurrentToolProperties:94667212424096', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {}, 'model_name': 'SetCurrentToolProperties', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}, 'type': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': 'set_current_tool_properties', 'schema': {'expected': ['set_current_tool_properties'], 'type': 'literal'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'OptionSetCurrentToolProperties', 'type': 'model-fields'}, 'type': 'model'}[source]: The core schema of the model.

__pydantic_custom_init__: ClassVar[bool] = False[source]: Whether the model has a custom __init__ method.

__pydantic_decorators__: ClassVar[_decorators.DecoratorInfos] = DecoratorInfos(validators={}, field_validators={}, root_validators={}, field_serializers={}, model_serializers={}, model_validators={}, computed_fields={})[source]: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_extra__: dict[str, Any] | None[source]: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to 'allow'.

__pydantic_fields_set__: set[str][source]: The names of fields explicitly set during instantiation.

__pydantic_generic_metadata__: ClassVar[_generics.PydanticGenericMetadata] = {'args': (), 'origin': None, 'parameters': ()}[source]: 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.

classmethod __pydantic_init_subclass__(**kwargs)[source]

This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.

This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.

This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.

Parameters:: **kwargs (Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.
Return type:: None

__pydantic_parent_namespace__: ClassVar[Dict[str, Any] | None] = None[source]: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__: ClassVar[None | Literal['model_post_init']] = None[source]: The name of the post-init method for the model, if defined.

__pydantic_private__: dict[str, Any] | None[source]: Values of private attributes set on the model instance.

__pydantic_root_model__: ClassVar[bool] = False[source]: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__: ClassVar[SchemaSerializer] = SchemaSerializer(serializer=Model( ModelSerializer { class: Py( 0x000056196d9b24f0, ), serializer: Fields( GeneralFieldsSerializer { fields: { "data": SerField { key_py: Py( 0x00007f9038238fa0, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196d9183a0, ), serializer: Fields( GeneralFieldsSerializer { fields: {}, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 0, }, ), has_extra: false, root_model: false, name: "SetCurrentToolProperties", }, ), ), required: true, }, "type": SerField { key_py: Py( 0x00007f903823d958, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f9034697a00, ), ), serializer: Literal( LiteralSerializer { expected_int: {}, expected_str: { "set_current_tool_properties", }, expected_py: None, name: "literal['set_current_tool_properties']", }, ), }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "OptionSetCurrentToolProperties", }, ), definitions=[])[source]: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__: ClassVar[SchemaValidator | PluggableSchemaValidator] = SchemaValidator(title="OptionSetCurrentToolProperties", validator=Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "data", lookup_key: Simple { key: "data", py_key: Py( 0x00007f90334d7ae0, ), path: LookupPath( [ S( "data", Py( 0x00007f90334d7b10, ), ), ], ), }, name_py: Py( 0x00007f9038238fa0, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [], model_name: "SetCurrentToolProperties", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d9183a0, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "SetCurrentToolProperties", }, ), frozen: false, }, Field { name: "type", lookup_key: Simple { key: "type", py_key: Py( 0x00007f90334d7b40, ), path: LookupPath( [ S( "type", Py( 0x00007f90334d7b70, ), ), ], ), }, name_py: Py( 0x00007f903823d958, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f9034697a00, ), ), on_error: Raise, validator: Literal( LiteralValidator { lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "set_current_tool_properties": 0, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f9034697a00, ), ], }, expected_repr: "'set_current_tool_properties'", name: "literal['set_current_tool_properties']", }, ), validate_default: false, copy_default: false, name: "default[literal['set_current_tool_properties']]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "OptionSetCurrentToolProperties", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d9b24f0, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "OptionSetCurrentToolProperties", }, ), definitions=[], cache_strings=True)[source]: The pydantic-core SchemaValidator used to validate instances of the model.

__repr__()[source]

Return repr(self).

Return type:: str

__repr_args__()[source]

Return type:: Iterable[tuple[str | None, Any]]

__repr_name__()[source]

Name of the instance’s class, used in __repr__.

Return type:: str

__repr_str__(join_str)[source]

Return type:: str

__rich_repr__()[source]

Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.

Return type:: Iterable[Any | tuple[Any] | tuple[str, Any] | tuple[str, Any, Any]]

__setattr__(name, value)[source]

Implement setattr(self, name, value).

Return type:: None

__setstate__(state)[source]

Return type:: None

__signature__: ClassVar[Signature] = <Signature (*, data: kittycad.models.set_current_tool_properties.SetCurrentToolProperties, type: Literal['set_current_tool_properties'] = 'set_current_tool_properties') -> None>[source]: The synthesized __init__ [Signature][inspect.Signature] of the model.

__slots__ = ('__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__')[source]

__str__()[source]

Return str(self).

Return type:: str

_abc_impl = <_abc._abc_data object>[source]

_calculate_keys(*args, **kwargs)[source]

Return type:: Any

_check_frozen(name, value)[source]

Return type:: None

_copy_and_set_values(*args, **kwargs)[source]

Return type:: Any

classmethod _get_value(*args, **kwargs)[source]

Return type:: Any

_iter(*args, **kwargs)[source]

Return type:: Any

classmethod construct(_fields_set=None, **values)[source]

Return type:: Self

copy(*, include=None, exclude=None, update=None, deep=False)[source]

Returns a copy of the model.

!!! warning “Deprecated”: This method is now deprecated; use model_copy instead.

If you need include or exclude, use:

`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `

Parameters:

include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.

Returns:

A copy of the model with included, excluded and updated fields as specified.

data: SetCurrentToolProperties[source]

dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)[source]

Return type:: Dict[str, Any]

classmethod from_orm(obj)[source]

Return type:: Self

json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)[source]

Return type:: str

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}[source]: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'protected_namespaces': ()}[source]: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod model_construct(_fields_set=None, **values)[source]

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note: model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == 'allow', then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == 'ignore' (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == 'forbid' does not result in an error if extra values are passed, but they will be ignored.

Parameters:

_fields_set (set[str] | None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.
values (Any) – Trusted or pre-validated data dictionary.

Return type:

Self

Returns:

A new instance of the Model class with validated data.

model_copy(*, update=None, deep=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy

Returns a copy of the model.

Parameters:

update (dict[str, Any] | None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.
deep (bool) – Set to True to make a deep copy of the model.

Return type:

Self

Returns:

New model instance.

model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters:

mode (Union[Literal['json', 'python'], str]) – The mode in which to_python 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.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to include in the output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to exclude from the output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to use the field’s alias in the dictionary key if defined.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A dictionary representation of the model.

model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

Generates a JSON representation of the model using Pydantic’s to_json method.

Parameters:

indent (int | None) – Indentation to use in the JSON output. If None is passed, the output will be compact.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to include in the JSON output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to exclude from the JSON output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to serialize using field aliases.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A JSON string representation of the model.

property model_extra: dict[str, Any] | None[source]

Get extra fields set during validation.

Returns:: A dictionary of extra fields, or None if config.extra is not set to "allow".

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=SetCurrentToolProperties, required=True), 'type': FieldInfo(annotation=Literal['set_current_tool_properties'], required=False, default='set_current_tool_properties')}[source]

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

property model_fields_set: set[str][source]

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,: i.e. that were not filled from defaults.

classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')[source]

Generates a JSON schema for a model class.

Parameters:

by_alias (bool) – Whether to use attribute aliases or not.
ref_template (str) – The reference template.
schema_generator (type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modifications
mode (Literal['validation', 'serialization']) – The mode in which to generate the schema.

Return type:

Returns:

The JSON schema for the given model class.

classmethod model_parametrized_name(params)[source]

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

Parameters:: params (tuple[type[Any], ...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.
Return type:: str
Returns:: String representing the new class where params are passed to cls as type variables.
Raises:: TypeError – Raised when trying to generate concrete names for non-generic models.

model_post_init(_BaseModel__context)[source]

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

Return type:: None

classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)[source]

Try to rebuild the pydantic-core schema for the model.

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.

Parameters:

force (bool) – Whether to force the rebuilding of the model schema, defaults to False.
raise_errors (bool) – Whether to raise errors, defaults to True.
_parent_namespace_depth (int) – The depth level of the parent namespace, defaults to 2.
_types_namespace (dict[str, Any] | None) – The types namespace, defaults to None.

Return type:

Returns:

Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.

classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)[source]

Validate a pydantic model instance.

Parameters:

obj (Any) – The object to validate.
strict (bool | None) – Whether to enforce types strictly.
from_attributes (bool | None) – Whether to extract data from object attributes.
context (Any | None) – Additional context to pass to the validator.

Raises:

ValidationError – If the object could not be validated.

Return type:

Self

Returns:

The validated model instance.

classmethod model_validate_json(json_data, *, strict=None, context=None)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing

Validate the given JSON data against the Pydantic model.

Parameters:

json_data (str | bytes | bytearray) – The JSON data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

Raises:

ValidationError – If json_data is not a JSON string or the object could not be validated.

classmethod model_validate_strings(obj, *, strict=None, context=None)[source]

Validate the given object with string data against the Pydantic model.

Parameters:

obj (Any) – The object containing string data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod parse_obj(obj)[source]

Return type:: Self

classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod schema(by_alias=True, ref_template='#/$defs/{model}')[source]

Return type:: Dict[str, Any]

classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)[source]

Return type:: str

type: Literal['set_current_tool_properties'][source]

classmethod update_forward_refs(**localns)[source]

Return type:: None

classmethod validate(value)[source]

Return type:: Self

class kittycad.models.ok_modeling_cmd_response.OptionSetDefaultSystemProperties(**data)[source][source]

The response to the ‘SetDefaultSystemProperties’ endpoint

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__abstractmethods__ = frozenset({})[source]

__annotations__ = {'__class_vars__': 'ClassVar[set[str]]', '__private_attributes__': 'ClassVar[Dict[str, ModelPrivateAttr]]', '__pydantic_complete__': 'ClassVar[bool]', '__pydantic_core_schema__': 'ClassVar[CoreSchema]', '__pydantic_custom_init__': 'ClassVar[bool]', '__pydantic_decorators__': 'ClassVar[_decorators.DecoratorInfos]', '__pydantic_extra__': 'dict[str, Any] | None', '__pydantic_fields_set__': 'set[str]', '__pydantic_generic_metadata__': 'ClassVar[_generics.PydanticGenericMetadata]', '__pydantic_parent_namespace__': 'ClassVar[Dict[str, Any] | None]', '__pydantic_post_init__': "ClassVar[None | Literal['model_post_init']]", '__pydantic_private__': 'dict[str, Any] | None', '__pydantic_root_model__': 'ClassVar[bool]', '__pydantic_serializer__': 'ClassVar[SchemaSerializer]', '__pydantic_validator__': 'ClassVar[SchemaValidator | PluggableSchemaValidator]', '__signature__': 'ClassVar[Signature]', 'data': <class 'kittycad.models.set_default_system_properties.SetDefaultSystemProperties'>, 'model_computed_fields': 'ClassVar[Dict[str, ComputedFieldInfo]]', 'model_config': 'ClassVar[ConfigDict]', 'model_fields': 'ClassVar[Dict[str, FieldInfo]]', 'type': typing.Literal['set_default_system_properties']}[source]

classmethod __class_getitem__(typevar_values)[source]

Return type:: type[BaseModel] | PydanticRecursiveRef

__class_vars__: ClassVar[set[str]] = {}[source]: The names of the class variables defined on the model.

__copy__()[source]

Returns a shallow copy of the model.

Return type:: Self

__deepcopy__(memo=None)[source]

Returns a deep copy of the model.

Return type:: Self

__delattr__(item)[source]

Implement delattr(self, name).

Return type:: Any

__dict__[source]

__eq__(other)[source]

Return self==value.

Return type:: bool

property __fields_set__: set[str][source]

classmethod __get_pydantic_core_schema__(source, handler, /)[source]

Hook into generating the model’s CoreSchema.

Parameters:

source (type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.
handler (GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.

Return type:

Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]

Returns:

A pydantic-core CoreSchema.

classmethod __get_pydantic_json_schema__(core_schema, handler, /)[source]

Hook into generating the model’s JSON schema.

Parameters:

core_schema (Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({'type': 'nullable', 'schema': current_schema}), or just call the handler with the original schema.
handler (GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.

Return type:

Returns:

A JSON schema, as a Python object.

__getattr__(item)[source]

Return type:: Any

__getstate__()[source]

Helper for pickle.

Return type:: dict[Any, Any]

__hash__ = None[source]

__init__(**data)[source]

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__iter__()[source]

So dict(model) works.

Return type:: Generator[Tuple[str, Any], None, None]

__module__ = 'kittycad.models.ok_modeling_cmd_response'[source]

__pretty__(fmt, **kwargs)[source]

Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.

Return type:: Generator[Any, None, None]

__private_attributes__: ClassVar[Dict[str, ModelPrivateAttr]] = {}[source]: Metadata about the private attributes of the model.

__pydantic_complete__: ClassVar[bool] = True[source]: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__: ClassVar[CoreSchema] = {'cls': <class 'kittycad.models.ok_modeling_cmd_response.OptionSetDefaultSystemProperties'>, 'config': {'title': 'OptionSetDefaultSystemProperties'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.ok_modeling_cmd_response.OptionSetDefaultSystemProperties'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.ok_modeling_cmd_response.OptionSetDefaultSystemProperties'>>]}, 'ref': 'kittycad.models.ok_modeling_cmd_response.OptionSetDefaultSystemProperties:94667213064320', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'data': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.set_default_system_properties.SetDefaultSystemProperties'>, 'config': {'title': 'SetDefaultSystemProperties'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.set_default_system_properties.SetDefaultSystemProperties'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.set_default_system_properties.SetDefaultSystemProperties'>>]}, 'ref': 'kittycad.models.set_default_system_properties.SetDefaultSystemProperties:94667212449808', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {}, 'model_name': 'SetDefaultSystemProperties', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}, 'type': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': 'set_default_system_properties', 'schema': {'expected': ['set_default_system_properties'], 'type': 'literal'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'OptionSetDefaultSystemProperties', 'type': 'model-fields'}, 'type': 'model'}[source]: The core schema of the model.

__pydantic_custom_init__: ClassVar[bool] = False[source]: Whether the model has a custom __init__ method.

__pydantic_decorators__: ClassVar[_decorators.DecoratorInfos] = DecoratorInfos(validators={}, field_validators={}, root_validators={}, field_serializers={}, model_serializers={}, model_validators={}, computed_fields={})[source]: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_extra__: dict[str, Any] | None[source]: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to 'allow'.

__pydantic_fields_set__: set[str][source]: The names of fields explicitly set during instantiation.

__pydantic_generic_metadata__: ClassVar[_generics.PydanticGenericMetadata] = {'args': (), 'origin': None, 'parameters': ()}[source]: 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.

classmethod __pydantic_init_subclass__(**kwargs)[source]

This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.

This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.

This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.

Parameters:: **kwargs (Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.
Return type:: None

__pydantic_parent_namespace__: ClassVar[Dict[str, Any] | None] = None[source]: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__: ClassVar[None | Literal['model_post_init']] = None[source]: The name of the post-init method for the model, if defined.

__pydantic_private__: dict[str, Any] | None[source]: Values of private attributes set on the model instance.

__pydantic_root_model__: ClassVar[bool] = False[source]: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__: ClassVar[SchemaSerializer] = SchemaSerializer(serializer=Model( ModelSerializer { class: Py( 0x000056196d9b4880, ), serializer: Fields( GeneralFieldsSerializer { fields: { "data": SerField { key_py: Py( 0x00007f9038238fa0, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196d91e810, ), serializer: Fields( GeneralFieldsSerializer { fields: {}, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 0, }, ), has_extra: false, root_model: false, name: "SetDefaultSystemProperties", }, ), ), required: true, }, "type": SerField { key_py: Py( 0x00007f903823d958, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f9034697aa0, ), ), serializer: Literal( LiteralSerializer { expected_int: {}, expected_str: { "set_default_system_properties", }, expected_py: None, name: "literal['set_default_system_properties']", }, ), }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "OptionSetDefaultSystemProperties", }, ), definitions=[])[source]: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__: ClassVar[SchemaValidator | PluggableSchemaValidator] = SchemaValidator(title="OptionSetDefaultSystemProperties", validator=Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "data", lookup_key: Simple { key: "data", py_key: Py( 0x00007f9033520030, ), path: LookupPath( [ S( "data", Py( 0x00007f9033520060, ), ), ], ), }, name_py: Py( 0x00007f9038238fa0, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [], model_name: "SetDefaultSystemProperties", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d91e810, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "SetDefaultSystemProperties", }, ), frozen: false, }, Field { name: "type", lookup_key: Simple { key: "type", py_key: Py( 0x00007f9033520090, ), path: LookupPath( [ S( "type", Py( 0x00007f90335200c0, ), ), ], ), }, name_py: Py( 0x00007f903823d958, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f9034697aa0, ), ), on_error: Raise, validator: Literal( LiteralValidator { lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "set_default_system_properties": 0, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f9034697aa0, ), ], }, expected_repr: "'set_default_system_properties'", name: "literal['set_default_system_properties']", }, ), validate_default: false, copy_default: false, name: "default[literal['set_default_system_properties']]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "OptionSetDefaultSystemProperties", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d9b4880, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "OptionSetDefaultSystemProperties", }, ), definitions=[], cache_strings=True)[source]: The pydantic-core SchemaValidator used to validate instances of the model.

__repr__()[source]

Return repr(self).

Return type:: str

__repr_args__()[source]

Return type:: Iterable[tuple[str | None, Any]]

__repr_name__()[source]

Name of the instance’s class, used in __repr__.

Return type:: str

__repr_str__(join_str)[source]

Return type:: str

__rich_repr__()[source]

Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.

Return type:: Iterable[Any | tuple[Any] | tuple[str, Any] | tuple[str, Any, Any]]

__setattr__(name, value)[source]

Implement setattr(self, name, value).

Return type:: None

__setstate__(state)[source]

Return type:: None

__signature__: ClassVar[Signature] = <Signature (*, data: kittycad.models.set_default_system_properties.SetDefaultSystemProperties, type: Literal['set_default_system_properties'] = 'set_default_system_properties') -> None>[source]: The synthesized __init__ [Signature][inspect.Signature] of the model.

__slots__ = ('__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__')[source]

__str__()[source]

Return str(self).

Return type:: str

_abc_impl = <_abc._abc_data object>[source]

_calculate_keys(*args, **kwargs)[source]

Return type:: Any

_check_frozen(name, value)[source]

Return type:: None

_copy_and_set_values(*args, **kwargs)[source]

Return type:: Any

classmethod _get_value(*args, **kwargs)[source]

Return type:: Any

_iter(*args, **kwargs)[source]

Return type:: Any

classmethod construct(_fields_set=None, **values)[source]

Return type:: Self

copy(*, include=None, exclude=None, update=None, deep=False)[source]

Returns a copy of the model.

!!! warning “Deprecated”: This method is now deprecated; use model_copy instead.

If you need include or exclude, use:

`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `

Parameters:

include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.

Returns:

A copy of the model with included, excluded and updated fields as specified.

data: SetDefaultSystemProperties[source]

dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)[source]

Return type:: Dict[str, Any]

classmethod from_orm(obj)[source]

Return type:: Self

json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)[source]

Return type:: str

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}[source]: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'protected_namespaces': ()}[source]: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod model_construct(_fields_set=None, **values)[source]

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note: model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == 'allow', then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == 'ignore' (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == 'forbid' does not result in an error if extra values are passed, but they will be ignored.

Parameters:

_fields_set (set[str] | None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.
values (Any) – Trusted or pre-validated data dictionary.

Return type:

Self

Returns:

A new instance of the Model class with validated data.

model_copy(*, update=None, deep=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy

Returns a copy of the model.

Parameters:

update (dict[str, Any] | None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.
deep (bool) – Set to True to make a deep copy of the model.

Return type:

Self

Returns:

New model instance.

model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters:

mode (Union[Literal['json', 'python'], str]) – The mode in which to_python 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.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to include in the output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to exclude from the output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to use the field’s alias in the dictionary key if defined.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A dictionary representation of the model.

model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

Generates a JSON representation of the model using Pydantic’s to_json method.

Parameters:

indent (int | None) – Indentation to use in the JSON output. If None is passed, the output will be compact.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to include in the JSON output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to exclude from the JSON output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to serialize using field aliases.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A JSON string representation of the model.

property model_extra: dict[str, Any] | None[source]

Get extra fields set during validation.

Returns:: A dictionary of extra fields, or None if config.extra is not set to "allow".

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=SetDefaultSystemProperties, required=True), 'type': FieldInfo(annotation=Literal['set_default_system_properties'], required=False, default='set_default_system_properties')}[source]

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

property model_fields_set: set[str][source]

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,: i.e. that were not filled from defaults.

classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')[source]

Generates a JSON schema for a model class.

Parameters:

by_alias (bool) – Whether to use attribute aliases or not.
ref_template (str) – The reference template.
schema_generator (type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modifications
mode (Literal['validation', 'serialization']) – The mode in which to generate the schema.

Return type:

Returns:

The JSON schema for the given model class.

classmethod model_parametrized_name(params)[source]

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

Parameters:: params (tuple[type[Any], ...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.
Return type:: str
Returns:: String representing the new class where params are passed to cls as type variables.
Raises:: TypeError – Raised when trying to generate concrete names for non-generic models.

model_post_init(_BaseModel__context)[source]

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

Return type:: None

classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)[source]

Try to rebuild the pydantic-core schema for the model.

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.

Parameters:

force (bool) – Whether to force the rebuilding of the model schema, defaults to False.
raise_errors (bool) – Whether to raise errors, defaults to True.
_parent_namespace_depth (int) – The depth level of the parent namespace, defaults to 2.
_types_namespace (dict[str, Any] | None) – The types namespace, defaults to None.

Return type:

Returns:

Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.

classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)[source]

Validate a pydantic model instance.

Parameters:

obj (Any) – The object to validate.
strict (bool | None) – Whether to enforce types strictly.
from_attributes (bool | None) – Whether to extract data from object attributes.
context (Any | None) – Additional context to pass to the validator.

Raises:

ValidationError – If the object could not be validated.

Return type:

Self

Returns:

The validated model instance.

classmethod model_validate_json(json_data, *, strict=None, context=None)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing

Validate the given JSON data against the Pydantic model.

Parameters:

json_data (str | bytes | bytearray) – The JSON data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

Raises:

ValidationError – If json_data is not a JSON string or the object could not be validated.

classmethod model_validate_strings(obj, *, strict=None, context=None)[source]

Validate the given object with string data against the Pydantic model.

Parameters:

obj (Any) – The object containing string data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod parse_obj(obj)[source]

Return type:: Self

classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod schema(by_alias=True, ref_template='#/$defs/{model}')[source]

Return type:: Dict[str, Any]

classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)[source]

Return type:: str

type: Literal['set_default_system_properties'][source]

classmethod update_forward_refs(**localns)[source]

Return type:: None

classmethod validate(value)[source]

Return type:: Self

class kittycad.models.ok_modeling_cmd_response.OptionSetSceneUnits(**data)[source][source]

The response to the ‘SetSceneUnits’ endpoint

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__abstractmethods__ = frozenset({})[source]

__annotations__ = {'__class_vars__': 'ClassVar[set[str]]', '__private_attributes__': 'ClassVar[Dict[str, ModelPrivateAttr]]', '__pydantic_complete__': 'ClassVar[bool]', '__pydantic_core_schema__': 'ClassVar[CoreSchema]', '__pydantic_custom_init__': 'ClassVar[bool]', '__pydantic_decorators__': 'ClassVar[_decorators.DecoratorInfos]', '__pydantic_extra__': 'dict[str, Any] | None', '__pydantic_fields_set__': 'set[str]', '__pydantic_generic_metadata__': 'ClassVar[_generics.PydanticGenericMetadata]', '__pydantic_parent_namespace__': 'ClassVar[Dict[str, Any] | None]', '__pydantic_post_init__': "ClassVar[None | Literal['model_post_init']]", '__pydantic_private__': 'dict[str, Any] | None', '__pydantic_root_model__': 'ClassVar[bool]', '__pydantic_serializer__': 'ClassVar[SchemaSerializer]', '__pydantic_validator__': 'ClassVar[SchemaValidator | PluggableSchemaValidator]', '__signature__': 'ClassVar[Signature]', 'data': <class 'kittycad.models.set_scene_units.SetSceneUnits'>, 'model_computed_fields': 'ClassVar[Dict[str, ComputedFieldInfo]]', 'model_config': 'ClassVar[ConfigDict]', 'model_fields': 'ClassVar[Dict[str, FieldInfo]]', 'type': typing.Literal['set_scene_units']}[source]

classmethod __class_getitem__(typevar_values)[source]

Return type:: type[BaseModel] | PydanticRecursiveRef

__class_vars__: ClassVar[set[str]] = {}[source]: The names of the class variables defined on the model.

__copy__()[source]

Returns a shallow copy of the model.

Return type:: Self

__deepcopy__(memo=None)[source]

Returns a deep copy of the model.

Return type:: Self

__delattr__(item)[source]

Implement delattr(self, name).

Return type:: Any

__dict__[source]

__eq__(other)[source]

Return self==value.

Return type:: bool

property __fields_set__: set[str][source]

classmethod __get_pydantic_core_schema__(source, handler, /)[source]

Hook into generating the model’s CoreSchema.

Parameters:

source (type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.
handler (GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.

Return type:

Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]

Returns:

A pydantic-core CoreSchema.

classmethod __get_pydantic_json_schema__(core_schema, handler, /)[source]

Hook into generating the model’s JSON schema.

Parameters:

core_schema (Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({'type': 'nullable', 'schema': current_schema}), or just call the handler with the original schema.
handler (GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.

Return type:

Returns:

A JSON schema, as a Python object.

__getattr__(item)[source]

Return type:: Any

__getstate__()[source]

Helper for pickle.

Return type:: dict[Any, Any]

__hash__ = None[source]

__init__(**data)[source]

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__iter__()[source]

So dict(model) works.

Return type:: Generator[Tuple[str, Any], None, None]

__module__ = 'kittycad.models.ok_modeling_cmd_response'[source]

__pretty__(fmt, **kwargs)[source]

Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.

Return type:: Generator[Any, None, None]

__private_attributes__: ClassVar[Dict[str, ModelPrivateAttr]] = {}[source]: Metadata about the private attributes of the model.

__pydantic_complete__: ClassVar[bool] = True[source]: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__: ClassVar[CoreSchema] = {'cls': <class 'kittycad.models.ok_modeling_cmd_response.OptionSetSceneUnits'>, 'config': {'title': 'OptionSetSceneUnits'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.ok_modeling_cmd_response.OptionSetSceneUnits'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.ok_modeling_cmd_response.OptionSetSceneUnits'>>]}, 'ref': 'kittycad.models.ok_modeling_cmd_response.OptionSetSceneUnits:94667213133504', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'data': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.set_scene_units.SetSceneUnits'>, 'config': {'title': 'SetSceneUnits'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.set_scene_units.SetSceneUnits'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.set_scene_units.SetSceneUnits'>>]}, 'ref': 'kittycad.models.set_scene_units.SetSceneUnits:94667212453408', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {}, 'model_name': 'SetSceneUnits', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}, 'type': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': 'set_scene_units', 'schema': {'expected': ['set_scene_units'], 'type': 'literal'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'OptionSetSceneUnits', 'type': 'model-fields'}, 'type': 'model'}[source]: The core schema of the model.

__pydantic_custom_init__: ClassVar[bool] = False[source]: Whether the model has a custom __init__ method.

__pydantic_decorators__: ClassVar[_decorators.DecoratorInfos] = DecoratorInfos(validators={}, field_validators={}, root_validators={}, field_serializers={}, model_serializers={}, model_validators={}, computed_fields={})[source]: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_extra__: dict[str, Any] | None[source]: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to 'allow'.

__pydantic_fields_set__: set[str][source]: The names of fields explicitly set during instantiation.

__pydantic_generic_metadata__: ClassVar[_generics.PydanticGenericMetadata] = {'args': (), 'origin': None, 'parameters': ()}[source]: 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.

classmethod __pydantic_init_subclass__(**kwargs)[source]

This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.

This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.

This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.

Parameters:: **kwargs (Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.
Return type:: None

__pydantic_parent_namespace__: ClassVar[Dict[str, Any] | None] = None[source]: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__: ClassVar[None | Literal['model_post_init']] = None[source]: The name of the post-init method for the model, if defined.

__pydantic_private__: dict[str, Any] | None[source]: Values of private attributes set on the model instance.

__pydantic_root_model__: ClassVar[bool] = False[source]: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__: ClassVar[SchemaSerializer] = SchemaSerializer(serializer=Model( ModelSerializer { class: Py( 0x000056196d9c56c0, ), serializer: Fields( GeneralFieldsSerializer { fields: { "type": SerField { key_py: Py( 0x00007f903823d958, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f90346e64f0, ), ), serializer: Literal( LiteralSerializer { expected_int: {}, expected_str: { "set_scene_units", }, expected_py: None, name: "literal['set_scene_units']", }, ), }, ), ), required: true, }, "data": SerField { key_py: Py( 0x00007f9038238fa0, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196d91f620, ), serializer: Fields( GeneralFieldsSerializer { fields: {}, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 0, }, ), has_extra: false, root_model: false, name: "SetSceneUnits", }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "OptionSetSceneUnits", }, ), definitions=[])[source]: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__: ClassVar[SchemaValidator | PluggableSchemaValidator] = SchemaValidator(title="OptionSetSceneUnits", validator=Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "data", lookup_key: Simple { key: "data", py_key: Py( 0x00007f90335210e0, ), path: LookupPath( [ S( "data", Py( 0x00007f9033521110, ), ), ], ), }, name_py: Py( 0x00007f9038238fa0, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [], model_name: "SetSceneUnits", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d91f620, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "SetSceneUnits", }, ), frozen: false, }, Field { name: "type", lookup_key: Simple { key: "type", py_key: Py( 0x00007f9033521140, ), path: LookupPath( [ S( "type", Py( 0x00007f9033521170, ), ), ], ), }, name_py: Py( 0x00007f903823d958, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f90346e64f0, ), ), on_error: Raise, validator: Literal( LiteralValidator { lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "set_scene_units": 0, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f90346e64f0, ), ], }, expected_repr: "'set_scene_units'", name: "literal['set_scene_units']", }, ), validate_default: false, copy_default: false, name: "default[literal['set_scene_units']]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "OptionSetSceneUnits", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d9c56c0, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "OptionSetSceneUnits", }, ), definitions=[], cache_strings=True)[source]: The pydantic-core SchemaValidator used to validate instances of the model.

__repr__()[source]

Return repr(self).

Return type:: str

__repr_args__()[source]

Return type:: Iterable[tuple[str | None, Any]]

__repr_name__()[source]

Name of the instance’s class, used in __repr__.

Return type:: str

__repr_str__(join_str)[source]

Return type:: str

__rich_repr__()[source]

Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.

Return type:: Iterable[Any | tuple[Any] | tuple[str, Any] | tuple[str, Any, Any]]

__setattr__(name, value)[source]

Implement setattr(self, name, value).

Return type:: None

__setstate__(state)[source]

Return type:: None

__signature__: ClassVar[Signature] = <Signature (*, data: kittycad.models.set_scene_units.SetSceneUnits, type: Literal['set_scene_units'] = 'set_scene_units') -> None>[source]: The synthesized __init__ [Signature][inspect.Signature] of the model.

__slots__ = ('__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__')[source]

__str__()[source]

Return str(self).

Return type:: str

_abc_impl = <_abc._abc_data object>[source]

_calculate_keys(*args, **kwargs)[source]

Return type:: Any

_check_frozen(name, value)[source]

Return type:: None

_copy_and_set_values(*args, **kwargs)[source]

Return type:: Any

classmethod _get_value(*args, **kwargs)[source]

Return type:: Any

_iter(*args, **kwargs)[source]

Return type:: Any

classmethod construct(_fields_set=None, **values)[source]

Return type:: Self

copy(*, include=None, exclude=None, update=None, deep=False)[source]

Returns a copy of the model.

!!! warning “Deprecated”: This method is now deprecated; use model_copy instead.

If you need include or exclude, use:

`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `

Parameters:

include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.

Returns:

A copy of the model with included, excluded and updated fields as specified.

data: SetSceneUnits[source]

dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)[source]

Return type:: Dict[str, Any]

classmethod from_orm(obj)[source]

Return type:: Self

json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)[source]

Return type:: str

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}[source]: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'protected_namespaces': ()}[source]: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod model_construct(_fields_set=None, **values)[source]

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note: model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == 'allow', then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == 'ignore' (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == 'forbid' does not result in an error if extra values are passed, but they will be ignored.

Parameters:

_fields_set (set[str] | None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.
values (Any) – Trusted or pre-validated data dictionary.

Return type:

Self

Returns:

A new instance of the Model class with validated data.

model_copy(*, update=None, deep=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy

Returns a copy of the model.

Parameters:

update (dict[str, Any] | None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.
deep (bool) – Set to True to make a deep copy of the model.

Return type:

Self

Returns:

New model instance.

model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters:

mode (Union[Literal['json', 'python'], str]) – The mode in which to_python 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.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to include in the output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to exclude from the output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to use the field’s alias in the dictionary key if defined.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A dictionary representation of the model.

model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

Generates a JSON representation of the model using Pydantic’s to_json method.

Parameters:

indent (int | None) – Indentation to use in the JSON output. If None is passed, the output will be compact.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to include in the JSON output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to exclude from the JSON output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to serialize using field aliases.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A JSON string representation of the model.

property model_extra: dict[str, Any] | None[source]

Get extra fields set during validation.

Returns:: A dictionary of extra fields, or None if config.extra is not set to "allow".

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=SetSceneUnits, required=True), 'type': FieldInfo(annotation=Literal['set_scene_units'], required=False, default='set_scene_units')}[source]

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

property model_fields_set: set[str][source]

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,: i.e. that were not filled from defaults.

classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')[source]

Generates a JSON schema for a model class.

Parameters:

by_alias (bool) – Whether to use attribute aliases or not.
ref_template (str) – The reference template.
schema_generator (type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modifications
mode (Literal['validation', 'serialization']) – The mode in which to generate the schema.

Return type:

Returns:

The JSON schema for the given model class.

classmethod model_parametrized_name(params)[source]

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

Parameters:: params (tuple[type[Any], ...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.
Return type:: str
Returns:: String representing the new class where params are passed to cls as type variables.
Raises:: TypeError – Raised when trying to generate concrete names for non-generic models.

model_post_init(_BaseModel__context)[source]

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

Return type:: None

classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)[source]

Try to rebuild the pydantic-core schema for the model.

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.

Parameters:

force (bool) – Whether to force the rebuilding of the model schema, defaults to False.
raise_errors (bool) – Whether to raise errors, defaults to True.
_parent_namespace_depth (int) – The depth level of the parent namespace, defaults to 2.
_types_namespace (dict[str, Any] | None) – The types namespace, defaults to None.

Return type:

Returns:

Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.

classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)[source]

Validate a pydantic model instance.

Parameters:

obj (Any) – The object to validate.
strict (bool | None) – Whether to enforce types strictly.
from_attributes (bool | None) – Whether to extract data from object attributes.
context (Any | None) – Additional context to pass to the validator.

Raises:

ValidationError – If the object could not be validated.

Return type:

Self

Returns:

The validated model instance.

classmethod model_validate_json(json_data, *, strict=None, context=None)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing

Validate the given JSON data against the Pydantic model.

Parameters:

json_data (str | bytes | bytearray) – The JSON data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

Raises:

ValidationError – If json_data is not a JSON string or the object could not be validated.

classmethod model_validate_strings(obj, *, strict=None, context=None)[source]

Validate the given object with string data against the Pydantic model.

Parameters:

obj (Any) – The object containing string data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod parse_obj(obj)[source]

Return type:: Self

classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod schema(by_alias=True, ref_template='#/$defs/{model}')[source]

Return type:: Dict[str, Any]

classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)[source]

Return type:: str

type: Literal['set_scene_units'][source]

classmethod update_forward_refs(**localns)[source]

Return type:: None

classmethod validate(value)[source]

Return type:: Self

class kittycad.models.ok_modeling_cmd_response.OptionSetSelectionFilter(**data)[source][source]

The response to the ‘SetSelectionFilter’ endpoint

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__abstractmethods__ = frozenset({})[source]

__annotations__ = {'__class_vars__': 'ClassVar[set[str]]', '__private_attributes__': 'ClassVar[Dict[str, ModelPrivateAttr]]', '__pydantic_complete__': 'ClassVar[bool]', '__pydantic_core_schema__': 'ClassVar[CoreSchema]', '__pydantic_custom_init__': 'ClassVar[bool]', '__pydantic_decorators__': 'ClassVar[_decorators.DecoratorInfos]', '__pydantic_extra__': 'dict[str, Any] | None', '__pydantic_fields_set__': 'set[str]', '__pydantic_generic_metadata__': 'ClassVar[_generics.PydanticGenericMetadata]', '__pydantic_parent_namespace__': 'ClassVar[Dict[str, Any] | None]', '__pydantic_post_init__': "ClassVar[None | Literal['model_post_init']]", '__pydantic_private__': 'dict[str, Any] | None', '__pydantic_root_model__': 'ClassVar[bool]', '__pydantic_serializer__': 'ClassVar[SchemaSerializer]', '__pydantic_validator__': 'ClassVar[SchemaValidator | PluggableSchemaValidator]', '__signature__': 'ClassVar[Signature]', 'data': <class 'kittycad.models.set_selection_filter.SetSelectionFilter'>, 'model_computed_fields': 'ClassVar[Dict[str, ComputedFieldInfo]]', 'model_config': 'ClassVar[ConfigDict]', 'model_fields': 'ClassVar[Dict[str, FieldInfo]]', 'type': typing.Literal['set_selection_filter']}[source]

classmethod __class_getitem__(typevar_values)[source]

Return type:: type[BaseModel] | PydanticRecursiveRef

__class_vars__: ClassVar[set[str]] = {}[source]: The names of the class variables defined on the model.

__copy__()[source]

Returns a shallow copy of the model.

Return type:: Self

__deepcopy__(memo=None)[source]

Returns a deep copy of the model.

Return type:: Self

__delattr__(item)[source]

Implement delattr(self, name).

Return type:: Any

__dict__[source]

__eq__(other)[source]

Return self==value.

Return type:: bool

property __fields_set__: set[str][source]

classmethod __get_pydantic_core_schema__(source, handler, /)[source]

Hook into generating the model’s CoreSchema.

Parameters:

source (type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.
handler (GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.

Return type:

Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]

Returns:

A pydantic-core CoreSchema.

classmethod __get_pydantic_json_schema__(core_schema, handler, /)[source]

Hook into generating the model’s JSON schema.

Parameters:

core_schema (Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({'type': 'nullable', 'schema': current_schema}), or just call the handler with the original schema.
handler (GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.

Return type:

Returns:

A JSON schema, as a Python object.

__getattr__(item)[source]

Return type:: Any

__getstate__()[source]

Helper for pickle.

Return type:: dict[Any, Any]

__hash__ = None[source]

__init__(**data)[source]

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__iter__()[source]

So dict(model) works.

Return type:: Generator[Tuple[str, Any], None, None]

__module__ = 'kittycad.models.ok_modeling_cmd_response'[source]

__pretty__(fmt, **kwargs)[source]

Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.

Return type:: Generator[Any, None, None]

__private_attributes__: ClassVar[Dict[str, ModelPrivateAttr]] = {}[source]: Metadata about the private attributes of the model.

__pydantic_complete__: ClassVar[bool] = True[source]: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__: ClassVar[CoreSchema] = {'cls': <class 'kittycad.models.ok_modeling_cmd_response.OptionSetSelectionFilter'>, 'config': {'title': 'OptionSetSelectionFilter'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.ok_modeling_cmd_response.OptionSetSelectionFilter'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.ok_modeling_cmd_response.OptionSetSelectionFilter'>>]}, 'ref': 'kittycad.models.ok_modeling_cmd_response.OptionSetSelectionFilter:94667213155360', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'data': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.set_selection_filter.SetSelectionFilter'>, 'config': {'title': 'SetSelectionFilter'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.set_selection_filter.SetSelectionFilter'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.set_selection_filter.SetSelectionFilter'>>]}, 'ref': 'kittycad.models.set_selection_filter.SetSelectionFilter:94667212467888', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {}, 'model_name': 'SetSelectionFilter', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}, 'type': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': 'set_selection_filter', 'schema': {'expected': ['set_selection_filter'], 'type': 'literal'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'OptionSetSelectionFilter', 'type': 'model-fields'}, 'type': 'model'}[source]: The core schema of the model.

__pydantic_custom_init__: ClassVar[bool] = False[source]: Whether the model has a custom __init__ method.

__pydantic_decorators__: ClassVar[_decorators.DecoratorInfos] = DecoratorInfos(validators={}, field_validators={}, root_validators={}, field_serializers={}, model_serializers={}, model_validators={}, computed_fields={})[source]: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_extra__: dict[str, Any] | None[source]: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to 'allow'.

__pydantic_fields_set__: set[str][source]: The names of fields explicitly set during instantiation.

__pydantic_generic_metadata__: ClassVar[_generics.PydanticGenericMetadata] = {'args': (), 'origin': None, 'parameters': ()}[source]: 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.

classmethod __pydantic_init_subclass__(**kwargs)[source]

This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.

This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.

This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.

Parameters:: **kwargs (Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.
Return type:: None

__pydantic_parent_namespace__: ClassVar[Dict[str, Any] | None] = None[source]: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__: ClassVar[None | Literal['model_post_init']] = None[source]: The name of the post-init method for the model, if defined.

__pydantic_private__: dict[str, Any] | None[source]: Values of private attributes set on the model instance.

__pydantic_root_model__: ClassVar[bool] = False[source]: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__: ClassVar[SchemaSerializer] = SchemaSerializer(serializer=Model( ModelSerializer { class: Py( 0x000056196d9cac20, ), serializer: Fields( GeneralFieldsSerializer { fields: { "type": SerField { key_py: Py( 0x00007f903823d958, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f90346e65b0, ), ), serializer: Literal( LiteralSerializer { expected_int: {}, expected_str: { "set_selection_filter", }, expected_py: None, name: "literal['set_selection_filter']", }, ), }, ), ), required: true, }, "data": SerField { key_py: Py( 0x00007f9038238fa0, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196d922eb0, ), serializer: Fields( GeneralFieldsSerializer { fields: {}, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 0, }, ), has_extra: false, root_model: false, name: "SetSelectionFilter", }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "OptionSetSelectionFilter", }, ), definitions=[])[source]: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__: ClassVar[SchemaValidator | PluggableSchemaValidator] = SchemaValidator(title="OptionSetSelectionFilter", validator=Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "data", lookup_key: Simple { key: "data", py_key: Py( 0x00007f9033521290, ), path: LookupPath( [ S( "data", Py( 0x00007f9033521260, ), ), ], ), }, name_py: Py( 0x00007f9038238fa0, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [], model_name: "SetSelectionFilter", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d922eb0, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "SetSelectionFilter", }, ), frozen: false, }, Field { name: "type", lookup_key: Simple { key: "type", py_key: Py( 0x00007f9033521320, ), path: LookupPath( [ S( "type", Py( 0x00007f9033521350, ), ), ], ), }, name_py: Py( 0x00007f903823d958, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f90346e65b0, ), ), on_error: Raise, validator: Literal( LiteralValidator { lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "set_selection_filter": 0, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f90346e65b0, ), ], }, expected_repr: "'set_selection_filter'", name: "literal['set_selection_filter']", }, ), validate_default: false, copy_default: false, name: "default[literal['set_selection_filter']]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "OptionSetSelectionFilter", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d9cac20, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "OptionSetSelectionFilter", }, ), definitions=[], cache_strings=True)[source]: The pydantic-core SchemaValidator used to validate instances of the model.

__repr__()[source]

Return repr(self).

Return type:: str

__repr_args__()[source]

Return type:: Iterable[tuple[str | None, Any]]

__repr_name__()[source]

Name of the instance’s class, used in __repr__.

Return type:: str

__repr_str__(join_str)[source]

Return type:: str

__rich_repr__()[source]

Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.

Return type:: Iterable[Any | tuple[Any] | tuple[str, Any] | tuple[str, Any, Any]]

__setattr__(name, value)[source]

Implement setattr(self, name, value).

Return type:: None

__setstate__(state)[source]

Return type:: None

__signature__: ClassVar[Signature] = <Signature (*, data: kittycad.models.set_selection_filter.SetSelectionFilter, type: Literal['set_selection_filter'] = 'set_selection_filter') -> None>[source]: The synthesized __init__ [Signature][inspect.Signature] of the model.

__slots__ = ('__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__')[source]

__str__()[source]

Return str(self).

Return type:: str

_abc_impl = <_abc._abc_data object>[source]

_calculate_keys(*args, **kwargs)[source]

Return type:: Any

_check_frozen(name, value)[source]

Return type:: None

_copy_and_set_values(*args, **kwargs)[source]

Return type:: Any

classmethod _get_value(*args, **kwargs)[source]

Return type:: Any

_iter(*args, **kwargs)[source]

Return type:: Any

classmethod construct(_fields_set=None, **values)[source]

Return type:: Self

copy(*, include=None, exclude=None, update=None, deep=False)[source]

Returns a copy of the model.

!!! warning “Deprecated”: This method is now deprecated; use model_copy instead.

If you need include or exclude, use:

`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `

Parameters:

include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.

Returns:

A copy of the model with included, excluded and updated fields as specified.

data: SetSelectionFilter[source]

dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)[source]

Return type:: Dict[str, Any]

classmethod from_orm(obj)[source]

Return type:: Self

json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)[source]

Return type:: str

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}[source]: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'protected_namespaces': ()}[source]: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod model_construct(_fields_set=None, **values)[source]

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note: model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == 'allow', then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == 'ignore' (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == 'forbid' does not result in an error if extra values are passed, but they will be ignored.

Parameters:

_fields_set (set[str] | None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.
values (Any) – Trusted or pre-validated data dictionary.

Return type:

Self

Returns:

A new instance of the Model class with validated data.

model_copy(*, update=None, deep=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy

Returns a copy of the model.

Parameters:

update (dict[str, Any] | None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.
deep (bool) – Set to True to make a deep copy of the model.

Return type:

Self

Returns:

New model instance.

model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters:

mode (Union[Literal['json', 'python'], str]) – The mode in which to_python 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.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to include in the output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to exclude from the output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to use the field’s alias in the dictionary key if defined.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A dictionary representation of the model.

model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

Generates a JSON representation of the model using Pydantic’s to_json method.

Parameters:

indent (int | None) – Indentation to use in the JSON output. If None is passed, the output will be compact.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to include in the JSON output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to exclude from the JSON output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to serialize using field aliases.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A JSON string representation of the model.

property model_extra: dict[str, Any] | None[source]

Get extra fields set during validation.

Returns:: A dictionary of extra fields, or None if config.extra is not set to "allow".

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=SetSelectionFilter, required=True), 'type': FieldInfo(annotation=Literal['set_selection_filter'], required=False, default='set_selection_filter')}[source]

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

property model_fields_set: set[str][source]

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,: i.e. that were not filled from defaults.

classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')[source]

Generates a JSON schema for a model class.

Parameters:

by_alias (bool) – Whether to use attribute aliases or not.
ref_template (str) – The reference template.
schema_generator (type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modifications
mode (Literal['validation', 'serialization']) – The mode in which to generate the schema.

Return type:

Returns:

The JSON schema for the given model class.

classmethod model_parametrized_name(params)[source]

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

Parameters:: params (tuple[type[Any], ...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.
Return type:: str
Returns:: String representing the new class where params are passed to cls as type variables.
Raises:: TypeError – Raised when trying to generate concrete names for non-generic models.

model_post_init(_BaseModel__context)[source]

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

Return type:: None

classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)[source]

Try to rebuild the pydantic-core schema for the model.

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.

Parameters:

force (bool) – Whether to force the rebuilding of the model schema, defaults to False.
raise_errors (bool) – Whether to raise errors, defaults to True.
_parent_namespace_depth (int) – The depth level of the parent namespace, defaults to 2.
_types_namespace (dict[str, Any] | None) – The types namespace, defaults to None.

Return type:

Returns:

Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.

classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)[source]

Validate a pydantic model instance.

Parameters:

obj (Any) – The object to validate.
strict (bool | None) – Whether to enforce types strictly.
from_attributes (bool | None) – Whether to extract data from object attributes.
context (Any | None) – Additional context to pass to the validator.

Raises:

ValidationError – If the object could not be validated.

Return type:

Self

Returns:

The validated model instance.

classmethod model_validate_json(json_data, *, strict=None, context=None)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing

Validate the given JSON data against the Pydantic model.

Parameters:

json_data (str | bytes | bytearray) – The JSON data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

Raises:

ValidationError – If json_data is not a JSON string or the object could not be validated.

classmethod model_validate_strings(obj, *, strict=None, context=None)[source]

Validate the given object with string data against the Pydantic model.

Parameters:

obj (Any) – The object containing string data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod parse_obj(obj)[source]

Return type:: Self

classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod schema(by_alias=True, ref_template='#/$defs/{model}')[source]

Return type:: Dict[str, Any]

classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)[source]

Return type:: str

type: Literal['set_selection_filter'][source]

classmethod update_forward_refs(**localns)[source]

Return type:: None

classmethod validate(value)[source]

Return type:: Self

class kittycad.models.ok_modeling_cmd_response.OptionSetSelectionType(**data)[source][source]

The response to the ‘SetSelectionType’ endpoint

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__abstractmethods__ = frozenset({})[source]

__annotations__ = {'__class_vars__': 'ClassVar[set[str]]', '__private_attributes__': 'ClassVar[Dict[str, ModelPrivateAttr]]', '__pydantic_complete__': 'ClassVar[bool]', '__pydantic_core_schema__': 'ClassVar[CoreSchema]', '__pydantic_custom_init__': 'ClassVar[bool]', '__pydantic_decorators__': 'ClassVar[_decorators.DecoratorInfos]', '__pydantic_extra__': 'dict[str, Any] | None', '__pydantic_fields_set__': 'set[str]', '__pydantic_generic_metadata__': 'ClassVar[_generics.PydanticGenericMetadata]', '__pydantic_parent_namespace__': 'ClassVar[Dict[str, Any] | None]', '__pydantic_post_init__': "ClassVar[None | Literal['model_post_init']]", '__pydantic_private__': 'dict[str, Any] | None', '__pydantic_root_model__': 'ClassVar[bool]', '__pydantic_serializer__': 'ClassVar[SchemaSerializer]', '__pydantic_validator__': 'ClassVar[SchemaValidator | PluggableSchemaValidator]', '__signature__': 'ClassVar[Signature]', 'data': <class 'kittycad.models.set_selection_type.SetSelectionType'>, 'model_computed_fields': 'ClassVar[Dict[str, ComputedFieldInfo]]', 'model_config': 'ClassVar[ConfigDict]', 'model_fields': 'ClassVar[Dict[str, FieldInfo]]', 'type': typing.Literal['set_selection_type']}[source]

classmethod __class_getitem__(typevar_values)[source]

Return type:: type[BaseModel] | PydanticRecursiveRef

__class_vars__: ClassVar[set[str]] = {}[source]: The names of the class variables defined on the model.

__copy__()[source]

Returns a shallow copy of the model.

Return type:: Self

__deepcopy__(memo=None)[source]

Returns a deep copy of the model.

Return type:: Self

__delattr__(item)[source]

Implement delattr(self, name).

Return type:: Any

__dict__[source]

__eq__(other)[source]

Return self==value.

Return type:: bool

property __fields_set__: set[str][source]

classmethod __get_pydantic_core_schema__(source, handler, /)[source]

Hook into generating the model’s CoreSchema.

Parameters:

source (type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.
handler (GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.

Return type:

Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]

Returns:

A pydantic-core CoreSchema.

classmethod __get_pydantic_json_schema__(core_schema, handler, /)[source]

Hook into generating the model’s JSON schema.

Parameters:

core_schema (Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({'type': 'nullable', 'schema': current_schema}), or just call the handler with the original schema.
handler (GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.

Return type:

Returns:

A JSON schema, as a Python object.

__getattr__(item)[source]

Return type:: Any

__getstate__()[source]

Helper for pickle.

Return type:: dict[Any, Any]

__hash__ = None[source]

__init__(**data)[source]

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__iter__()[source]

So dict(model) works.

Return type:: Generator[Tuple[str, Any], None, None]

__module__ = 'kittycad.models.ok_modeling_cmd_response'[source]

__pretty__(fmt, **kwargs)[source]

Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.

Return type:: Generator[Any, None, None]

__private_attributes__: ClassVar[Dict[str, ModelPrivateAttr]] = {}[source]: Metadata about the private attributes of the model.

__pydantic_complete__: ClassVar[bool] = True[source]: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__: ClassVar[CoreSchema] = {'cls': <class 'kittycad.models.ok_modeling_cmd_response.OptionSetSelectionType'>, 'config': {'title': 'OptionSetSelectionType'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.ok_modeling_cmd_response.OptionSetSelectionType'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.ok_modeling_cmd_response.OptionSetSelectionType'>>]}, 'ref': 'kittycad.models.ok_modeling_cmd_response.OptionSetSelectionType:94667212508608', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'data': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.set_selection_type.SetSelectionType'>, 'config': {'title': 'SetSelectionType'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.set_selection_type.SetSelectionType'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.set_selection_type.SetSelectionType'>>]}, 'ref': 'kittycad.models.set_selection_type.SetSelectionType:94667212470352', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {}, 'model_name': 'SetSelectionType', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}, 'type': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': 'set_selection_type', 'schema': {'expected': ['set_selection_type'], 'type': 'literal'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'OptionSetSelectionType', 'type': 'model-fields'}, 'type': 'model'}[source]: The core schema of the model.

__pydantic_custom_init__: ClassVar[bool] = False[source]: Whether the model has a custom __init__ method.

__pydantic_decorators__: ClassVar[_decorators.DecoratorInfos] = DecoratorInfos(validators={}, field_validators={}, root_validators={}, field_serializers={}, model_serializers={}, model_validators={}, computed_fields={})[source]: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_extra__: dict[str, Any] | None[source]: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to 'allow'.

__pydantic_fields_set__: set[str][source]: The names of fields explicitly set during instantiation.

__pydantic_generic_metadata__: ClassVar[_generics.PydanticGenericMetadata] = {'args': (), 'origin': None, 'parameters': ()}[source]: 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.

classmethod __pydantic_init_subclass__(**kwargs)[source]

This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.

This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.

This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.

Parameters:: **kwargs (Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.
Return type:: None

__pydantic_parent_namespace__: ClassVar[Dict[str, Any] | None] = None[source]: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__: ClassVar[None | Literal['model_post_init']] = None[source]: The name of the post-init method for the model, if defined.

__pydantic_private__: dict[str, Any] | None[source]: Values of private attributes set on the model instance.

__pydantic_root_model__: ClassVar[bool] = False[source]: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__: ClassVar[SchemaSerializer] = SchemaSerializer(serializer=Model( ModelSerializer { class: Py( 0x000056196d92cdc0, ), serializer: Fields( GeneralFieldsSerializer { fields: { "data": SerField { key_py: Py( 0x00007f9038238fa0, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196d923850, ), serializer: Fields( GeneralFieldsSerializer { fields: {}, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 0, }, ), has_extra: false, root_model: false, name: "SetSelectionType", }, ), ), required: true, }, "type": SerField { key_py: Py( 0x00007f903823d958, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f90346e66b0, ), ), serializer: Literal( LiteralSerializer { expected_int: {}, expected_str: { "set_selection_type", }, expected_py: None, name: "literal['set_selection_type']", }, ), }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "OptionSetSelectionType", }, ), definitions=[])[source]: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__: ClassVar[SchemaValidator | PluggableSchemaValidator] = SchemaValidator(title="OptionSetSelectionType", validator=Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "data", lookup_key: Simple { key: "data", py_key: Py( 0x00007f90334d5a40, ), path: LookupPath( [ S( "data", Py( 0x00007f90334d7630, ), ), ], ), }, name_py: Py( 0x00007f9038238fa0, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [], model_name: "SetSelectionType", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d923850, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "SetSelectionType", }, ), frozen: false, }, Field { name: "type", lookup_key: Simple { key: "type", py_key: Py( 0x00007f90334d5e90, ), path: LookupPath( [ S( "type", Py( 0x00007f90334d5b00, ), ), ], ), }, name_py: Py( 0x00007f903823d958, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f90346e66b0, ), ), on_error: Raise, validator: Literal( LiteralValidator { lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "set_selection_type": 0, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f90346e66b0, ), ], }, expected_repr: "'set_selection_type'", name: "literal['set_selection_type']", }, ), validate_default: false, copy_default: false, name: "default[literal['set_selection_type']]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "OptionSetSelectionType", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d92cdc0, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "OptionSetSelectionType", }, ), definitions=[], cache_strings=True)[source]: The pydantic-core SchemaValidator used to validate instances of the model.

__repr__()[source]

Return repr(self).

Return type:: str

__repr_args__()[source]

Return type:: Iterable[tuple[str | None, Any]]

__repr_name__()[source]

Name of the instance’s class, used in __repr__.

Return type:: str

__repr_str__(join_str)[source]

Return type:: str

__rich_repr__()[source]

Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.

Return type:: Iterable[Any | tuple[Any] | tuple[str, Any] | tuple[str, Any, Any]]

__setattr__(name, value)[source]

Implement setattr(self, name, value).

Return type:: None

__setstate__(state)[source]

Return type:: None

__signature__: ClassVar[Signature] = <Signature (*, data: kittycad.models.set_selection_type.SetSelectionType, type: Literal['set_selection_type'] = 'set_selection_type') -> None>[source]: The synthesized __init__ [Signature][inspect.Signature] of the model.

__slots__ = ('__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__')[source]

__str__()[source]

Return str(self).

Return type:: str

_abc_impl = <_abc._abc_data object>[source]

_calculate_keys(*args, **kwargs)[source]

Return type:: Any

_check_frozen(name, value)[source]

Return type:: None

_copy_and_set_values(*args, **kwargs)[source]

Return type:: Any

classmethod _get_value(*args, **kwargs)[source]

Return type:: Any

_iter(*args, **kwargs)[source]

Return type:: Any

classmethod construct(_fields_set=None, **values)[source]

Return type:: Self

copy(*, include=None, exclude=None, update=None, deep=False)[source]

Returns a copy of the model.

!!! warning “Deprecated”: This method is now deprecated; use model_copy instead.

If you need include or exclude, use:

`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `

Parameters:

include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.

Returns:

A copy of the model with included, excluded and updated fields as specified.

data: SetSelectionType[source]

dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)[source]

Return type:: Dict[str, Any]

classmethod from_orm(obj)[source]

Return type:: Self

json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)[source]

Return type:: str

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}[source]: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'protected_namespaces': ()}[source]: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod model_construct(_fields_set=None, **values)[source]

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note: model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == 'allow', then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == 'ignore' (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == 'forbid' does not result in an error if extra values are passed, but they will be ignored.

Parameters:

_fields_set (set[str] | None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.
values (Any) – Trusted or pre-validated data dictionary.

Return type:

Self

Returns:

A new instance of the Model class with validated data.

model_copy(*, update=None, deep=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy

Returns a copy of the model.

Parameters:

update (dict[str, Any] | None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.
deep (bool) – Set to True to make a deep copy of the model.

Return type:

Self

Returns:

New model instance.

model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters:

mode (Union[Literal['json', 'python'], str]) – The mode in which to_python 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.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to include in the output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to exclude from the output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to use the field’s alias in the dictionary key if defined.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A dictionary representation of the model.

model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

Generates a JSON representation of the model using Pydantic’s to_json method.

Parameters:

indent (int | None) – Indentation to use in the JSON output. If None is passed, the output will be compact.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to include in the JSON output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to exclude from the JSON output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to serialize using field aliases.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A JSON string representation of the model.

property model_extra: dict[str, Any] | None[source]

Get extra fields set during validation.

Returns:: A dictionary of extra fields, or None if config.extra is not set to "allow".

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=SetSelectionType, required=True), 'type': FieldInfo(annotation=Literal['set_selection_type'], required=False, default='set_selection_type')}[source]

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

property model_fields_set: set[str][source]

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,: i.e. that were not filled from defaults.

classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')[source]

Generates a JSON schema for a model class.

Parameters:

by_alias (bool) – Whether to use attribute aliases or not.
ref_template (str) – The reference template.
schema_generator (type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modifications
mode (Literal['validation', 'serialization']) – The mode in which to generate the schema.

Return type:

Returns:

The JSON schema for the given model class.

classmethod model_parametrized_name(params)[source]

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

Parameters:: params (tuple[type[Any], ...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.
Return type:: str
Returns:: String representing the new class where params are passed to cls as type variables.
Raises:: TypeError – Raised when trying to generate concrete names for non-generic models.

model_post_init(_BaseModel__context)[source]

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

Return type:: None

classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)[source]

Try to rebuild the pydantic-core schema for the model.

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.

Parameters:

force (bool) – Whether to force the rebuilding of the model schema, defaults to False.
raise_errors (bool) – Whether to raise errors, defaults to True.
_parent_namespace_depth (int) – The depth level of the parent namespace, defaults to 2.
_types_namespace (dict[str, Any] | None) – The types namespace, defaults to None.

Return type:

Returns:

Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.

classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)[source]

Validate a pydantic model instance.

Parameters:

obj (Any) – The object to validate.
strict (bool | None) – Whether to enforce types strictly.
from_attributes (bool | None) – Whether to extract data from object attributes.
context (Any | None) – Additional context to pass to the validator.

Raises:

ValidationError – If the object could not be validated.

Return type:

Self

Returns:

The validated model instance.

classmethod model_validate_json(json_data, *, strict=None, context=None)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing

Validate the given JSON data against the Pydantic model.

Parameters:

json_data (str | bytes | bytearray) – The JSON data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

Raises:

ValidationError – If json_data is not a JSON string or the object could not be validated.

classmethod model_validate_strings(obj, *, strict=None, context=None)[source]

Validate the given object with string data against the Pydantic model.

Parameters:

obj (Any) – The object containing string data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod parse_obj(obj)[source]

Return type:: Self

classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod schema(by_alias=True, ref_template='#/$defs/{model}')[source]

Return type:: Dict[str, Any]

classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)[source]

Return type:: str

type: Literal['set_selection_type'][source]

classmethod update_forward_refs(**localns)[source]

Return type:: None

classmethod validate(value)[source]

Return type:: Self

class kittycad.models.ok_modeling_cmd_response.OptionSetTool(**data)[source][source]

The response to the ‘SetTool’ endpoint

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__abstractmethods__ = frozenset({})[source]

__annotations__ = {'__class_vars__': 'ClassVar[set[str]]', '__private_attributes__': 'ClassVar[Dict[str, ModelPrivateAttr]]', '__pydantic_complete__': 'ClassVar[bool]', '__pydantic_core_schema__': 'ClassVar[CoreSchema]', '__pydantic_custom_init__': 'ClassVar[bool]', '__pydantic_decorators__': 'ClassVar[_decorators.DecoratorInfos]', '__pydantic_extra__': 'dict[str, Any] | None', '__pydantic_fields_set__': 'set[str]', '__pydantic_generic_metadata__': 'ClassVar[_generics.PydanticGenericMetadata]', '__pydantic_parent_namespace__': 'ClassVar[Dict[str, Any] | None]', '__pydantic_post_init__': "ClassVar[None | Literal['model_post_init']]", '__pydantic_private__': 'dict[str, Any] | None', '__pydantic_root_model__': 'ClassVar[bool]', '__pydantic_serializer__': 'ClassVar[SchemaSerializer]', '__pydantic_validator__': 'ClassVar[SchemaValidator | PluggableSchemaValidator]', '__signature__': 'ClassVar[Signature]', 'data': <class 'kittycad.models.set_tool.SetTool'>, 'model_computed_fields': 'ClassVar[Dict[str, ComputedFieldInfo]]', 'model_config': 'ClassVar[ConfigDict]', 'model_fields': 'ClassVar[Dict[str, FieldInfo]]', 'type': typing.Literal['set_tool']}[source]

classmethod __class_getitem__(typevar_values)[source]

Return type:: type[BaseModel] | PydanticRecursiveRef

__class_vars__: ClassVar[set[str]] = {}[source]: The names of the class variables defined on the model.

__copy__()[source]

Returns a shallow copy of the model.

Return type:: Self

__deepcopy__(memo=None)[source]

Returns a deep copy of the model.

Return type:: Self

__delattr__(item)[source]

Implement delattr(self, name).

Return type:: Any

__dict__[source]

__eq__(other)[source]

Return self==value.

Return type:: bool

property __fields_set__: set[str][source]

classmethod __get_pydantic_core_schema__(source, handler, /)[source]

Hook into generating the model’s CoreSchema.

Parameters:

source (type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.
handler (GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.

Return type:

Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]

Returns:

A pydantic-core CoreSchema.

classmethod __get_pydantic_json_schema__(core_schema, handler, /)[source]

Hook into generating the model’s JSON schema.

Parameters:

core_schema (Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({'type': 'nullable', 'schema': current_schema}), or just call the handler with the original schema.
handler (GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.

Return type:

Returns:

A JSON schema, as a Python object.

__getattr__(item)[source]

Return type:: Any

__getstate__()[source]

Helper for pickle.

Return type:: dict[Any, Any]

__hash__ = None[source]

__init__(**data)[source]

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__iter__()[source]

So dict(model) works.

Return type:: Generator[Tuple[str, Any], None, None]

__module__ = 'kittycad.models.ok_modeling_cmd_response'[source]

__pretty__(fmt, **kwargs)[source]

Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.

Return type:: Generator[Any, None, None]

__private_attributes__: ClassVar[Dict[str, ModelPrivateAttr]] = {}[source]: Metadata about the private attributes of the model.

__pydantic_complete__: ClassVar[bool] = True[source]: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__: ClassVar[CoreSchema] = {'cls': <class 'kittycad.models.ok_modeling_cmd_response.OptionSetTool'>, 'config': {'title': 'OptionSetTool'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.ok_modeling_cmd_response.OptionSetTool'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.ok_modeling_cmd_response.OptionSetTool'>>]}, 'ref': 'kittycad.models.ok_modeling_cmd_response.OptionSetTool:94667212999456', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'data': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.set_tool.SetTool'>, 'config': {'title': 'SetTool'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.set_tool.SetTool'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.set_tool.SetTool'>>]}, 'ref': 'kittycad.models.set_tool.SetTool:94667212459088', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {}, 'model_name': 'SetTool', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}, 'type': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': 'set_tool', 'schema': {'expected': ['set_tool'], 'type': 'literal'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'OptionSetTool', 'type': 'model-fields'}, 'type': 'model'}[source]: The core schema of the model.

__pydantic_custom_init__: ClassVar[bool] = False[source]: Whether the model has a custom __init__ method.

__pydantic_decorators__: ClassVar[_decorators.DecoratorInfos] = DecoratorInfos(validators={}, field_validators={}, root_validators={}, field_serializers={}, model_serializers={}, model_validators={}, computed_fields={})[source]: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_extra__: dict[str, Any] | None[source]: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to 'allow'.

__pydantic_fields_set__: set[str][source]: The names of fields explicitly set during instantiation.

__pydantic_generic_metadata__: ClassVar[_generics.PydanticGenericMetadata] = {'args': (), 'origin': None, 'parameters': ()}[source]: 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.

classmethod __pydantic_init_subclass__(**kwargs)[source]

This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.

This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.

This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.

Parameters:: **kwargs (Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.
Return type:: None

__pydantic_parent_namespace__: ClassVar[Dict[str, Any] | None] = None[source]: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__: ClassVar[None | Literal['model_post_init']] = None[source]: The name of the post-init method for the model, if defined.

__pydantic_private__: dict[str, Any] | None[source]: Values of private attributes set on the model instance.

__pydantic_root_model__: ClassVar[bool] = False[source]: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__: ClassVar[SchemaSerializer] = SchemaSerializer(serializer=Model( ModelSerializer { class: Py( 0x000056196d9a4b20, ), serializer: Fields( GeneralFieldsSerializer { fields: { "type": SerField { key_py: Py( 0x00007f903823d958, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f90346e6770, ), ), serializer: Literal( LiteralSerializer { expected_int: {}, expected_str: { "set_tool", }, expected_py: None, name: "literal['set_tool']", }, ), }, ), ), required: true, }, "data": SerField { key_py: Py( 0x00007f9038238fa0, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196d920c50, ), serializer: Fields( GeneralFieldsSerializer { fields: {}, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 0, }, ), has_extra: false, root_model: false, name: "SetTool", }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "OptionSetTool", }, ), definitions=[])[source]: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__: ClassVar[SchemaValidator | PluggableSchemaValidator] = SchemaValidator(title="OptionSetTool", validator=Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "data", lookup_key: Simple { key: "data", py_key: Py( 0x00007f90334d6c40, ), path: LookupPath( [ S( "data", Py( 0x00007f90334d6c70, ), ), ], ), }, name_py: Py( 0x00007f9038238fa0, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [], model_name: "SetTool", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d920c50, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "SetTool", }, ), frozen: false, }, Field { name: "type", lookup_key: Simple { key: "type", py_key: Py( 0x00007f90334d6ca0, ), path: LookupPath( [ S( "type", Py( 0x00007f90334d6cd0, ), ), ], ), }, name_py: Py( 0x00007f903823d958, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f90346e6770, ), ), on_error: Raise, validator: Literal( LiteralValidator { lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "set_tool": 0, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f90346e6770, ), ], }, expected_repr: "'set_tool'", name: "literal['set_tool']", }, ), validate_default: false, copy_default: false, name: "default[literal['set_tool']]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "OptionSetTool", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d9a4b20, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "OptionSetTool", }, ), definitions=[], cache_strings=True)[source]: The pydantic-core SchemaValidator used to validate instances of the model.

__repr__()[source]

Return repr(self).

Return type:: str

__repr_args__()[source]

Return type:: Iterable[tuple[str | None, Any]]

__repr_name__()[source]

Name of the instance’s class, used in __repr__.

Return type:: str

__repr_str__(join_str)[source]

Return type:: str

__rich_repr__()[source]

Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.

Return type:: Iterable[Any | tuple[Any] | tuple[str, Any] | tuple[str, Any, Any]]

__setattr__(name, value)[source]

Implement setattr(self, name, value).

Return type:: None

__setstate__(state)[source]

Return type:: None

__signature__: ClassVar[Signature] = <Signature (*, data: kittycad.models.set_tool.SetTool, type: Literal['set_tool'] = 'set_tool') -> None>[source]: The synthesized __init__ [Signature][inspect.Signature] of the model.

__slots__ = ('__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__')[source]

__str__()[source]

Return str(self).

Return type:: str

_abc_impl = <_abc._abc_data object>[source]

_calculate_keys(*args, **kwargs)[source]

Return type:: Any

_check_frozen(name, value)[source]

Return type:: None

_copy_and_set_values(*args, **kwargs)[source]

Return type:: Any

classmethod _get_value(*args, **kwargs)[source]

Return type:: Any

_iter(*args, **kwargs)[source]

Return type:: Any

classmethod construct(_fields_set=None, **values)[source]

Return type:: Self

copy(*, include=None, exclude=None, update=None, deep=False)[source]

Returns a copy of the model.

!!! warning “Deprecated”: This method is now deprecated; use model_copy instead.

If you need include or exclude, use:

`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `

Parameters:

include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.

Returns:

A copy of the model with included, excluded and updated fields as specified.

data: SetTool[source]

dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)[source]

Return type:: Dict[str, Any]

classmethod from_orm(obj)[source]

Return type:: Self

json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)[source]

Return type:: str

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}[source]: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'protected_namespaces': ()}[source]: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod model_construct(_fields_set=None, **values)[source]

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note: model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == 'allow', then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == 'ignore' (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == 'forbid' does not result in an error if extra values are passed, but they will be ignored.

Parameters:

_fields_set (set[str] | None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.
values (Any) – Trusted or pre-validated data dictionary.

Return type:

Self

Returns:

A new instance of the Model class with validated data.

model_copy(*, update=None, deep=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy

Returns a copy of the model.

Parameters:

update (dict[str, Any] | None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.
deep (bool) – Set to True to make a deep copy of the model.

Return type:

Self

Returns:

New model instance.

model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters:

mode (Union[Literal['json', 'python'], str]) – The mode in which to_python 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.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to include in the output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to exclude from the output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to use the field’s alias in the dictionary key if defined.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A dictionary representation of the model.

model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

Generates a JSON representation of the model using Pydantic’s to_json method.

Parameters:

indent (int | None) – Indentation to use in the JSON output. If None is passed, the output will be compact.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to include in the JSON output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to exclude from the JSON output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to serialize using field aliases.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A JSON string representation of the model.

property model_extra: dict[str, Any] | None[source]

Get extra fields set during validation.

Returns:: A dictionary of extra fields, or None if config.extra is not set to "allow".

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=SetTool, required=True), 'type': FieldInfo(annotation=Literal['set_tool'], required=False, default='set_tool')}[source]

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

property model_fields_set: set[str][source]

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,: i.e. that were not filled from defaults.

classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')[source]

Generates a JSON schema for a model class.

Parameters:

by_alias (bool) – Whether to use attribute aliases or not.
ref_template (str) – The reference template.
schema_generator (type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modifications
mode (Literal['validation', 'serialization']) – The mode in which to generate the schema.

Return type:

Returns:

The JSON schema for the given model class.

classmethod model_parametrized_name(params)[source]

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

Parameters:: params (tuple[type[Any], ...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.
Return type:: str
Returns:: String representing the new class where params are passed to cls as type variables.
Raises:: TypeError – Raised when trying to generate concrete names for non-generic models.

model_post_init(_BaseModel__context)[source]

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

Return type:: None

classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)[source]

Try to rebuild the pydantic-core schema for the model.

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.

Parameters:

force (bool) – Whether to force the rebuilding of the model schema, defaults to False.
raise_errors (bool) – Whether to raise errors, defaults to True.
_parent_namespace_depth (int) – The depth level of the parent namespace, defaults to 2.
_types_namespace (dict[str, Any] | None) – The types namespace, defaults to None.

Return type:

Returns:

Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.

classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)[source]

Validate a pydantic model instance.

Parameters:

obj (Any) – The object to validate.
strict (bool | None) – Whether to enforce types strictly.
from_attributes (bool | None) – Whether to extract data from object attributes.
context (Any | None) – Additional context to pass to the validator.

Raises:

ValidationError – If the object could not be validated.

Return type:

Self

Returns:

The validated model instance.

classmethod model_validate_json(json_data, *, strict=None, context=None)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing

Validate the given JSON data against the Pydantic model.

Parameters:

json_data (str | bytes | bytearray) – The JSON data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

Raises:

ValidationError – If json_data is not a JSON string or the object could not be validated.

classmethod model_validate_strings(obj, *, strict=None, context=None)[source]

Validate the given object with string data against the Pydantic model.

Parameters:

obj (Any) – The object containing string data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod parse_obj(obj)[source]

Return type:: Self

classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod schema(by_alias=True, ref_template='#/$defs/{model}')[source]

Return type:: Dict[str, Any]

classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)[source]

Return type:: str

type: Literal['set_tool'][source]

classmethod update_forward_refs(**localns)[source]

Return type:: None

classmethod validate(value)[source]

Return type:: Self

class kittycad.models.ok_modeling_cmd_response.OptionSketchModeDisable(**data)[source][source]

The response to the ‘SketchModeDisable’ endpoint

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__abstractmethods__ = frozenset({})[source]

__annotations__ = {'__class_vars__': 'ClassVar[set[str]]', '__private_attributes__': 'ClassVar[Dict[str, ModelPrivateAttr]]', '__pydantic_complete__': 'ClassVar[bool]', '__pydantic_core_schema__': 'ClassVar[CoreSchema]', '__pydantic_custom_init__': 'ClassVar[bool]', '__pydantic_decorators__': 'ClassVar[_decorators.DecoratorInfos]', '__pydantic_extra__': 'dict[str, Any] | None', '__pydantic_fields_set__': 'set[str]', '__pydantic_generic_metadata__': 'ClassVar[_generics.PydanticGenericMetadata]', '__pydantic_parent_namespace__': 'ClassVar[Dict[str, Any] | None]', '__pydantic_post_init__': "ClassVar[None | Literal['model_post_init']]", '__pydantic_private__': 'dict[str, Any] | None', '__pydantic_root_model__': 'ClassVar[bool]', '__pydantic_serializer__': 'ClassVar[SchemaSerializer]', '__pydantic_validator__': 'ClassVar[SchemaValidator | PluggableSchemaValidator]', '__signature__': 'ClassVar[Signature]', 'data': <class 'kittycad.models.sketch_mode_disable.SketchModeDisable'>, 'model_computed_fields': 'ClassVar[Dict[str, ComputedFieldInfo]]', 'model_config': 'ClassVar[ConfigDict]', 'model_fields': 'ClassVar[Dict[str, FieldInfo]]', 'type': typing.Literal['sketch_mode_disable']}[source]

classmethod __class_getitem__(typevar_values)[source]

Return type:: type[BaseModel] | PydanticRecursiveRef

__class_vars__: ClassVar[set[str]] = {}[source]: The names of the class variables defined on the model.

__copy__()[source]

Returns a shallow copy of the model.

Return type:: Self

__deepcopy__(memo=None)[source]

Returns a deep copy of the model.

Return type:: Self

__delattr__(item)[source]

Implement delattr(self, name).

Return type:: Any

__dict__[source]

__eq__(other)[source]

Return self==value.

Return type:: bool

property __fields_set__: set[str][source]

classmethod __get_pydantic_core_schema__(source, handler, /)[source]

Hook into generating the model’s CoreSchema.

Parameters:

source (type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.
handler (GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.

Return type:

Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]

Returns:

A pydantic-core CoreSchema.

classmethod __get_pydantic_json_schema__(core_schema, handler, /)[source]

Hook into generating the model’s JSON schema.

Parameters:

core_schema (Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({'type': 'nullable', 'schema': current_schema}), or just call the handler with the original schema.
handler (GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.

Return type:

Returns:

A JSON schema, as a Python object.

__getattr__(item)[source]

Return type:: Any

__getstate__()[source]

Helper for pickle.

Return type:: dict[Any, Any]

__hash__ = None[source]

__init__(**data)[source]

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__iter__()[source]

So dict(model) works.

Return type:: Generator[Tuple[str, Any], None, None]

__module__ = 'kittycad.models.ok_modeling_cmd_response'[source]

__pretty__(fmt, **kwargs)[source]

Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.

Return type:: Generator[Any, None, None]

__private_attributes__: ClassVar[Dict[str, ModelPrivateAttr]] = {}[source]: Metadata about the private attributes of the model.

__pydantic_complete__: ClassVar[bool] = True[source]: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__: ClassVar[CoreSchema] = {'cls': <class 'kittycad.models.ok_modeling_cmd_response.OptionSketchModeDisable'>, 'config': {'title': 'OptionSketchModeDisable'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.ok_modeling_cmd_response.OptionSketchModeDisable'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.ok_modeling_cmd_response.OptionSketchModeDisable'>>]}, 'ref': 'kittycad.models.ok_modeling_cmd_response.OptionSketchModeDisable:94667213017984', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'data': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.sketch_mode_disable.SketchModeDisable'>, 'config': {'title': 'SketchModeDisable'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.sketch_mode_disable.SketchModeDisable'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.sketch_mode_disable.SketchModeDisable'>>]}, 'ref': 'kittycad.models.sketch_mode_disable.SketchModeDisable:94667212462336', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {}, 'model_name': 'SketchModeDisable', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}, 'type': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': 'sketch_mode_disable', 'schema': {'expected': ['sketch_mode_disable'], 'type': 'literal'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'OptionSketchModeDisable', 'type': 'model-fields'}, 'type': 'model'}[source]: The core schema of the model.

__pydantic_custom_init__: ClassVar[bool] = False[source]: Whether the model has a custom __init__ method.

__pydantic_decorators__: ClassVar[_decorators.DecoratorInfos] = DecoratorInfos(validators={}, field_validators={}, root_validators={}, field_serializers={}, model_serializers={}, model_validators={}, computed_fields={})[source]: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_extra__: dict[str, Any] | None[source]: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to 'allow'.

__pydantic_fields_set__: set[str][source]: The names of fields explicitly set during instantiation.

__pydantic_generic_metadata__: ClassVar[_generics.PydanticGenericMetadata] = {'args': (), 'origin': None, 'parameters': ()}[source]: 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.

classmethod __pydantic_init_subclass__(**kwargs)[source]

This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.

This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.

This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.

Parameters:: **kwargs (Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.
Return type:: None

__pydantic_parent_namespace__: ClassVar[Dict[str, Any] | None] = None[source]: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__: ClassVar[None | Literal['model_post_init']] = None[source]: The name of the post-init method for the model, if defined.

__pydantic_private__: dict[str, Any] | None[source]: Values of private attributes set on the model instance.

__pydantic_root_model__: ClassVar[bool] = False[source]: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__: ClassVar[SchemaSerializer] = SchemaSerializer(serializer=Model( ModelSerializer { class: Py( 0x000056196d9a9380, ), serializer: Fields( GeneralFieldsSerializer { fields: { "type": SerField { key_py: Py( 0x00007f903823d958, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f90346e67f0, ), ), serializer: Literal( LiteralSerializer { expected_int: {}, expected_str: { "sketch_mode_disable", }, expected_py: None, name: "literal['sketch_mode_disable']", }, ), }, ), ), required: true, }, "data": SerField { key_py: Py( 0x00007f9038238fa0, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196d921900, ), serializer: Fields( GeneralFieldsSerializer { fields: {}, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 0, }, ), has_extra: false, root_model: false, name: "SketchModeDisable", }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "OptionSketchModeDisable", }, ), definitions=[])[source]: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__: ClassVar[SchemaValidator | PluggableSchemaValidator] = SchemaValidator(title="OptionSketchModeDisable", validator=Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "data", lookup_key: Simple { key: "data", py_key: Py( 0x00007f90334d73f0, ), path: LookupPath( [ S( "data", Py( 0x00007f90334d7390, ), ), ], ), }, name_py: Py( 0x00007f9038238fa0, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [], model_name: "SketchModeDisable", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d921900, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "SketchModeDisable", }, ), frozen: false, }, Field { name: "type", lookup_key: Simple { key: "type", py_key: Py( 0x00007f90334d72d0, ), path: LookupPath( [ S( "type", Py( 0x00007f90334d72a0, ), ), ], ), }, name_py: Py( 0x00007f903823d958, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f90346e67f0, ), ), on_error: Raise, validator: Literal( LiteralValidator { lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "sketch_mode_disable": 0, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f90346e67f0, ), ], }, expected_repr: "'sketch_mode_disable'", name: "literal['sketch_mode_disable']", }, ), validate_default: false, copy_default: false, name: "default[literal['sketch_mode_disable']]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "OptionSketchModeDisable", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d9a9380, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "OptionSketchModeDisable", }, ), definitions=[], cache_strings=True)[source]: The pydantic-core SchemaValidator used to validate instances of the model.

__repr__()[source]

Return repr(self).

Return type:: str

__repr_args__()[source]

Return type:: Iterable[tuple[str | None, Any]]

__repr_name__()[source]

Name of the instance’s class, used in __repr__.

Return type:: str

__repr_str__(join_str)[source]

Return type:: str

__rich_repr__()[source]

Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.

Return type:: Iterable[Any | tuple[Any] | tuple[str, Any] | tuple[str, Any, Any]]

__setattr__(name, value)[source]

Implement setattr(self, name, value).

Return type:: None

__setstate__(state)[source]

Return type:: None

__signature__: ClassVar[Signature] = <Signature (*, data: kittycad.models.sketch_mode_disable.SketchModeDisable, type: Literal['sketch_mode_disable'] = 'sketch_mode_disable') -> None>[source]: The synthesized __init__ [Signature][inspect.Signature] of the model.

__slots__ = ('__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__')[source]

__str__()[source]

Return str(self).

Return type:: str

_abc_impl = <_abc._abc_data object>[source]

_calculate_keys(*args, **kwargs)[source]

Return type:: Any

_check_frozen(name, value)[source]

Return type:: None

_copy_and_set_values(*args, **kwargs)[source]

Return type:: Any

classmethod _get_value(*args, **kwargs)[source]

Return type:: Any

_iter(*args, **kwargs)[source]

Return type:: Any

classmethod construct(_fields_set=None, **values)[source]

Return type:: Self

copy(*, include=None, exclude=None, update=None, deep=False)[source]

Returns a copy of the model.

!!! warning “Deprecated”: This method is now deprecated; use model_copy instead.

If you need include or exclude, use:

`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `

Parameters:

include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.

Returns:

A copy of the model with included, excluded and updated fields as specified.

data: SketchModeDisable[source]

dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)[source]

Return type:: Dict[str, Any]

classmethod from_orm(obj)[source]

Return type:: Self

json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)[source]

Return type:: str

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}[source]: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'protected_namespaces': ()}[source]: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod model_construct(_fields_set=None, **values)[source]

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note: model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == 'allow', then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == 'ignore' (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == 'forbid' does not result in an error if extra values are passed, but they will be ignored.

Parameters:

_fields_set (set[str] | None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.
values (Any) – Trusted or pre-validated data dictionary.

Return type:

Self

Returns:

A new instance of the Model class with validated data.

model_copy(*, update=None, deep=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy

Returns a copy of the model.

Parameters:

update (dict[str, Any] | None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.
deep (bool) – Set to True to make a deep copy of the model.

Return type:

Self

Returns:

New model instance.

model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters:

mode (Union[Literal['json', 'python'], str]) – The mode in which to_python 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.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to include in the output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to exclude from the output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to use the field’s alias in the dictionary key if defined.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A dictionary representation of the model.

model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

Generates a JSON representation of the model using Pydantic’s to_json method.

Parameters:

indent (int | None) – Indentation to use in the JSON output. If None is passed, the output will be compact.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to include in the JSON output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to exclude from the JSON output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to serialize using field aliases.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A JSON string representation of the model.

property model_extra: dict[str, Any] | None[source]

Get extra fields set during validation.

Returns:: A dictionary of extra fields, or None if config.extra is not set to "allow".

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=SketchModeDisable, required=True), 'type': FieldInfo(annotation=Literal['sketch_mode_disable'], required=False, default='sketch_mode_disable')}[source]

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

property model_fields_set: set[str][source]

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,: i.e. that were not filled from defaults.

classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')[source]

Generates a JSON schema for a model class.

Parameters:

by_alias (bool) – Whether to use attribute aliases or not.
ref_template (str) – The reference template.
schema_generator (type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modifications
mode (Literal['validation', 'serialization']) – The mode in which to generate the schema.

Return type:

Returns:

The JSON schema for the given model class.

classmethod model_parametrized_name(params)[source]

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

Parameters:: params (tuple[type[Any], ...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.
Return type:: str
Returns:: String representing the new class where params are passed to cls as type variables.
Raises:: TypeError – Raised when trying to generate concrete names for non-generic models.

model_post_init(_BaseModel__context)[source]

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

Return type:: None

classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)[source]

Try to rebuild the pydantic-core schema for the model.

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.

Parameters:

force (bool) – Whether to force the rebuilding of the model schema, defaults to False.
raise_errors (bool) – Whether to raise errors, defaults to True.
_parent_namespace_depth (int) – The depth level of the parent namespace, defaults to 2.
_types_namespace (dict[str, Any] | None) – The types namespace, defaults to None.

Return type:

Returns:

Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.

classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)[source]

Validate a pydantic model instance.

Parameters:

obj (Any) – The object to validate.
strict (bool | None) – Whether to enforce types strictly.
from_attributes (bool | None) – Whether to extract data from object attributes.
context (Any | None) – Additional context to pass to the validator.

Raises:

ValidationError – If the object could not be validated.

Return type:

Self

Returns:

The validated model instance.

classmethod model_validate_json(json_data, *, strict=None, context=None)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing

Validate the given JSON data against the Pydantic model.

Parameters:

json_data (str | bytes | bytearray) – The JSON data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

Raises:

ValidationError – If json_data is not a JSON string or the object could not be validated.

classmethod model_validate_strings(obj, *, strict=None, context=None)[source]

Validate the given object with string data against the Pydantic model.

Parameters:

obj (Any) – The object containing string data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod parse_obj(obj)[source]

Return type:: Self

classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod schema(by_alias=True, ref_template='#/$defs/{model}')[source]

Return type:: Dict[str, Any]

classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)[source]

Return type:: str

type: Literal['sketch_mode_disable'][source]

classmethod update_forward_refs(**localns)[source]

Return type:: None

classmethod validate(value)[source]

Return type:: Self

class kittycad.models.ok_modeling_cmd_response.OptionSolid2DAddHole(**data)[source][source]

The response to the ‘Solid2dAddHole’ endpoint

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__abstractmethods__ = frozenset({})[source]

__annotations__ = {'__class_vars__': 'ClassVar[set[str]]', '__private_attributes__': 'ClassVar[Dict[str, ModelPrivateAttr]]', '__pydantic_complete__': 'ClassVar[bool]', '__pydantic_core_schema__': 'ClassVar[CoreSchema]', '__pydantic_custom_init__': 'ClassVar[bool]', '__pydantic_decorators__': 'ClassVar[_decorators.DecoratorInfos]', '__pydantic_extra__': 'dict[str, Any] | None', '__pydantic_fields_set__': 'set[str]', '__pydantic_generic_metadata__': 'ClassVar[_generics.PydanticGenericMetadata]', '__pydantic_parent_namespace__': 'ClassVar[Dict[str, Any] | None]', '__pydantic_post_init__': "ClassVar[None | Literal['model_post_init']]", '__pydantic_private__': 'dict[str, Any] | None', '__pydantic_root_model__': 'ClassVar[bool]', '__pydantic_serializer__': 'ClassVar[SchemaSerializer]', '__pydantic_validator__': 'ClassVar[SchemaValidator | PluggableSchemaValidator]', '__signature__': 'ClassVar[Signature]', 'data': <class 'kittycad.models.solid2d_add_hole.Solid2dAddHole'>, 'model_computed_fields': 'ClassVar[Dict[str, ComputedFieldInfo]]', 'model_config': 'ClassVar[ConfigDict]', 'model_fields': 'ClassVar[Dict[str, FieldInfo]]', 'type': typing.Literal['solid2d_add_hole']}[source]

classmethod __class_getitem__(typevar_values)[source]

Return type:: type[BaseModel] | PydanticRecursiveRef

__class_vars__: ClassVar[set[str]] = {}[source]: The names of the class variables defined on the model.

__copy__()[source]

Returns a shallow copy of the model.

Return type:: Self

__deepcopy__(memo=None)[source]

Returns a deep copy of the model.

Return type:: Self

__delattr__(item)[source]

Implement delattr(self, name).

Return type:: Any

__dict__[source]

__eq__(other)[source]

Return self==value.

Return type:: bool

property __fields_set__: set[str][source]

classmethod __get_pydantic_core_schema__(source, handler, /)[source]

Hook into generating the model’s CoreSchema.

Parameters:

source (type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.
handler (GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.

Return type:

Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]

Returns:

A pydantic-core CoreSchema.

classmethod __get_pydantic_json_schema__(core_schema, handler, /)[source]

Hook into generating the model’s JSON schema.

Parameters:

core_schema (Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({'type': 'nullable', 'schema': current_schema}), or just call the handler with the original schema.
handler (GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.

Return type:

Returns:

A JSON schema, as a Python object.

__getattr__(item)[source]

Return type:: Any

__getstate__()[source]

Helper for pickle.

Return type:: dict[Any, Any]

__hash__ = None[source]

__init__(**data)[source]

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__iter__()[source]

So dict(model) works.

Return type:: Generator[Tuple[str, Any], None, None]

__module__ = 'kittycad.models.ok_modeling_cmd_response'[source]

__pretty__(fmt, **kwargs)[source]

Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.

Return type:: Generator[Any, None, None]

__private_attributes__: ClassVar[Dict[str, ModelPrivateAttr]] = {}[source]: Metadata about the private attributes of the model.

__pydantic_complete__: ClassVar[bool] = True[source]: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__: ClassVar[CoreSchema] = {'cls': <class 'kittycad.models.ok_modeling_cmd_response.OptionSolid2DAddHole'>, 'config': {'title': 'OptionSolid2DAddHole'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.ok_modeling_cmd_response.OptionSolid2DAddHole'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.ok_modeling_cmd_response.OptionSolid2DAddHole'>>]}, 'ref': 'kittycad.models.ok_modeling_cmd_response.OptionSolid2DAddHole:94667212933920', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'data': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.solid2d_add_hole.Solid2dAddHole'>, 'config': {'title': 'Solid2dAddHole'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.solid2d_add_hole.Solid2dAddHole'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.solid2d_add_hole.Solid2dAddHole'>>]}, 'ref': 'kittycad.models.solid2d_add_hole.Solid2dAddHole:94667212438336', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {}, 'model_name': 'Solid2dAddHole', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}, 'type': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': 'solid2d_add_hole', 'schema': {'expected': ['solid2d_add_hole'], 'type': 'literal'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'OptionSolid2DAddHole', 'type': 'model-fields'}, 'type': 'model'}[source]: The core schema of the model.

__pydantic_custom_init__: ClassVar[bool] = False[source]: Whether the model has a custom __init__ method.

__pydantic_decorators__: ClassVar[_decorators.DecoratorInfos] = DecoratorInfos(validators={}, field_validators={}, root_validators={}, field_serializers={}, model_serializers={}, model_validators={}, computed_fields={})[source]: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_extra__: dict[str, Any] | None[source]: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to 'allow'.

__pydantic_fields_set__: set[str][source]: The names of fields explicitly set during instantiation.

__pydantic_generic_metadata__: ClassVar[_generics.PydanticGenericMetadata] = {'args': (), 'origin': None, 'parameters': ()}[source]: 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.

classmethod __pydantic_init_subclass__(**kwargs)[source]

This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.

This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.

This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.

Parameters:: **kwargs (Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.
Return type:: None

__pydantic_parent_namespace__: ClassVar[Dict[str, Any] | None] = None[source]: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__: ClassVar[None | Literal['model_post_init']] = None[source]: The name of the post-init method for the model, if defined.

__pydantic_private__: dict[str, Any] | None[source]: Values of private attributes set on the model instance.

__pydantic_root_model__: ClassVar[bool] = False[source]: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__: ClassVar[SchemaSerializer] = SchemaSerializer(serializer=Model( ModelSerializer { class: Py( 0x000056196d994b20, ), serializer: Fields( GeneralFieldsSerializer { fields: { "data": SerField { key_py: Py( 0x00007f9038238fa0, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196d91bb40, ), serializer: Fields( GeneralFieldsSerializer { fields: {}, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 0, }, ), has_extra: false, root_model: false, name: "Solid2dAddHole", }, ), ), required: true, }, "type": SerField { key_py: Py( 0x00007f903823d958, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f90346e68f0, ), ), serializer: Literal( LiteralSerializer { expected_int: {}, expected_str: { "solid2d_add_hole", }, expected_py: None, name: "literal['solid2d_add_hole']", }, ), }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "OptionSolid2DAddHole", }, ), definitions=[])[source]: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__: ClassVar[SchemaValidator | PluggableSchemaValidator] = SchemaValidator(title="OptionSolid2DAddHole", validator=Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "data", lookup_key: Simple { key: "data", py_key: Py( 0x00007f90334d5b60, ), path: LookupPath( [ S( "data", Py( 0x00007f90334d5b90, ), ), ], ), }, name_py: Py( 0x00007f9038238fa0, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [], model_name: "Solid2dAddHole", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d91bb40, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "Solid2dAddHole", }, ), frozen: false, }, Field { name: "type", lookup_key: Simple { key: "type", py_key: Py( 0x00007f90334d5bc0, ), path: LookupPath( [ S( "type", Py( 0x00007f90334d5bf0, ), ), ], ), }, name_py: Py( 0x00007f903823d958, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f90346e68f0, ), ), on_error: Raise, validator: Literal( LiteralValidator { lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "solid2d_add_hole": 0, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f90346e68f0, ), ], }, expected_repr: "'solid2d_add_hole'", name: "literal['solid2d_add_hole']", }, ), validate_default: false, copy_default: false, name: "default[literal['solid2d_add_hole']]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "OptionSolid2DAddHole", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d994b20, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "OptionSolid2DAddHole", }, ), definitions=[], cache_strings=True)[source]: The pydantic-core SchemaValidator used to validate instances of the model.

__repr__()[source]

Return repr(self).

Return type:: str

__repr_args__()[source]

Return type:: Iterable[tuple[str | None, Any]]

__repr_name__()[source]

Name of the instance’s class, used in __repr__.

Return type:: str

__repr_str__(join_str)[source]

Return type:: str

__rich_repr__()[source]

Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.

Return type:: Iterable[Any | tuple[Any] | tuple[str, Any] | tuple[str, Any, Any]]

__setattr__(name, value)[source]

Implement setattr(self, name, value).

Return type:: None

__setstate__(state)[source]

Return type:: None

__signature__: ClassVar[Signature] = <Signature (*, data: kittycad.models.solid2d_add_hole.Solid2dAddHole, type: Literal['solid2d_add_hole'] = 'solid2d_add_hole') -> None>[source]: The synthesized __init__ [Signature][inspect.Signature] of the model.

__slots__ = ('__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__')[source]

__str__()[source]

Return str(self).

Return type:: str

_abc_impl = <_abc._abc_data object>[source]

_calculate_keys(*args, **kwargs)[source]

Return type:: Any

_check_frozen(name, value)[source]

Return type:: None

_copy_and_set_values(*args, **kwargs)[source]

Return type:: Any

classmethod _get_value(*args, **kwargs)[source]

Return type:: Any

_iter(*args, **kwargs)[source]

Return type:: Any

classmethod construct(_fields_set=None, **values)[source]

Return type:: Self

copy(*, include=None, exclude=None, update=None, deep=False)[source]

Returns a copy of the model.

!!! warning “Deprecated”: This method is now deprecated; use model_copy instead.

If you need include or exclude, use:

`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `

Parameters:

include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.

Returns:

A copy of the model with included, excluded and updated fields as specified.

data: Solid2dAddHole[source]

dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)[source]

Return type:: Dict[str, Any]

classmethod from_orm(obj)[source]

Return type:: Self

json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)[source]

Return type:: str

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}[source]: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'protected_namespaces': ()}[source]: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod model_construct(_fields_set=None, **values)[source]

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note: model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == 'allow', then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == 'ignore' (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == 'forbid' does not result in an error if extra values are passed, but they will be ignored.

Parameters:

_fields_set (set[str] | None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.
values (Any) – Trusted or pre-validated data dictionary.

Return type:

Self

Returns:

A new instance of the Model class with validated data.

model_copy(*, update=None, deep=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy

Returns a copy of the model.

Parameters:

update (dict[str, Any] | None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.
deep (bool) – Set to True to make a deep copy of the model.

Return type:

Self

Returns:

New model instance.

model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters:

mode (Union[Literal['json', 'python'], str]) – The mode in which to_python 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.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to include in the output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to exclude from the output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to use the field’s alias in the dictionary key if defined.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A dictionary representation of the model.

model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

Generates a JSON representation of the model using Pydantic’s to_json method.

Parameters:

indent (int | None) – Indentation to use in the JSON output. If None is passed, the output will be compact.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to include in the JSON output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to exclude from the JSON output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to serialize using field aliases.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A JSON string representation of the model.

property model_extra: dict[str, Any] | None[source]

Get extra fields set during validation.

Returns:: A dictionary of extra fields, or None if config.extra is not set to "allow".

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=Solid2dAddHole, required=True), 'type': FieldInfo(annotation=Literal['solid2d_add_hole'], required=False, default='solid2d_add_hole')}[source]

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

property model_fields_set: set[str][source]

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,: i.e. that were not filled from defaults.

classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')[source]

Generates a JSON schema for a model class.

Parameters:

by_alias (bool) – Whether to use attribute aliases or not.
ref_template (str) – The reference template.
schema_generator (type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modifications
mode (Literal['validation', 'serialization']) – The mode in which to generate the schema.

Return type:

Returns:

The JSON schema for the given model class.

classmethod model_parametrized_name(params)[source]

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

Parameters:: params (tuple[type[Any], ...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.
Return type:: str
Returns:: String representing the new class where params are passed to cls as type variables.
Raises:: TypeError – Raised when trying to generate concrete names for non-generic models.

model_post_init(_BaseModel__context)[source]

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

Return type:: None

classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)[source]

Try to rebuild the pydantic-core schema for the model.

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.

Parameters:

force (bool) – Whether to force the rebuilding of the model schema, defaults to False.
raise_errors (bool) – Whether to raise errors, defaults to True.
_parent_namespace_depth (int) – The depth level of the parent namespace, defaults to 2.
_types_namespace (dict[str, Any] | None) – The types namespace, defaults to None.

Return type:

Returns:

Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.

classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)[source]

Validate a pydantic model instance.

Parameters:

obj (Any) – The object to validate.
strict (bool | None) – Whether to enforce types strictly.
from_attributes (bool | None) – Whether to extract data from object attributes.
context (Any | None) – Additional context to pass to the validator.

Raises:

ValidationError – If the object could not be validated.

Return type:

Self

Returns:

The validated model instance.

classmethod model_validate_json(json_data, *, strict=None, context=None)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing

Validate the given JSON data against the Pydantic model.

Parameters:

json_data (str | bytes | bytearray) – The JSON data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

Raises:

ValidationError – If json_data is not a JSON string or the object could not be validated.

classmethod model_validate_strings(obj, *, strict=None, context=None)[source]

Validate the given object with string data against the Pydantic model.

Parameters:

obj (Any) – The object containing string data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod parse_obj(obj)[source]

Return type:: Self

classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod schema(by_alias=True, ref_template='#/$defs/{model}')[source]

Return type:: Dict[str, Any]

classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)[source]

Return type:: str

type: Literal['solid2d_add_hole'][source]

classmethod update_forward_refs(**localns)[source]

Return type:: None

classmethod validate(value)[source]

Return type:: Self

class kittycad.models.ok_modeling_cmd_response.OptionSolid3DFilletEdge(**data)[source][source]

The response to the ‘Solid3dFilletEdge’ endpoint

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__abstractmethods__ = frozenset({})[source]

__annotations__ = {'__class_vars__': 'ClassVar[set[str]]', '__private_attributes__': 'ClassVar[Dict[str, ModelPrivateAttr]]', '__pydantic_complete__': 'ClassVar[bool]', '__pydantic_core_schema__': 'ClassVar[CoreSchema]', '__pydantic_custom_init__': 'ClassVar[bool]', '__pydantic_decorators__': 'ClassVar[_decorators.DecoratorInfos]', '__pydantic_extra__': 'dict[str, Any] | None', '__pydantic_fields_set__': 'set[str]', '__pydantic_generic_metadata__': 'ClassVar[_generics.PydanticGenericMetadata]', '__pydantic_parent_namespace__': 'ClassVar[Dict[str, Any] | None]', '__pydantic_post_init__': "ClassVar[None | Literal['model_post_init']]", '__pydantic_private__': 'dict[str, Any] | None', '__pydantic_root_model__': 'ClassVar[bool]', '__pydantic_serializer__': 'ClassVar[SchemaSerializer]', '__pydantic_validator__': 'ClassVar[SchemaValidator | PluggableSchemaValidator]', '__signature__': 'ClassVar[Signature]', 'data': <class 'kittycad.models.solid3d_fillet_edge.Solid3dFilletEdge'>, 'model_computed_fields': 'ClassVar[Dict[str, ComputedFieldInfo]]', 'model_config': 'ClassVar[ConfigDict]', 'model_fields': 'ClassVar[Dict[str, FieldInfo]]', 'type': typing.Literal['solid3d_fillet_edge']}[source]

classmethod __class_getitem__(typevar_values)[source]

Return type:: type[BaseModel] | PydanticRecursiveRef

__class_vars__: ClassVar[set[str]] = {}[source]: The names of the class variables defined on the model.

__copy__()[source]

Returns a shallow copy of the model.

Return type:: Self

__deepcopy__(memo=None)[source]

Returns a deep copy of the model.

Return type:: Self

__delattr__(item)[source]

Implement delattr(self, name).

Return type:: Any

__dict__[source]

__eq__(other)[source]

Return self==value.

Return type:: bool

property __fields_set__: set[str][source]

classmethod __get_pydantic_core_schema__(source, handler, /)[source]

Hook into generating the model’s CoreSchema.

Parameters:

source (type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.
handler (GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.

Return type:

Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]

Returns:

A pydantic-core CoreSchema.

classmethod __get_pydantic_json_schema__(core_schema, handler, /)[source]

Hook into generating the model’s JSON schema.

Parameters:

core_schema (Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({'type': 'nullable', 'schema': current_schema}), or just call the handler with the original schema.
handler (GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.

Return type:

Returns:

A JSON schema, as a Python object.

__getattr__(item)[source]

Return type:: Any

__getstate__()[source]

Helper for pickle.

Return type:: dict[Any, Any]

__hash__ = None[source]

__init__(**data)[source]

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__iter__()[source]

So dict(model) works.

Return type:: Generator[Tuple[str, Any], None, None]

__module__ = 'kittycad.models.ok_modeling_cmd_response'[source]

__pretty__(fmt, **kwargs)[source]

Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.

Return type:: Generator[Any, None, None]

__private_attributes__: ClassVar[Dict[str, ModelPrivateAttr]] = {}[source]: Metadata about the private attributes of the model.

__pydantic_complete__: ClassVar[bool] = True[source]: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__: ClassVar[CoreSchema] = {'cls': <class 'kittycad.models.ok_modeling_cmd_response.OptionSolid3DFilletEdge'>, 'config': {'title': 'OptionSolid3DFilletEdge'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.ok_modeling_cmd_response.OptionSolid3DFilletEdge'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.ok_modeling_cmd_response.OptionSolid3DFilletEdge'>>]}, 'ref': 'kittycad.models.ok_modeling_cmd_response.OptionSolid3DFilletEdge:94667212943600', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'data': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.solid3d_fillet_edge.Solid3dFilletEdge'>, 'config': {'title': 'Solid3dFilletEdge'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.solid3d_fillet_edge.Solid3dFilletEdge'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.solid3d_fillet_edge.Solid3dFilletEdge'>>]}, 'ref': 'kittycad.models.solid3d_fillet_edge.Solid3dFilletEdge:94667212441584', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {}, 'model_name': 'Solid3dFilletEdge', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}, 'type': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': 'solid3d_fillet_edge', 'schema': {'expected': ['solid3d_fillet_edge'], 'type': 'literal'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'OptionSolid3DFilletEdge', 'type': 'model-fields'}, 'type': 'model'}[source]: The core schema of the model.

__pydantic_custom_init__: ClassVar[bool] = False[source]: Whether the model has a custom __init__ method.

__pydantic_decorators__: ClassVar[_decorators.DecoratorInfos] = DecoratorInfos(validators={}, field_validators={}, root_validators={}, field_serializers={}, model_serializers={}, model_validators={}, computed_fields={})[source]: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_extra__: dict[str, Any] | None[source]: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to 'allow'.

__pydantic_fields_set__: set[str][source]: The names of fields explicitly set during instantiation.

__pydantic_generic_metadata__: ClassVar[_generics.PydanticGenericMetadata] = {'args': (), 'origin': None, 'parameters': ()}[source]: 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.

classmethod __pydantic_init_subclass__(**kwargs)[source]

This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.

This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.

This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.

Parameters:: **kwargs (Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.
Return type:: None

__pydantic_parent_namespace__: ClassVar[Dict[str, Any] | None] = None[source]: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__: ClassVar[None | Literal['model_post_init']] = None[source]: The name of the post-init method for the model, if defined.

__pydantic_private__: dict[str, Any] | None[source]: Values of private attributes set on the model instance.

__pydantic_root_model__: ClassVar[bool] = False[source]: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__: ClassVar[SchemaSerializer] = SchemaSerializer(serializer=Model( ModelSerializer { class: Py( 0x000056196d9970f0, ), serializer: Fields( GeneralFieldsSerializer { fields: { "type": SerField { key_py: Py( 0x00007f903823d958, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f90346e69b0, ), ), serializer: Literal( LiteralSerializer { expected_int: {}, expected_str: { "solid3d_fillet_edge", }, expected_py: None, name: "literal['solid3d_fillet_edge']", }, ), }, ), ), required: true, }, "data": SerField { key_py: Py( 0x00007f9038238fa0, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196d91c7f0, ), serializer: Fields( GeneralFieldsSerializer { fields: {}, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 0, }, ), has_extra: false, root_model: false, name: "Solid3dFilletEdge", }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "OptionSolid3DFilletEdge", }, ), definitions=[])[source]: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__: ClassVar[SchemaValidator | PluggableSchemaValidator] = SchemaValidator(title="OptionSolid3DFilletEdge", validator=Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "data", lookup_key: Simple { key: "data", py_key: Py( 0x00007f90334d6070, ), path: LookupPath( [ S( "data", Py( 0x00007f90334d60a0, ), ), ], ), }, name_py: Py( 0x00007f9038238fa0, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [], model_name: "Solid3dFilletEdge", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d91c7f0, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "Solid3dFilletEdge", }, ), frozen: false, }, Field { name: "type", lookup_key: Simple { key: "type", py_key: Py( 0x00007f90334d60d0, ), path: LookupPath( [ S( "type", Py( 0x00007f90334d6100, ), ), ], ), }, name_py: Py( 0x00007f903823d958, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f90346e69b0, ), ), on_error: Raise, validator: Literal( LiteralValidator { lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "solid3d_fillet_edge": 0, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f90346e69b0, ), ], }, expected_repr: "'solid3d_fillet_edge'", name: "literal['solid3d_fillet_edge']", }, ), validate_default: false, copy_default: false, name: "default[literal['solid3d_fillet_edge']]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "OptionSolid3DFilletEdge", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d9970f0, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "OptionSolid3DFilletEdge", }, ), definitions=[], cache_strings=True)[source]: The pydantic-core SchemaValidator used to validate instances of the model.

__repr__()[source]

Return repr(self).

Return type:: str

__repr_args__()[source]

Return type:: Iterable[tuple[str | None, Any]]

__repr_name__()[source]

Name of the instance’s class, used in __repr__.

Return type:: str

__repr_str__(join_str)[source]

Return type:: str

__rich_repr__()[source]

Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.

Return type:: Iterable[Any | tuple[Any] | tuple[str, Any] | tuple[str, Any, Any]]

__setattr__(name, value)[source]

Implement setattr(self, name, value).

Return type:: None

__setstate__(state)[source]

Return type:: None

__signature__: ClassVar[Signature] = <Signature (*, data: kittycad.models.solid3d_fillet_edge.Solid3dFilletEdge, type: Literal['solid3d_fillet_edge'] = 'solid3d_fillet_edge') -> None>[source]: The synthesized __init__ [Signature][inspect.Signature] of the model.

__slots__ = ('__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__')[source]

__str__()[source]

Return str(self).

Return type:: str

_abc_impl = <_abc._abc_data object>[source]

_calculate_keys(*args, **kwargs)[source]

Return type:: Any

_check_frozen(name, value)[source]

Return type:: None

_copy_and_set_values(*args, **kwargs)[source]

Return type:: Any

classmethod _get_value(*args, **kwargs)[source]

Return type:: Any

_iter(*args, **kwargs)[source]

Return type:: Any

classmethod construct(_fields_set=None, **values)[source]

Return type:: Self

copy(*, include=None, exclude=None, update=None, deep=False)[source]

Returns a copy of the model.

!!! warning “Deprecated”: This method is now deprecated; use model_copy instead.

If you need include or exclude, use:

`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `

Parameters:

include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.

Returns:

A copy of the model with included, excluded and updated fields as specified.

data: Solid3dFilletEdge[source]

dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)[source]

Return type:: Dict[str, Any]

classmethod from_orm(obj)[source]

Return type:: Self

json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)[source]

Return type:: str

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}[source]: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'protected_namespaces': ()}[source]: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod model_construct(_fields_set=None, **values)[source]

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note: model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == 'allow', then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == 'ignore' (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == 'forbid' does not result in an error if extra values are passed, but they will be ignored.

Parameters:

_fields_set (set[str] | None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.
values (Any) – Trusted or pre-validated data dictionary.

Return type:

Self

Returns:

A new instance of the Model class with validated data.

model_copy(*, update=None, deep=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy

Returns a copy of the model.

Parameters:

update (dict[str, Any] | None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.
deep (bool) – Set to True to make a deep copy of the model.

Return type:

Self

Returns:

New model instance.

model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters:

mode (Union[Literal['json', 'python'], str]) – The mode in which to_python 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.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to include in the output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to exclude from the output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to use the field’s alias in the dictionary key if defined.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A dictionary representation of the model.

model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

Generates a JSON representation of the model using Pydantic’s to_json method.

Parameters:

indent (int | None) – Indentation to use in the JSON output. If None is passed, the output will be compact.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to include in the JSON output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to exclude from the JSON output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to serialize using field aliases.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A JSON string representation of the model.

property model_extra: dict[str, Any] | None[source]

Get extra fields set during validation.

Returns:: A dictionary of extra fields, or None if config.extra is not set to "allow".

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=Solid3dFilletEdge, required=True), 'type': FieldInfo(annotation=Literal['solid3d_fillet_edge'], required=False, default='solid3d_fillet_edge')}[source]

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

property model_fields_set: set[str][source]

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,: i.e. that were not filled from defaults.

classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')[source]

Generates a JSON schema for a model class.

Parameters:

by_alias (bool) – Whether to use attribute aliases or not.
ref_template (str) – The reference template.
schema_generator (type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modifications
mode (Literal['validation', 'serialization']) – The mode in which to generate the schema.

Return type:

Returns:

The JSON schema for the given model class.

classmethod model_parametrized_name(params)[source]

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

Parameters:: params (tuple[type[Any], ...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.
Return type:: str
Returns:: String representing the new class where params are passed to cls as type variables.
Raises:: TypeError – Raised when trying to generate concrete names for non-generic models.

model_post_init(_BaseModel__context)[source]

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

Return type:: None

classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)[source]

Try to rebuild the pydantic-core schema for the model.

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.

Parameters:

force (bool) – Whether to force the rebuilding of the model schema, defaults to False.
raise_errors (bool) – Whether to raise errors, defaults to True.
_parent_namespace_depth (int) – The depth level of the parent namespace, defaults to 2.
_types_namespace (dict[str, Any] | None) – The types namespace, defaults to None.

Return type:

Returns:

Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.

classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)[source]

Validate a pydantic model instance.

Parameters:

obj (Any) – The object to validate.
strict (bool | None) – Whether to enforce types strictly.
from_attributes (bool | None) – Whether to extract data from object attributes.
context (Any | None) – Additional context to pass to the validator.

Raises:

ValidationError – If the object could not be validated.

Return type:

Self

Returns:

The validated model instance.

classmethod model_validate_json(json_data, *, strict=None, context=None)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing

Validate the given JSON data against the Pydantic model.

Parameters:

json_data (str | bytes | bytearray) – The JSON data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

Raises:

ValidationError – If json_data is not a JSON string or the object could not be validated.

classmethod model_validate_strings(obj, *, strict=None, context=None)[source]

Validate the given object with string data against the Pydantic model.

Parameters:

obj (Any) – The object containing string data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod parse_obj(obj)[source]

Return type:: Self

classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod schema(by_alias=True, ref_template='#/$defs/{model}')[source]

Return type:: Dict[str, Any]

classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)[source]

Return type:: str

type: Literal['solid3d_fillet_edge'][source]

classmethod update_forward_refs(**localns)[source]

Return type:: None

classmethod validate(value)[source]

Return type:: Self

class kittycad.models.ok_modeling_cmd_response.OptionSolid3DGetAllEdgeFaces(**data)[source][source]

The response to the ‘Solid3dGetAllEdgeFaces’ endpoint

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__abstractmethods__ = frozenset({})[source]

__annotations__ = {'__class_vars__': 'ClassVar[set[str]]', '__private_attributes__': 'ClassVar[Dict[str, ModelPrivateAttr]]', '__pydantic_complete__': 'ClassVar[bool]', '__pydantic_core_schema__': 'ClassVar[CoreSchema]', '__pydantic_custom_init__': 'ClassVar[bool]', '__pydantic_decorators__': 'ClassVar[_decorators.DecoratorInfos]', '__pydantic_extra__': 'dict[str, Any] | None', '__pydantic_fields_set__': 'set[str]', '__pydantic_generic_metadata__': 'ClassVar[_generics.PydanticGenericMetadata]', '__pydantic_parent_namespace__': 'ClassVar[Dict[str, Any] | None]', '__pydantic_post_init__': "ClassVar[None | Literal['model_post_init']]", '__pydantic_private__': 'dict[str, Any] | None', '__pydantic_root_model__': 'ClassVar[bool]', '__pydantic_serializer__': 'ClassVar[SchemaSerializer]', '__pydantic_validator__': 'ClassVar[SchemaValidator | PluggableSchemaValidator]', '__signature__': 'ClassVar[Signature]', 'data': <class 'kittycad.models.solid3d_get_all_edge_faces.Solid3dGetAllEdgeFaces'>, 'model_computed_fields': 'ClassVar[Dict[str, ComputedFieldInfo]]', 'model_config': 'ClassVar[ConfigDict]', 'model_fields': 'ClassVar[Dict[str, FieldInfo]]', 'type': typing.Literal['solid3d_get_all_edge_faces']}[source]

classmethod __class_getitem__(typevar_values)[source]

Return type:: type[BaseModel] | PydanticRecursiveRef

__class_vars__: ClassVar[set[str]] = {}[source]: The names of the class variables defined on the model.

__copy__()[source]

Returns a shallow copy of the model.

Return type:: Self

__deepcopy__(memo=None)[source]

Returns a deep copy of the model.

Return type:: Self

__delattr__(item)[source]

Implement delattr(self, name).

Return type:: Any

__dict__[source]

__eq__(other)[source]

Return self==value.

Return type:: bool

property __fields_set__: set[str][source]

classmethod __get_pydantic_core_schema__(source, handler, /)[source]

Hook into generating the model’s CoreSchema.

Parameters:

source (type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.
handler (GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.

Return type:

Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]

Returns:

A pydantic-core CoreSchema.

classmethod __get_pydantic_json_schema__(core_schema, handler, /)[source]

Hook into generating the model’s JSON schema.

Parameters:

core_schema (Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({'type': 'nullable', 'schema': current_schema}), or just call the handler with the original schema.
handler (GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.

Return type:

Returns:

A JSON schema, as a Python object.

__getattr__(item)[source]

Return type:: Any

__getstate__()[source]

Helper for pickle.

Return type:: dict[Any, Any]

__hash__ = None[source]

__init__(**data)[source]

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__iter__()[source]

So dict(model) works.

Return type:: Generator[Tuple[str, Any], None, None]

__module__ = 'kittycad.models.ok_modeling_cmd_response'[source]

__pretty__(fmt, **kwargs)[source]

Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.

Return type:: Generator[Any, None, None]

__private_attributes__: ClassVar[Dict[str, ModelPrivateAttr]] = {}[source]: Metadata about the private attributes of the model.

__pydantic_complete__: ClassVar[bool] = True[source]: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__: ClassVar[CoreSchema] = {'cls': <class 'kittycad.models.ok_modeling_cmd_response.OptionSolid3DGetAllEdgeFaces'>, 'config': {'title': 'OptionSolid3DGetAllEdgeFaces'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.ok_modeling_cmd_response.OptionSolid3DGetAllEdgeFaces'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.ok_modeling_cmd_response.OptionSolid3DGetAllEdgeFaces'>>]}, 'ref': 'kittycad.models.ok_modeling_cmd_response.OptionSolid3DGetAllEdgeFaces:94667213586176', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'data': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.solid3d_get_all_edge_faces.Solid3dGetAllEdgeFaces'>, 'config': {'title': 'Solid3dGetAllEdgeFaces'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.solid3d_get_all_edge_faces.Solid3dGetAllEdgeFaces'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.solid3d_get_all_edge_faces.Solid3dGetAllEdgeFaces'>>]}, 'ref': 'kittycad.models.solid3d_get_all_edge_faces.Solid3dGetAllEdgeFaces:94667212444832', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'faces': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'items_schema': {'type': 'str'}, 'type': 'list'}, 'type': 'model-field'}}, 'model_name': 'Solid3dGetAllEdgeFaces', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}, 'type': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': 'solid3d_get_all_edge_faces', 'schema': {'expected': ['solid3d_get_all_edge_faces'], 'type': 'literal'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'OptionSolid3DGetAllEdgeFaces', 'type': 'model-fields'}, 'type': 'model'}[source]: The core schema of the model.

__pydantic_custom_init__: ClassVar[bool] = False[source]: Whether the model has a custom __init__ method.

__pydantic_decorators__: ClassVar[_decorators.DecoratorInfos] = DecoratorInfos(validators={}, field_validators={}, root_validators={}, field_serializers={}, model_serializers={}, model_validators={}, computed_fields={})[source]: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_extra__: dict[str, Any] | None[source]: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to 'allow'.

__pydantic_fields_set__: set[str][source]: The names of fields explicitly set during instantiation.

__pydantic_generic_metadata__: ClassVar[_generics.PydanticGenericMetadata] = {'args': (), 'origin': None, 'parameters': ()}[source]: 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.

classmethod __pydantic_init_subclass__(**kwargs)[source]

This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.

This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.

This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.

Parameters:: **kwargs (Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.
Return type:: None

__pydantic_parent_namespace__: ClassVar[Dict[str, Any] | None] = None[source]: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__: ClassVar[None | Literal['model_post_init']] = None[source]: The name of the post-init method for the model, if defined.

__pydantic_private__: dict[str, Any] | None[source]: Values of private attributes set on the model instance.

__pydantic_root_model__: ClassVar[bool] = False[source]: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__: ClassVar[SchemaSerializer] = SchemaSerializer(serializer=Model( ModelSerializer { class: Py( 0x000056196da33f00, ), serializer: Fields( GeneralFieldsSerializer { fields: { "data": SerField { key_py: Py( 0x00007f9038238fa0, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196d91d4a0, ), serializer: Fields( GeneralFieldsSerializer { fields: { "faces": SerField { key_py: Py( 0x00007f9033500660, ), alias: None, alias_py: None, serializer: Some( List( ListSerializer { item_serializer: Str( StrSerializer, ), filter: SchemaFilter { include: None, exclude: None, }, name: "list[str]", }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 1, }, ), has_extra: false, root_model: false, name: "Solid3dGetAllEdgeFaces", }, ), ), required: true, }, "type": SerField { key_py: Py( 0x00007f903823d958, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f9034697b40, ), ), serializer: Literal( LiteralSerializer { expected_int: {}, expected_str: { "solid3d_get_all_edge_faces", }, expected_py: None, name: "literal['solid3d_get_all_edge_faces']", }, ), }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "OptionSolid3DGetAllEdgeFaces", }, ), definitions=[])[source]: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__: ClassVar[SchemaValidator | PluggableSchemaValidator] = SchemaValidator(title="OptionSolid3DGetAllEdgeFaces", validator=Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "data", lookup_key: Simple { key: "data", py_key: Py( 0x00007f903336e070, ), path: LookupPath( [ S( "data", Py( 0x00007f903336e0a0, ), ), ], ), }, name_py: Py( 0x00007f9038238fa0, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "faces", lookup_key: Simple { key: "faces", py_key: Py( 0x00007f903336e010, ), path: LookupPath( [ S( "faces", Py( 0x00007f903336e040, ), ), ], ), }, name_py: Py( 0x00007f9033500660, ), validator: List( ListValidator { strict: false, item_validator: Some( Str( StrValidator { strict: false, coerce_numbers_to_str: false, }, ), ), min_length: None, max_length: None, name: OnceLock( <uninit>, ), fail_fast: false, }, ), frozen: false, }, ], model_name: "Solid3dGetAllEdgeFaces", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d91d4a0, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "Solid3dGetAllEdgeFaces", }, ), frozen: false, }, Field { name: "type", lookup_key: Simple { key: "type", py_key: Py( 0x00007f903336e0d0, ), path: LookupPath( [ S( "type", Py( 0x00007f903336e100, ), ), ], ), }, name_py: Py( 0x00007f903823d958, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f9034697b40, ), ), on_error: Raise, validator: Literal( LiteralValidator { lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "solid3d_get_all_edge_faces": 0, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f9034697b40, ), ], }, expected_repr: "'solid3d_get_all_edge_faces'", name: "literal['solid3d_get_all_edge_faces']", }, ), validate_default: false, copy_default: false, name: "default[literal['solid3d_get_all_edge_faces']]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "OptionSolid3DGetAllEdgeFaces", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196da33f00, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "OptionSolid3DGetAllEdgeFaces", }, ), definitions=[], cache_strings=True)[source]: The pydantic-core SchemaValidator used to validate instances of the model.

__repr__()[source]

Return repr(self).

Return type:: str

__repr_args__()[source]

Return type:: Iterable[tuple[str | None, Any]]

__repr_name__()[source]

Name of the instance’s class, used in __repr__.

Return type:: str

__repr_str__(join_str)[source]

Return type:: str

__rich_repr__()[source]

Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.

Return type:: Iterable[Any | tuple[Any] | tuple[str, Any] | tuple[str, Any, Any]]

__setattr__(name, value)[source]

Implement setattr(self, name, value).

Return type:: None

__setstate__(state)[source]

Return type:: None

__signature__: ClassVar[Signature] = <Signature (*, data: kittycad.models.solid3d_get_all_edge_faces.Solid3dGetAllEdgeFaces, type: Literal['solid3d_get_all_edge_faces'] = 'solid3d_get_all_edge_faces') -> None>[source]: The synthesized __init__ [Signature][inspect.Signature] of the model.

__slots__ = ('__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__')[source]

__str__()[source]

Return str(self).

Return type:: str

_abc_impl = <_abc._abc_data object>[source]

_calculate_keys(*args, **kwargs)[source]

Return type:: Any

_check_frozen(name, value)[source]

Return type:: None

_copy_and_set_values(*args, **kwargs)[source]

Return type:: Any

classmethod _get_value(*args, **kwargs)[source]

Return type:: Any

_iter(*args, **kwargs)[source]

Return type:: Any

classmethod construct(_fields_set=None, **values)[source]

Return type:: Self

copy(*, include=None, exclude=None, update=None, deep=False)[source]

Returns a copy of the model.

!!! warning “Deprecated”: This method is now deprecated; use model_copy instead.

If you need include or exclude, use:

`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `

Parameters:

include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.

Returns:

A copy of the model with included, excluded and updated fields as specified.

data: Solid3dGetAllEdgeFaces[source]

dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)[source]

Return type:: Dict[str, Any]

classmethod from_orm(obj)[source]

Return type:: Self

json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)[source]

Return type:: str

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}[source]: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'protected_namespaces': ()}[source]: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod model_construct(_fields_set=None, **values)[source]

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note: model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == 'allow', then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == 'ignore' (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == 'forbid' does not result in an error if extra values are passed, but they will be ignored.

Parameters:

_fields_set (set[str] | None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.
values (Any) – Trusted or pre-validated data dictionary.

Return type:

Self

Returns:

A new instance of the Model class with validated data.

model_copy(*, update=None, deep=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy

Returns a copy of the model.

Parameters:

update (dict[str, Any] | None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.
deep (bool) – Set to True to make a deep copy of the model.

Return type:

Self

Returns:

New model instance.

model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters:

mode (Union[Literal['json', 'python'], str]) – The mode in which to_python 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.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to include in the output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to exclude from the output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to use the field’s alias in the dictionary key if defined.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A dictionary representation of the model.

model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

Generates a JSON representation of the model using Pydantic’s to_json method.

Parameters:

indent (int | None) – Indentation to use in the JSON output. If None is passed, the output will be compact.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to include in the JSON output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to exclude from the JSON output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to serialize using field aliases.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A JSON string representation of the model.

property model_extra: dict[str, Any] | None[source]

Get extra fields set during validation.

Returns:: A dictionary of extra fields, or None if config.extra is not set to "allow".

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=Solid3dGetAllEdgeFaces, required=True), 'type': FieldInfo(annotation=Literal['solid3d_get_all_edge_faces'], required=False, default='solid3d_get_all_edge_faces')}[source]

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

property model_fields_set: set[str][source]

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,: i.e. that were not filled from defaults.

classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')[source]

Generates a JSON schema for a model class.

Parameters:

by_alias (bool) – Whether to use attribute aliases or not.
ref_template (str) – The reference template.
schema_generator (type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modifications
mode (Literal['validation', 'serialization']) – The mode in which to generate the schema.

Return type:

Returns:

The JSON schema for the given model class.

classmethod model_parametrized_name(params)[source]

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

Parameters:: params (tuple[type[Any], ...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.
Return type:: str
Returns:: String representing the new class where params are passed to cls as type variables.
Raises:: TypeError – Raised when trying to generate concrete names for non-generic models.

model_post_init(_BaseModel__context)[source]

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

Return type:: None

classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)[source]

Try to rebuild the pydantic-core schema for the model.

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.

Parameters:

force (bool) – Whether to force the rebuilding of the model schema, defaults to False.
raise_errors (bool) – Whether to raise errors, defaults to True.
_parent_namespace_depth (int) – The depth level of the parent namespace, defaults to 2.
_types_namespace (dict[str, Any] | None) – The types namespace, defaults to None.

Return type:

Returns:

Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.

classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)[source]

Validate a pydantic model instance.

Parameters:

obj (Any) – The object to validate.
strict (bool | None) – Whether to enforce types strictly.
from_attributes (bool | None) – Whether to extract data from object attributes.
context (Any | None) – Additional context to pass to the validator.

Raises:

ValidationError – If the object could not be validated.

Return type:

Self

Returns:

The validated model instance.

classmethod model_validate_json(json_data, *, strict=None, context=None)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing

Validate the given JSON data against the Pydantic model.

Parameters:

json_data (str | bytes | bytearray) – The JSON data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

Raises:

ValidationError – If json_data is not a JSON string or the object could not be validated.

classmethod model_validate_strings(obj, *, strict=None, context=None)[source]

Validate the given object with string data against the Pydantic model.

Parameters:

obj (Any) – The object containing string data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod parse_obj(obj)[source]

Return type:: Self

classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod schema(by_alias=True, ref_template='#/$defs/{model}')[source]

Return type:: Dict[str, Any]

classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)[source]

Return type:: str

type: Literal['solid3d_get_all_edge_faces'][source]

classmethod update_forward_refs(**localns)[source]

Return type:: None

classmethod validate(value)[source]

Return type:: Self

class kittycad.models.ok_modeling_cmd_response.OptionSolid3DGetAllOppositeEdges(**data)[source][source]

The response to the ‘Solid3dGetAllOppositeEdges’ endpoint

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__abstractmethods__ = frozenset({})[source]

__annotations__ = {'__class_vars__': 'ClassVar[set[str]]', '__private_attributes__': 'ClassVar[Dict[str, ModelPrivateAttr]]', '__pydantic_complete__': 'ClassVar[bool]', '__pydantic_core_schema__': 'ClassVar[CoreSchema]', '__pydantic_custom_init__': 'ClassVar[bool]', '__pydantic_decorators__': 'ClassVar[_decorators.DecoratorInfos]', '__pydantic_extra__': 'dict[str, Any] | None', '__pydantic_fields_set__': 'set[str]', '__pydantic_generic_metadata__': 'ClassVar[_generics.PydanticGenericMetadata]', '__pydantic_parent_namespace__': 'ClassVar[Dict[str, Any] | None]', '__pydantic_post_init__': "ClassVar[None | Literal['model_post_init']]", '__pydantic_private__': 'dict[str, Any] | None', '__pydantic_root_model__': 'ClassVar[bool]', '__pydantic_serializer__': 'ClassVar[SchemaSerializer]', '__pydantic_validator__': 'ClassVar[SchemaValidator | PluggableSchemaValidator]', '__signature__': 'ClassVar[Signature]', 'data': <class 'kittycad.models.solid3d_get_all_opposite_edges.Solid3dGetAllOppositeEdges'>, 'model_computed_fields': 'ClassVar[Dict[str, ComputedFieldInfo]]', 'model_config': 'ClassVar[ConfigDict]', 'model_fields': 'ClassVar[Dict[str, FieldInfo]]', 'type': typing.Literal['solid3d_get_all_opposite_edges']}[source]

classmethod __class_getitem__(typevar_values)[source]

Return type:: type[BaseModel] | PydanticRecursiveRef

__class_vars__: ClassVar[set[str]] = {}[source]: The names of the class variables defined on the model.

__copy__()[source]

Returns a shallow copy of the model.

Return type:: Self

__deepcopy__(memo=None)[source]

Returns a deep copy of the model.

Return type:: Self

__delattr__(item)[source]

Implement delattr(self, name).

Return type:: Any

__dict__[source]

__eq__(other)[source]

Return self==value.

Return type:: bool

property __fields_set__: set[str][source]

classmethod __get_pydantic_core_schema__(source, handler, /)[source]

Hook into generating the model’s CoreSchema.

Parameters:

source (type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.
handler (GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.

Return type:

Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]

Returns:

A pydantic-core CoreSchema.

classmethod __get_pydantic_json_schema__(core_schema, handler, /)[source]

Hook into generating the model’s JSON schema.

Parameters:

core_schema (Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({'type': 'nullable', 'schema': current_schema}), or just call the handler with the original schema.
handler (GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.

Return type:

Returns:

A JSON schema, as a Python object.

__getattr__(item)[source]

Return type:: Any

__getstate__()[source]

Helper for pickle.

Return type:: dict[Any, Any]

__hash__ = None[source]

__init__(**data)[source]

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__iter__()[source]

So dict(model) works.

Return type:: Generator[Tuple[str, Any], None, None]

__module__ = 'kittycad.models.ok_modeling_cmd_response'[source]

__pretty__(fmt, **kwargs)[source]

Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.

Return type:: Generator[Any, None, None]

__private_attributes__: ClassVar[Dict[str, ModelPrivateAttr]] = {}[source]: Metadata about the private attributes of the model.

__pydantic_complete__: ClassVar[bool] = True[source]: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__: ClassVar[CoreSchema] = {'cls': <class 'kittycad.models.ok_modeling_cmd_response.OptionSolid3DGetAllOppositeEdges'>, 'config': {'title': 'OptionSolid3DGetAllOppositeEdges'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.ok_modeling_cmd_response.OptionSolid3DGetAllOppositeEdges'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.ok_modeling_cmd_response.OptionSolid3DGetAllOppositeEdges'>>]}, 'ref': 'kittycad.models.ok_modeling_cmd_response.OptionSolid3DGetAllOppositeEdges:94667213598688', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'data': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.solid3d_get_all_opposite_edges.Solid3dGetAllOppositeEdges'>, 'config': {'title': 'Solid3dGetAllOppositeEdges'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.solid3d_get_all_opposite_edges.Solid3dGetAllOppositeEdges'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.solid3d_get_all_opposite_edges.Solid3dGetAllOppositeEdges'>>]}, 'ref': 'kittycad.models.solid3d_get_all_opposite_edges.Solid3dGetAllOppositeEdges:94667212534528', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'edges': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'items_schema': {'type': 'str'}, 'type': 'list'}, 'type': 'model-field'}}, 'model_name': 'Solid3dGetAllOppositeEdges', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}, 'type': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': 'solid3d_get_all_opposite_edges', 'schema': {'expected': ['solid3d_get_all_opposite_edges'], 'type': 'literal'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'OptionSolid3DGetAllOppositeEdges', 'type': 'model-fields'}, 'type': 'model'}[source]: The core schema of the model.

__pydantic_custom_init__: ClassVar[bool] = False[source]: Whether the model has a custom __init__ method.

__pydantic_decorators__: ClassVar[_decorators.DecoratorInfos] = DecoratorInfos(validators={}, field_validators={}, root_validators={}, field_serializers={}, model_serializers={}, model_validators={}, computed_fields={})[source]: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_extra__: dict[str, Any] | None[source]: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to 'allow'.

__pydantic_fields_set__: set[str][source]: The names of fields explicitly set during instantiation.

__pydantic_generic_metadata__: ClassVar[_generics.PydanticGenericMetadata] = {'args': (), 'origin': None, 'parameters': ()}[source]: 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.

classmethod __pydantic_init_subclass__(**kwargs)[source]

This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.

This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.

This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.

Parameters:: **kwargs (Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.
Return type:: None

__pydantic_parent_namespace__: ClassVar[Dict[str, Any] | None] = None[source]: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__: ClassVar[None | Literal['model_post_init']] = None[source]: The name of the post-init method for the model, if defined.

__pydantic_private__: dict[str, Any] | None[source]: Values of private attributes set on the model instance.

__pydantic_root_model__: ClassVar[bool] = False[source]: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__: ClassVar[SchemaSerializer] = SchemaSerializer(serializer=Model( ModelSerializer { class: Py( 0x000056196da36fe0, ), serializer: Fields( GeneralFieldsSerializer { fields: { "data": SerField { key_py: Py( 0x00007f9038238fa0, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196d933300, ), serializer: Fields( GeneralFieldsSerializer { fields: { "edges": SerField { key_py: Py( 0x00007f903822a3a0, ), alias: None, alias_py: None, serializer: Some( List( ListSerializer { item_serializer: Str( StrSerializer, ), filter: SchemaFilter { include: None, exclude: None, }, name: "list[str]", }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 1, }, ), has_extra: false, root_model: false, name: "Solid3dGetAllOppositeEdges", }, ), ), required: true, }, "type": SerField { key_py: Py( 0x00007f903823d958, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f9034697b90, ), ), serializer: Literal( LiteralSerializer { expected_int: {}, expected_str: { "solid3d_get_all_opposite_edges", }, expected_py: None, name: "literal['solid3d_get_all_opposite_edges']", }, ), }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "OptionSolid3DGetAllOppositeEdges", }, ), definitions=[])[source]: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__: ClassVar[SchemaValidator | PluggableSchemaValidator] = SchemaValidator(title="OptionSolid3DGetAllOppositeEdges", validator=Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "data", lookup_key: Simple { key: "data", py_key: Py( 0x00007f903336d890, ), path: LookupPath( [ S( "data", Py( 0x00007f903336d860, ), ), ], ), }, name_py: Py( 0x00007f9038238fa0, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "edges", lookup_key: Simple { key: "edges", py_key: Py( 0x00007f903336d770, ), path: LookupPath( [ S( "edges", Py( 0x00007f903336d740, ), ), ], ), }, name_py: Py( 0x00007f903822a3a0, ), validator: List( ListValidator { strict: false, item_validator: Some( Str( StrValidator { strict: false, coerce_numbers_to_str: false, }, ), ), min_length: None, max_length: None, name: OnceLock( <uninit>, ), fail_fast: false, }, ), frozen: false, }, ], model_name: "Solid3dGetAllOppositeEdges", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d933300, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "Solid3dGetAllOppositeEdges", }, ), frozen: false, }, Field { name: "type", lookup_key: Simple { key: "type", py_key: Py( 0x00007f903336d800, ), path: LookupPath( [ S( "type", Py( 0x00007f903336d7d0, ), ), ], ), }, name_py: Py( 0x00007f903823d958, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f9034697b90, ), ), on_error: Raise, validator: Literal( LiteralValidator { lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "solid3d_get_all_opposite_edges": 0, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f9034697b90, ), ], }, expected_repr: "'solid3d_get_all_opposite_edges'", name: "literal['solid3d_get_all_opposite_edges']", }, ), validate_default: false, copy_default: false, name: "default[literal['solid3d_get_all_opposite_edges']]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "OptionSolid3DGetAllOppositeEdges", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196da36fe0, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "OptionSolid3DGetAllOppositeEdges", }, ), definitions=[], cache_strings=True)[source]: The pydantic-core SchemaValidator used to validate instances of the model.

__repr__()[source]

Return repr(self).

Return type:: str

__repr_args__()[source]

Return type:: Iterable[tuple[str | None, Any]]

__repr_name__()[source]

Name of the instance’s class, used in __repr__.

Return type:: str

__repr_str__(join_str)[source]

Return type:: str

__rich_repr__()[source]

Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.

Return type:: Iterable[Any | tuple[Any] | tuple[str, Any] | tuple[str, Any, Any]]

__setattr__(name, value)[source]

Implement setattr(self, name, value).

Return type:: None

__setstate__(state)[source]

Return type:: None

__signature__: ClassVar[Signature] = <Signature (*, data: kittycad.models.solid3d_get_all_opposite_edges.Solid3dGetAllOppositeEdges, type: Literal['solid3d_get_all_opposite_edges'] = 'solid3d_get_all_opposite_edges') -> None>[source]: The synthesized __init__ [Signature][inspect.Signature] of the model.

__slots__ = ('__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__')[source]

__str__()[source]

Return str(self).

Return type:: str

_abc_impl = <_abc._abc_data object>[source]

_calculate_keys(*args, **kwargs)[source]

Return type:: Any

_check_frozen(name, value)[source]

Return type:: None

_copy_and_set_values(*args, **kwargs)[source]

Return type:: Any

classmethod _get_value(*args, **kwargs)[source]

Return type:: Any

_iter(*args, **kwargs)[source]

Return type:: Any

classmethod construct(_fields_set=None, **values)[source]

Return type:: Self

copy(*, include=None, exclude=None, update=None, deep=False)[source]

Returns a copy of the model.

!!! warning “Deprecated”: This method is now deprecated; use model_copy instead.

If you need include or exclude, use:

`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `

Parameters:

include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.

Returns:

A copy of the model with included, excluded and updated fields as specified.

data: Solid3dGetAllOppositeEdges[source]

dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)[source]

Return type:: Dict[str, Any]

classmethod from_orm(obj)[source]

Return type:: Self

json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)[source]

Return type:: str

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}[source]: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'protected_namespaces': ()}[source]: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod model_construct(_fields_set=None, **values)[source]

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note: model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == 'allow', then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == 'ignore' (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == 'forbid' does not result in an error if extra values are passed, but they will be ignored.

Parameters:

_fields_set (set[str] | None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.
values (Any) – Trusted or pre-validated data dictionary.

Return type:

Self

Returns:

A new instance of the Model class with validated data.

model_copy(*, update=None, deep=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy

Returns a copy of the model.

Parameters:

update (dict[str, Any] | None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.
deep (bool) – Set to True to make a deep copy of the model.

Return type:

Self

Returns:

New model instance.

model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters:

mode (Union[Literal['json', 'python'], str]) – The mode in which to_python 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.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to include in the output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to exclude from the output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to use the field’s alias in the dictionary key if defined.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A dictionary representation of the model.

model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

Generates a JSON representation of the model using Pydantic’s to_json method.

Parameters:

indent (int | None) – Indentation to use in the JSON output. If None is passed, the output will be compact.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to include in the JSON output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to exclude from the JSON output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to serialize using field aliases.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A JSON string representation of the model.

property model_extra: dict[str, Any] | None[source]

Get extra fields set during validation.

Returns:: A dictionary of extra fields, or None if config.extra is not set to "allow".

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=Solid3dGetAllOppositeEdges, required=True), 'type': FieldInfo(annotation=Literal['solid3d_get_all_opposite_edges'], required=False, default='solid3d_get_all_opposite_edges')}[source]

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

property model_fields_set: set[str][source]

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,: i.e. that were not filled from defaults.

classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')[source]

Generates a JSON schema for a model class.

Parameters:

by_alias (bool) – Whether to use attribute aliases or not.
ref_template (str) – The reference template.
schema_generator (type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modifications
mode (Literal['validation', 'serialization']) – The mode in which to generate the schema.

Return type:

Returns:

The JSON schema for the given model class.

classmethod model_parametrized_name(params)[source]

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

Parameters:: params (tuple[type[Any], ...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.
Return type:: str
Returns:: String representing the new class where params are passed to cls as type variables.
Raises:: TypeError – Raised when trying to generate concrete names for non-generic models.

model_post_init(_BaseModel__context)[source]

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

Return type:: None

classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)[source]

Try to rebuild the pydantic-core schema for the model.

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.

Parameters:

force (bool) – Whether to force the rebuilding of the model schema, defaults to False.
raise_errors (bool) – Whether to raise errors, defaults to True.
_parent_namespace_depth (int) – The depth level of the parent namespace, defaults to 2.
_types_namespace (dict[str, Any] | None) – The types namespace, defaults to None.

Return type:

Returns:

Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.

classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)[source]

Validate a pydantic model instance.

Parameters:

obj (Any) – The object to validate.
strict (bool | None) – Whether to enforce types strictly.
from_attributes (bool | None) – Whether to extract data from object attributes.
context (Any | None) – Additional context to pass to the validator.

Raises:

ValidationError – If the object could not be validated.

Return type:

Self

Returns:

The validated model instance.

classmethod model_validate_json(json_data, *, strict=None, context=None)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing

Validate the given JSON data against the Pydantic model.

Parameters:

json_data (str | bytes | bytearray) – The JSON data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

Raises:

ValidationError – If json_data is not a JSON string or the object could not be validated.

classmethod model_validate_strings(obj, *, strict=None, context=None)[source]

Validate the given object with string data against the Pydantic model.

Parameters:

obj (Any) – The object containing string data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod parse_obj(obj)[source]

Return type:: Self

classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod schema(by_alias=True, ref_template='#/$defs/{model}')[source]

Return type:: Dict[str, Any]

classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)[source]

Return type:: str

type: Literal['solid3d_get_all_opposite_edges'][source]

classmethod update_forward_refs(**localns)[source]

Return type:: None

classmethod validate(value)[source]

Return type:: Self

class kittycad.models.ok_modeling_cmd_response.OptionSolid3DGetExtrusionFaceInfo(**data)[source][source]

The response to the ‘Solid3dGetExtrusionFaceInfo’ endpoint

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__abstractmethods__ = frozenset({})[source]

__annotations__ = {'__class_vars__': 'ClassVar[set[str]]', '__private_attributes__': 'ClassVar[Dict[str, ModelPrivateAttr]]', '__pydantic_complete__': 'ClassVar[bool]', '__pydantic_core_schema__': 'ClassVar[CoreSchema]', '__pydantic_custom_init__': 'ClassVar[bool]', '__pydantic_decorators__': 'ClassVar[_decorators.DecoratorInfos]', '__pydantic_extra__': 'dict[str, Any] | None', '__pydantic_fields_set__': 'set[str]', '__pydantic_generic_metadata__': 'ClassVar[_generics.PydanticGenericMetadata]', '__pydantic_parent_namespace__': 'ClassVar[Dict[str, Any] | None]', '__pydantic_post_init__': "ClassVar[None | Literal['model_post_init']]", '__pydantic_private__': 'dict[str, Any] | None', '__pydantic_root_model__': 'ClassVar[bool]', '__pydantic_serializer__': 'ClassVar[SchemaSerializer]', '__pydantic_validator__': 'ClassVar[SchemaValidator | PluggableSchemaValidator]', '__signature__': 'ClassVar[Signature]', 'data': <class 'kittycad.models.solid3d_get_extrusion_face_info.Solid3dGetExtrusionFaceInfo'>, 'model_computed_fields': 'ClassVar[Dict[str, ComputedFieldInfo]]', 'model_config': 'ClassVar[ConfigDict]', 'model_fields': 'ClassVar[Dict[str, FieldInfo]]', 'type': typing.Literal['solid3d_get_extrusion_face_info']}[source]

classmethod __class_getitem__(typevar_values)[source]

Return type:: type[BaseModel] | PydanticRecursiveRef

__class_vars__: ClassVar[set[str]] = {}[source]: The names of the class variables defined on the model.

__copy__()[source]

Returns a shallow copy of the model.

Return type:: Self

__deepcopy__(memo=None)[source]

Returns a deep copy of the model.

Return type:: Self

__delattr__(item)[source]

Implement delattr(self, name).

Return type:: Any

__dict__[source]

__eq__(other)[source]

Return self==value.

Return type:: bool

property __fields_set__: set[str][source]

classmethod __get_pydantic_core_schema__(source, handler, /)[source]

Hook into generating the model’s CoreSchema.

Parameters:

source (type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.
handler (GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.

Return type:

Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]

Returns:

A pydantic-core CoreSchema.

classmethod __get_pydantic_json_schema__(core_schema, handler, /)[source]

Hook into generating the model’s JSON schema.

Parameters:

core_schema (Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({'type': 'nullable', 'schema': current_schema}), or just call the handler with the original schema.
handler (GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.

Return type:

Returns:

A JSON schema, as a Python object.

__getattr__(item)[source]

Return type:: Any

__getstate__()[source]

Helper for pickle.

Return type:: dict[Any, Any]

__hash__ = None[source]

__init__(**data)[source]

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__iter__()[source]

So dict(model) works.

Return type:: Generator[Tuple[str, Any], None, None]

__module__ = 'kittycad.models.ok_modeling_cmd_response'[source]

__pretty__(fmt, **kwargs)[source]

Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.

Return type:: Generator[Any, None, None]

__private_attributes__: ClassVar[Dict[str, ModelPrivateAttr]] = {}[source]: Metadata about the private attributes of the model.

__pydantic_complete__: ClassVar[bool] = True[source]: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__: ClassVar[CoreSchema] = {'cls': <class 'kittycad.models.ok_modeling_cmd_response.OptionSolid3DGetExtrusionFaceInfo'>, 'config': {'title': 'OptionSolid3DGetExtrusionFaceInfo'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.ok_modeling_cmd_response.OptionSolid3DGetExtrusionFaceInfo'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.ok_modeling_cmd_response.OptionSolid3DGetExtrusionFaceInfo'>>]}, 'ref': 'kittycad.models.ok_modeling_cmd_response.OptionSolid3DGetExtrusionFaceInfo:94667214090064', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'data': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.solid3d_get_extrusion_face_info.Solid3dGetExtrusionFaceInfo'>, 'config': {'title': 'Solid3dGetExtrusionFaceInfo'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.solid3d_get_extrusion_face_info.Solid3dGetExtrusionFaceInfo'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.solid3d_get_extrusion_face_info.Solid3dGetExtrusionFaceInfo'>>]}, 'ref': 'kittycad.models.solid3d_get_extrusion_face_info.Solid3dGetExtrusionFaceInfo:94667212540000', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'faces': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'items_schema': {'cls': <class 'kittycad.models.extrusion_face_info.ExtrusionFaceInfo'>, 'config': {'title': 'ExtrusionFaceInfo'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.extrusion_face_info.ExtrusionFaceInfo'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.extrusion_face_info.ExtrusionFaceInfo'>>]}, 'ref': 'kittycad.models.extrusion_face_info.ExtrusionFaceInfo:94667206504032', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'cap': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <enum 'ExtrusionFaceCapType'>, 'members': [ExtrusionFaceCapType.NONE, ExtrusionFaceCapType.TOP, ExtrusionFaceCapType.BOTTOM], 'metadata': {'pydantic_js_functions': [<function GenerateSchema._enum_schema.<locals>.get_json_schema>]}, 'ref': 'kittycad.models.extrusion_face_cap_type.ExtrusionFaceCapType:94667206501088', 'sub_type': 'str', 'type': 'enum'}, 'type': 'model-field'}, 'curve_id': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': None, 'schema': {'schema': {'type': 'str'}, 'type': 'nullable'}, 'type': 'default'}, 'type': 'model-field'}, 'face_id': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': None, 'schema': {'schema': {'type': 'str'}, 'type': 'nullable'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'ExtrusionFaceInfo', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'list'}, 'type': 'model-field'}}, 'model_name': 'Solid3dGetExtrusionFaceInfo', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}, 'type': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': 'solid3d_get_extrusion_face_info', 'schema': {'expected': ['solid3d_get_extrusion_face_info'], 'type': 'literal'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'OptionSolid3DGetExtrusionFaceInfo', 'type': 'model-fields'}, 'type': 'model'}[source]: The core schema of the model.

__pydantic_custom_init__: ClassVar[bool] = False[source]: Whether the model has a custom __init__ method.

__pydantic_decorators__: ClassVar[_decorators.DecoratorInfos] = DecoratorInfos(validators={}, field_validators={}, root_validators={}, field_serializers={}, model_serializers={}, model_validators={}, computed_fields={})[source]: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_extra__: dict[str, Any] | None[source]: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to 'allow'.

__pydantic_fields_set__: set[str][source]: The names of fields explicitly set during instantiation.

__pydantic_generic_metadata__: ClassVar[_generics.PydanticGenericMetadata] = {'args': (), 'origin': None, 'parameters': ()}[source]: 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.

classmethod __pydantic_init_subclass__(**kwargs)[source]

This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.

This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.

This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.

Parameters:: **kwargs (Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.
Return type:: None

__pydantic_parent_namespace__: ClassVar[Dict[str, Any] | None] = None[source]: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__: ClassVar[None | Literal['model_post_init']] = None[source]: The name of the post-init method for the model, if defined.

__pydantic_private__: dict[str, Any] | None[source]: Values of private attributes set on the model instance.

__pydantic_root_model__: ClassVar[bool] = False[source]: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__: ClassVar[SchemaSerializer] = SchemaSerializer(serializer=Model( ModelSerializer { class: Py( 0x000056196daaef50, ), serializer: Fields( GeneralFieldsSerializer { fields: { "data": SerField { key_py: Py( 0x00007f9038238fa0, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196d934860, ), serializer: Fields( GeneralFieldsSerializer { fields: { "faces": SerField { key_py: Py( 0x00007f9033500660, ), alias: None, alias_py: None, serializer: Some( List( ListSerializer { item_serializer: Model( ModelSerializer { class: Py( 0x000056196d372e60, ), serializer: Fields( GeneralFieldsSerializer { fields: { "curve_id": SerField { key_py: Py( 0x00007f90339660f0, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f9038148100, ), ), serializer: Nullable( NullableSerializer { serializer: Str( StrSerializer, ), }, ), }, ), ), required: true, }, "face_id": SerField { key_py: Py( 0x00007f9033e20420, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f9038148100, ), ), serializer: Nullable( NullableSerializer { serializer: Str( StrSerializer, ), }, ), }, ), ), required: true, }, "cap": SerField { key_py: Py( 0x00007f90361ae2e0, ), alias: None, alias_py: None, serializer: Some( Enum( EnumSerializer { class: Py( 0x000056196d3722e0, ), serializer: Some( Str( StrSerializer, ), ), }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 3, }, ), has_extra: false, root_model: false, name: "ExtrusionFaceInfo", }, ), filter: SchemaFilter { include: None, exclude: None, }, name: "list[ExtrusionFaceInfo]", }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 1, }, ), has_extra: false, root_model: false, name: "Solid3dGetExtrusionFaceInfo", }, ), ), required: true, }, "type": SerField { key_py: Py( 0x00007f903823d958, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f9034697c30, ), ), serializer: Literal( LiteralSerializer { expected_int: {}, expected_str: { "solid3d_get_extrusion_face_info", }, expected_py: None, name: "literal['solid3d_get_extrusion_face_info']", }, ), }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "OptionSolid3DGetExtrusionFaceInfo", }, ), definitions=[])[source]: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__: ClassVar[SchemaValidator | PluggableSchemaValidator] = SchemaValidator(title="OptionSolid3DGetExtrusionFaceInfo", validator=Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "data", lookup_key: Simple { key: "data", py_key: Py( 0x00007f90333ab7b0, ), path: LookupPath( [ S( "data", Py( 0x00007f90333ab5a0, ), ), ], ), }, name_py: Py( 0x00007f9038238fa0, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "faces", lookup_key: Simple { key: "faces", py_key: Py( 0x00007f90333ab6f0, ), path: LookupPath( [ S( "faces", Py( 0x00007f90333ab660, ), ), ], ), }, name_py: Py( 0x00007f9033500660, ), validator: List( ListValidator { strict: false, item_validator: Some( Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "cap", lookup_key: Simple { key: "cap", py_key: Py( 0x00007f90333ab930, ), path: LookupPath( [ S( "cap", Py( 0x00007f90333ab9c0, ), ), ], ), }, name_py: Py( 0x00007f90361ae2e0, ), validator: StrEnum( EnumValidator { phantom: PhantomData<_pydantic_core::validators::enum_::StrEnumValidator>, class: Py( 0x000056196d3722e0, ), lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "none": 0, "top": 1, "bottom": 2, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f903392d430, ), Py( 0x00007f903392d490, ), Py( 0x00007f903392d4f0, ), ], }, missing: None, expected_repr: "'none', 'top' or 'bottom'", strict: false, class_repr: "ExtrusionFaceCapType", name: "str-enum[ExtrusionFaceCapType]", }, ), frozen: false, }, Field { name: "curve_id", lookup_key: Simple { key: "curve_id", py_key: Py( 0x00007f90333d5130, ), path: LookupPath( [ S( "curve_id", Py( 0x00007f90333d5ff0, ), ), ], ), }, name_py: Py( 0x00007f90339660f0, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f9038148100, ), ), on_error: Raise, validator: Nullable( NullableValidator { validator: Str( StrValidator { strict: false, coerce_numbers_to_str: false, }, ), name: "nullable[str]", }, ), validate_default: false, copy_default: false, name: "default[nullable[str]]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, Field { name: "face_id", lookup_key: Simple { key: "face_id", py_key: Py( 0x00007f90333aba20, ), path: LookupPath( [ S( "face_id", Py( 0x00007f90333ab630, ), ), ], ), }, name_py: Py( 0x00007f9033e20420, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f9038148100, ), ), on_error: Raise, validator: Nullable( NullableValidator { validator: Str( StrValidator { strict: false, coerce_numbers_to_str: false, }, ), name: "nullable[str]", }, ), validate_default: false, copy_default: false, name: "default[nullable[str]]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "ExtrusionFaceInfo", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d372e60, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "ExtrusionFaceInfo", }, ), ), min_length: None, max_length: None, name: OnceLock( <uninit>, ), fail_fast: false, }, ), frozen: false, }, ], model_name: "Solid3dGetExtrusionFaceInfo", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d934860, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "Solid3dGetExtrusionFaceInfo", }, ), frozen: false, }, Field { name: "type", lookup_key: Simple { key: "type", py_key: Py( 0x00007f90333ab5d0, ), path: LookupPath( [ S( "type", Py( 0x00007f90333ab450, ), ), ], ), }, name_py: Py( 0x00007f903823d958, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f9034697c30, ), ), on_error: Raise, validator: Literal( LiteralValidator { lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "solid3d_get_extrusion_face_info": 0, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f9034697c30, ), ], }, expected_repr: "'solid3d_get_extrusion_face_info'", name: "literal['solid3d_get_extrusion_face_info']", }, ), validate_default: false, copy_default: false, name: "default[literal['solid3d_get_extrusion_face_info']]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "OptionSolid3DGetExtrusionFaceInfo", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196daaef50, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "OptionSolid3DGetExtrusionFaceInfo", }, ), definitions=[], cache_strings=True)[source]: The pydantic-core SchemaValidator used to validate instances of the model.

__repr__()[source]

Return repr(self).

Return type:: str

__repr_args__()[source]

Return type:: Iterable[tuple[str | None, Any]]

__repr_name__()[source]

Name of the instance’s class, used in __repr__.

Return type:: str

__repr_str__(join_str)[source]

Return type:: str

__rich_repr__()[source]

Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.

Return type:: Iterable[Any | tuple[Any] | tuple[str, Any] | tuple[str, Any, Any]]

__setattr__(name, value)[source]

Implement setattr(self, name, value).

Return type:: None

__setstate__(state)[source]

Return type:: None

__signature__: ClassVar[Signature] = <Signature (*, data: kittycad.models.solid3d_get_extrusion_face_info.Solid3dGetExtrusionFaceInfo, type: Literal['solid3d_get_extrusion_face_info'] = 'solid3d_get_extrusion_face_info') -> None>[source]: The synthesized __init__ [Signature][inspect.Signature] of the model.

__slots__ = ('__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__')[source]

__str__()[source]

Return str(self).

Return type:: str

_abc_impl = <_abc._abc_data object>[source]

_calculate_keys(*args, **kwargs)[source]

Return type:: Any

_check_frozen(name, value)[source]

Return type:: None

_copy_and_set_values(*args, **kwargs)[source]

Return type:: Any

classmethod _get_value(*args, **kwargs)[source]

Return type:: Any

_iter(*args, **kwargs)[source]

Return type:: Any

classmethod construct(_fields_set=None, **values)[source]

Return type:: Self

copy(*, include=None, exclude=None, update=None, deep=False)[source]

Returns a copy of the model.

!!! warning “Deprecated”: This method is now deprecated; use model_copy instead.

If you need include or exclude, use:

`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `

Parameters:

include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.

Returns:

A copy of the model with included, excluded and updated fields as specified.

data: Solid3dGetExtrusionFaceInfo[source]

dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)[source]

Return type:: Dict[str, Any]

classmethod from_orm(obj)[source]

Return type:: Self

json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)[source]

Return type:: str

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}[source]: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'protected_namespaces': ()}[source]: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod model_construct(_fields_set=None, **values)[source]

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note: model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == 'allow', then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == 'ignore' (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == 'forbid' does not result in an error if extra values are passed, but they will be ignored.

Parameters:

_fields_set (set[str] | None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.
values (Any) – Trusted or pre-validated data dictionary.

Return type:

Self

Returns:

A new instance of the Model class with validated data.

model_copy(*, update=None, deep=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy

Returns a copy of the model.

Parameters:

update (dict[str, Any] | None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.
deep (bool) – Set to True to make a deep copy of the model.

Return type:

Self

Returns:

New model instance.

model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters:

mode (Union[Literal['json', 'python'], str]) – The mode in which to_python 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.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to include in the output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to exclude from the output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to use the field’s alias in the dictionary key if defined.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A dictionary representation of the model.

model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

Generates a JSON representation of the model using Pydantic’s to_json method.

Parameters:

indent (int | None) – Indentation to use in the JSON output. If None is passed, the output will be compact.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to include in the JSON output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to exclude from the JSON output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to serialize using field aliases.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A JSON string representation of the model.

property model_extra: dict[str, Any] | None[source]

Get extra fields set during validation.

Returns:: A dictionary of extra fields, or None if config.extra is not set to "allow".

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=Solid3dGetExtrusionFaceInfo, required=True), 'type': FieldInfo(annotation=Literal['solid3d_get_extrusion_face_info'], required=False, default='solid3d_get_extrusion_face_info')}[source]

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

property model_fields_set: set[str][source]

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,: i.e. that were not filled from defaults.

classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')[source]

Generates a JSON schema for a model class.

Parameters:

by_alias (bool) – Whether to use attribute aliases or not.
ref_template (str) – The reference template.
schema_generator (type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modifications
mode (Literal['validation', 'serialization']) – The mode in which to generate the schema.

Return type:

Returns:

The JSON schema for the given model class.

classmethod model_parametrized_name(params)[source]

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

Parameters:: params (tuple[type[Any], ...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.
Return type:: str
Returns:: String representing the new class where params are passed to cls as type variables.
Raises:: TypeError – Raised when trying to generate concrete names for non-generic models.

model_post_init(_BaseModel__context)[source]

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

Return type:: None

classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)[source]

Try to rebuild the pydantic-core schema for the model.

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.

Parameters:

force (bool) – Whether to force the rebuilding of the model schema, defaults to False.
raise_errors (bool) – Whether to raise errors, defaults to True.
_parent_namespace_depth (int) – The depth level of the parent namespace, defaults to 2.
_types_namespace (dict[str, Any] | None) – The types namespace, defaults to None.

Return type:

Returns:

Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.

classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)[source]

Validate a pydantic model instance.

Parameters:

obj (Any) – The object to validate.
strict (bool | None) – Whether to enforce types strictly.
from_attributes (bool | None) – Whether to extract data from object attributes.
context (Any | None) – Additional context to pass to the validator.

Raises:

ValidationError – If the object could not be validated.

Return type:

Self

Returns:

The validated model instance.

classmethod model_validate_json(json_data, *, strict=None, context=None)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing

Validate the given JSON data against the Pydantic model.

Parameters:

json_data (str | bytes | bytearray) – The JSON data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

Raises:

ValidationError – If json_data is not a JSON string or the object could not be validated.

classmethod model_validate_strings(obj, *, strict=None, context=None)[source]

Validate the given object with string data against the Pydantic model.

Parameters:

obj (Any) – The object containing string data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod parse_obj(obj)[source]

Return type:: Self

classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod schema(by_alias=True, ref_template='#/$defs/{model}')[source]

Return type:: Dict[str, Any]

classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)[source]

Return type:: str

type: Literal['solid3d_get_extrusion_face_info'][source]

classmethod update_forward_refs(**localns)[source]

Return type:: None

classmethod validate(value)[source]

Return type:: Self

class kittycad.models.ok_modeling_cmd_response.OptionSolid3DGetNextAdjacentEdge(**data)[source][source]

The response to the ‘Solid3dGetNextAdjacentEdge’ endpoint

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__abstractmethods__ = frozenset({})[source]

__annotations__ = {'__class_vars__': 'ClassVar[set[str]]', '__private_attributes__': 'ClassVar[Dict[str, ModelPrivateAttr]]', '__pydantic_complete__': 'ClassVar[bool]', '__pydantic_core_schema__': 'ClassVar[CoreSchema]', '__pydantic_custom_init__': 'ClassVar[bool]', '__pydantic_decorators__': 'ClassVar[_decorators.DecoratorInfos]', '__pydantic_extra__': 'dict[str, Any] | None', '__pydantic_fields_set__': 'set[str]', '__pydantic_generic_metadata__': 'ClassVar[_generics.PydanticGenericMetadata]', '__pydantic_parent_namespace__': 'ClassVar[Dict[str, Any] | None]', '__pydantic_post_init__': "ClassVar[None | Literal['model_post_init']]", '__pydantic_private__': 'dict[str, Any] | None', '__pydantic_root_model__': 'ClassVar[bool]', '__pydantic_serializer__': 'ClassVar[SchemaSerializer]', '__pydantic_validator__': 'ClassVar[SchemaValidator | PluggableSchemaValidator]', '__signature__': 'ClassVar[Signature]', 'data': <class 'kittycad.models.solid3d_get_next_adjacent_edge.Solid3dGetNextAdjacentEdge'>, 'model_computed_fields': 'ClassVar[Dict[str, ComputedFieldInfo]]', 'model_config': 'ClassVar[ConfigDict]', 'model_fields': 'ClassVar[Dict[str, FieldInfo]]', 'type': typing.Literal['solid3d_get_next_adjacent_edge']}[source]

classmethod __class_getitem__(typevar_values)[source]

Return type:: type[BaseModel] | PydanticRecursiveRef

__class_vars__: ClassVar[set[str]] = {}[source]: The names of the class variables defined on the model.

__copy__()[source]

Returns a shallow copy of the model.

Return type:: Self

__deepcopy__(memo=None)[source]

Returns a deep copy of the model.

Return type:: Self

__delattr__(item)[source]

Implement delattr(self, name).

Return type:: Any

__dict__[source]

__eq__(other)[source]

Return self==value.

Return type:: bool

property __fields_set__: set[str][source]

classmethod __get_pydantic_core_schema__(source, handler, /)[source]

Hook into generating the model’s CoreSchema.

Parameters:

source (type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.
handler (GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.

Return type:

Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]

Returns:

A pydantic-core CoreSchema.

classmethod __get_pydantic_json_schema__(core_schema, handler, /)[source]

Hook into generating the model’s JSON schema.

Parameters:

core_schema (Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({'type': 'nullable', 'schema': current_schema}), or just call the handler with the original schema.
handler (GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.

Return type:

Returns:

A JSON schema, as a Python object.

__getattr__(item)[source]

Return type:: Any

__getstate__()[source]

Helper for pickle.

Return type:: dict[Any, Any]

__hash__ = None[source]

__init__(**data)[source]

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__iter__()[source]

So dict(model) works.

Return type:: Generator[Tuple[str, Any], None, None]

__module__ = 'kittycad.models.ok_modeling_cmd_response'[source]

__pretty__(fmt, **kwargs)[source]

Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.

Return type:: Generator[Any, None, None]

__private_attributes__: ClassVar[Dict[str, ModelPrivateAttr]] = {}[source]: Metadata about the private attributes of the model.

__pydantic_complete__: ClassVar[bool] = True[source]: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__: ClassVar[CoreSchema] = {'cls': <class 'kittycad.models.ok_modeling_cmd_response.OptionSolid3DGetNextAdjacentEdge'>, 'config': {'title': 'OptionSolid3DGetNextAdjacentEdge'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.ok_modeling_cmd_response.OptionSolid3DGetNextAdjacentEdge'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.ok_modeling_cmd_response.OptionSolid3DGetNextAdjacentEdge'>>]}, 'ref': 'kittycad.models.ok_modeling_cmd_response.OptionSolid3DGetNextAdjacentEdge:94667213624048', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'data': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.solid3d_get_next_adjacent_edge.Solid3dGetNextAdjacentEdge'>, 'config': {'title': 'Solid3dGetNextAdjacentEdge'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.solid3d_get_next_adjacent_edge.Solid3dGetNextAdjacentEdge'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.solid3d_get_next_adjacent_edge.Solid3dGetNextAdjacentEdge'>>]}, 'ref': 'kittycad.models.solid3d_get_next_adjacent_edge.Solid3dGetNextAdjacentEdge:94667212524288', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'edge': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': None, 'schema': {'schema': {'type': 'str'}, 'type': 'nullable'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'Solid3dGetNextAdjacentEdge', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}, 'type': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': 'solid3d_get_next_adjacent_edge', 'schema': {'expected': ['solid3d_get_next_adjacent_edge'], 'type': 'literal'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'OptionSolid3DGetNextAdjacentEdge', 'type': 'model-fields'}, 'type': 'model'}[source]: The core schema of the model.

__pydantic_custom_init__: ClassVar[bool] = False[source]: Whether the model has a custom __init__ method.

__pydantic_decorators__: ClassVar[_decorators.DecoratorInfos] = DecoratorInfos(validators={}, field_validators={}, root_validators={}, field_serializers={}, model_serializers={}, model_validators={}, computed_fields={})[source]: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_extra__: dict[str, Any] | None[source]: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to 'allow'.

__pydantic_fields_set__: set[str][source]: The names of fields explicitly set during instantiation.

__pydantic_generic_metadata__: ClassVar[_generics.PydanticGenericMetadata] = {'args': (), 'origin': None, 'parameters': ()}[source]: 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.

classmethod __pydantic_init_subclass__(**kwargs)[source]

This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.

This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.

This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.

Parameters:: **kwargs (Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.
Return type:: None

__pydantic_parent_namespace__: ClassVar[Dict[str, Any] | None] = None[source]: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__: ClassVar[None | Literal['model_post_init']] = None[source]: The name of the post-init method for the model, if defined.

__pydantic_private__: dict[str, Any] | None[source]: Values of private attributes set on the model instance.

__pydantic_root_model__: ClassVar[bool] = False[source]: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__: ClassVar[SchemaSerializer] = SchemaSerializer(serializer=Model( ModelSerializer { class: Py( 0x000056196da3d2f0, ), serializer: Fields( GeneralFieldsSerializer { fields: { "data": SerField { key_py: Py( 0x00007f9038238fa0, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196d930b00, ), serializer: Fields( GeneralFieldsSerializer { fields: { "edge": SerField { key_py: Py( 0x00007f9033b16160, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f9038148100, ), ), serializer: Nullable( NullableSerializer { serializer: Str( StrSerializer, ), }, ), }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 1, }, ), has_extra: false, root_model: false, name: "Solid3dGetNextAdjacentEdge", }, ), ), required: true, }, "type": SerField { key_py: Py( 0x00007f903823d958, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f9034697cd0, ), ), serializer: Literal( LiteralSerializer { expected_int: {}, expected_str: { "solid3d_get_next_adjacent_edge", }, expected_py: None, name: "literal['solid3d_get_next_adjacent_edge']", }, ), }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "OptionSolid3DGetNextAdjacentEdge", }, ), definitions=[])[source]: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__: ClassVar[SchemaValidator | PluggableSchemaValidator] = SchemaValidator(title="OptionSolid3DGetNextAdjacentEdge", validator=Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "data", lookup_key: Simple { key: "data", py_key: Py( 0x00007f903336e370, ), path: LookupPath( [ S( "data", Py( 0x00007f903336e3a0, ), ), ], ), }, name_py: Py( 0x00007f9038238fa0, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "edge", lookup_key: Simple { key: "edge", py_key: Py( 0x00007f903336e310, ), path: LookupPath( [ S( "edge", Py( 0x00007f903336e340, ), ), ], ), }, name_py: Py( 0x00007f9033b16160, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f9038148100, ), ), on_error: Raise, validator: Nullable( NullableValidator { validator: Str( StrValidator { strict: false, coerce_numbers_to_str: false, }, ), name: "nullable[str]", }, ), validate_default: false, copy_default: false, name: "default[nullable[str]]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "Solid3dGetNextAdjacentEdge", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d930b00, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "Solid3dGetNextAdjacentEdge", }, ), frozen: false, }, Field { name: "type", lookup_key: Simple { key: "type", py_key: Py( 0x00007f903336e3d0, ), path: LookupPath( [ S( "type", Py( 0x00007f903336e400, ), ), ], ), }, name_py: Py( 0x00007f903823d958, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f9034697cd0, ), ), on_error: Raise, validator: Literal( LiteralValidator { lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "solid3d_get_next_adjacent_edge": 0, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f9034697cd0, ), ], }, expected_repr: "'solid3d_get_next_adjacent_edge'", name: "literal['solid3d_get_next_adjacent_edge']", }, ), validate_default: false, copy_default: false, name: "default[literal['solid3d_get_next_adjacent_edge']]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "OptionSolid3DGetNextAdjacentEdge", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196da3d2f0, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "OptionSolid3DGetNextAdjacentEdge", }, ), definitions=[], cache_strings=True)[source]: The pydantic-core SchemaValidator used to validate instances of the model.

__repr__()[source]

Return repr(self).

Return type:: str

__repr_args__()[source]

Return type:: Iterable[tuple[str | None, Any]]

__repr_name__()[source]

Name of the instance’s class, used in __repr__.

Return type:: str

__repr_str__(join_str)[source]

Return type:: str

__rich_repr__()[source]

Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.

Return type:: Iterable[Any | tuple[Any] | tuple[str, Any] | tuple[str, Any, Any]]

__setattr__(name, value)[source]

Implement setattr(self, name, value).

Return type:: None

__setstate__(state)[source]

Return type:: None

__signature__: ClassVar[Signature] = <Signature (*, data: kittycad.models.solid3d_get_next_adjacent_edge.Solid3dGetNextAdjacentEdge, type: Literal['solid3d_get_next_adjacent_edge'] = 'solid3d_get_next_adjacent_edge') -> None>[source]: The synthesized __init__ [Signature][inspect.Signature] of the model.

__slots__ = ('__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__')[source]

__str__()[source]

Return str(self).

Return type:: str

_abc_impl = <_abc._abc_data object>[source]

_calculate_keys(*args, **kwargs)[source]

Return type:: Any

_check_frozen(name, value)[source]

Return type:: None

_copy_and_set_values(*args, **kwargs)[source]

Return type:: Any

classmethod _get_value(*args, **kwargs)[source]

Return type:: Any

_iter(*args, **kwargs)[source]

Return type:: Any

classmethod construct(_fields_set=None, **values)[source]

Return type:: Self

copy(*, include=None, exclude=None, update=None, deep=False)[source]

Returns a copy of the model.

!!! warning “Deprecated”: This method is now deprecated; use model_copy instead.

If you need include or exclude, use:

`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `

Parameters:

include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.

Returns:

A copy of the model with included, excluded and updated fields as specified.

data: Solid3dGetNextAdjacentEdge[source]

dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)[source]

Return type:: Dict[str, Any]

classmethod from_orm(obj)[source]

Return type:: Self

json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)[source]

Return type:: str

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}[source]: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'protected_namespaces': ()}[source]: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod model_construct(_fields_set=None, **values)[source]

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note: model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == 'allow', then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == 'ignore' (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == 'forbid' does not result in an error if extra values are passed, but they will be ignored.

Parameters:

_fields_set (set[str] | None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.
values (Any) – Trusted or pre-validated data dictionary.

Return type:

Self

Returns:

A new instance of the Model class with validated data.

model_copy(*, update=None, deep=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy

Returns a copy of the model.

Parameters:

update (dict[str, Any] | None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.
deep (bool) – Set to True to make a deep copy of the model.

Return type:

Self

Returns:

New model instance.

model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters:

mode (Union[Literal['json', 'python'], str]) – The mode in which to_python 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.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to include in the output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to exclude from the output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to use the field’s alias in the dictionary key if defined.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A dictionary representation of the model.

model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

Generates a JSON representation of the model using Pydantic’s to_json method.

Parameters:

indent (int | None) – Indentation to use in the JSON output. If None is passed, the output will be compact.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to include in the JSON output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to exclude from the JSON output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to serialize using field aliases.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A JSON string representation of the model.

property model_extra: dict[str, Any] | None[source]

Get extra fields set during validation.

Returns:: A dictionary of extra fields, or None if config.extra is not set to "allow".

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=Solid3dGetNextAdjacentEdge, required=True), 'type': FieldInfo(annotation=Literal['solid3d_get_next_adjacent_edge'], required=False, default='solid3d_get_next_adjacent_edge')}[source]

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

property model_fields_set: set[str][source]

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,: i.e. that were not filled from defaults.

classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')[source]

Generates a JSON schema for a model class.

Parameters:

by_alias (bool) – Whether to use attribute aliases or not.
ref_template (str) – The reference template.
schema_generator (type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modifications
mode (Literal['validation', 'serialization']) – The mode in which to generate the schema.

Return type:

Returns:

The JSON schema for the given model class.

classmethod model_parametrized_name(params)[source]

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

Parameters:: params (tuple[type[Any], ...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.
Return type:: str
Returns:: String representing the new class where params are passed to cls as type variables.
Raises:: TypeError – Raised when trying to generate concrete names for non-generic models.

model_post_init(_BaseModel__context)[source]

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

Return type:: None

classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)[source]

Try to rebuild the pydantic-core schema for the model.

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.

Parameters:

force (bool) – Whether to force the rebuilding of the model schema, defaults to False.
raise_errors (bool) – Whether to raise errors, defaults to True.
_parent_namespace_depth (int) – The depth level of the parent namespace, defaults to 2.
_types_namespace (dict[str, Any] | None) – The types namespace, defaults to None.

Return type:

Returns:

Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.

classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)[source]

Validate a pydantic model instance.

Parameters:

obj (Any) – The object to validate.
strict (bool | None) – Whether to enforce types strictly.
from_attributes (bool | None) – Whether to extract data from object attributes.
context (Any | None) – Additional context to pass to the validator.

Raises:

ValidationError – If the object could not be validated.

Return type:

Self

Returns:

The validated model instance.

classmethod model_validate_json(json_data, *, strict=None, context=None)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing

Validate the given JSON data against the Pydantic model.

Parameters:

json_data (str | bytes | bytearray) – The JSON data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

Raises:

ValidationError – If json_data is not a JSON string or the object could not be validated.

classmethod model_validate_strings(obj, *, strict=None, context=None)[source]

Validate the given object with string data against the Pydantic model.

Parameters:

obj (Any) – The object containing string data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod parse_obj(obj)[source]

Return type:: Self

classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod schema(by_alias=True, ref_template='#/$defs/{model}')[source]

Return type:: Dict[str, Any]

classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)[source]

Return type:: str

type: Literal['solid3d_get_next_adjacent_edge'][source]

classmethod update_forward_refs(**localns)[source]

Return type:: None

classmethod validate(value)[source]

Return type:: Self

class kittycad.models.ok_modeling_cmd_response.OptionSolid3DGetOppositeEdge(**data)[source][source]

The response to the ‘Solid3dGetOppositeEdge’ endpoint

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__abstractmethods__ = frozenset({})[source]

__annotations__ = {'__class_vars__': 'ClassVar[set[str]]', '__private_attributes__': 'ClassVar[Dict[str, ModelPrivateAttr]]', '__pydantic_complete__': 'ClassVar[bool]', '__pydantic_core_schema__': 'ClassVar[CoreSchema]', '__pydantic_custom_init__': 'ClassVar[bool]', '__pydantic_decorators__': 'ClassVar[_decorators.DecoratorInfos]', '__pydantic_extra__': 'dict[str, Any] | None', '__pydantic_fields_set__': 'set[str]', '__pydantic_generic_metadata__': 'ClassVar[_generics.PydanticGenericMetadata]', '__pydantic_parent_namespace__': 'ClassVar[Dict[str, Any] | None]', '__pydantic_post_init__': "ClassVar[None | Literal['model_post_init']]", '__pydantic_private__': 'dict[str, Any] | None', '__pydantic_root_model__': 'ClassVar[bool]', '__pydantic_serializer__': 'ClassVar[SchemaSerializer]', '__pydantic_validator__': 'ClassVar[SchemaValidator | PluggableSchemaValidator]', '__signature__': 'ClassVar[Signature]', 'data': <class 'kittycad.models.solid3d_get_opposite_edge.Solid3dGetOppositeEdge'>, 'model_computed_fields': 'ClassVar[Dict[str, ComputedFieldInfo]]', 'model_config': 'ClassVar[ConfigDict]', 'model_fields': 'ClassVar[Dict[str, FieldInfo]]', 'type': typing.Literal['solid3d_get_opposite_edge']}[source]

classmethod __class_getitem__(typevar_values)[source]

Return type:: type[BaseModel] | PydanticRecursiveRef

__class_vars__: ClassVar[set[str]] = {}[source]: The names of the class variables defined on the model.

__copy__()[source]

Returns a shallow copy of the model.

Return type:: Self

__deepcopy__(memo=None)[source]

Returns a deep copy of the model.

Return type:: Self

__delattr__(item)[source]

Implement delattr(self, name).

Return type:: Any

__dict__[source]

__eq__(other)[source]

Return self==value.

Return type:: bool

property __fields_set__: set[str][source]

classmethod __get_pydantic_core_schema__(source, handler, /)[source]

Hook into generating the model’s CoreSchema.

Parameters:

source (type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.
handler (GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.

Return type:

Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]

Returns:

A pydantic-core CoreSchema.

classmethod __get_pydantic_json_schema__(core_schema, handler, /)[source]

Hook into generating the model’s JSON schema.

Parameters:

core_schema (Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({'type': 'nullable', 'schema': current_schema}), or just call the handler with the original schema.
handler (GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.

Return type:

Returns:

A JSON schema, as a Python object.

__getattr__(item)[source]

Return type:: Any

__getstate__()[source]

Helper for pickle.

Return type:: dict[Any, Any]

__hash__ = None[source]

__init__(**data)[source]

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__iter__()[source]

So dict(model) works.

Return type:: Generator[Tuple[str, Any], None, None]

__module__ = 'kittycad.models.ok_modeling_cmd_response'[source]

__pretty__(fmt, **kwargs)[source]

Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.

Return type:: Generator[Any, None, None]

__private_attributes__: ClassVar[Dict[str, ModelPrivateAttr]] = {}[source]: Metadata about the private attributes of the model.

__pydantic_complete__: ClassVar[bool] = True[source]: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__: ClassVar[CoreSchema] = {'cls': <class 'kittycad.models.ok_modeling_cmd_response.OptionSolid3DGetOppositeEdge'>, 'config': {'title': 'OptionSolid3DGetOppositeEdge'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.ok_modeling_cmd_response.OptionSolid3DGetOppositeEdge'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.ok_modeling_cmd_response.OptionSolid3DGetOppositeEdge'>>]}, 'ref': 'kittycad.models.ok_modeling_cmd_response.OptionSolid3DGetOppositeEdge:94667213611328', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'data': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.solid3d_get_opposite_edge.Solid3dGetOppositeEdge'>, 'config': {'title': 'Solid3dGetOppositeEdge'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.solid3d_get_opposite_edge.Solid3dGetOppositeEdge'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.solid3d_get_opposite_edge.Solid3dGetOppositeEdge'>>]}, 'ref': 'kittycad.models.solid3d_get_opposite_edge.Solid3dGetOppositeEdge:94667212553088', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'edge': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'type': 'str'}, 'type': 'model-field'}}, 'model_name': 'Solid3dGetOppositeEdge', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}, 'type': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': 'solid3d_get_opposite_edge', 'schema': {'expected': ['solid3d_get_opposite_edge'], 'type': 'literal'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'OptionSolid3DGetOppositeEdge', 'type': 'model-fields'}, 'type': 'model'}[source]: The core schema of the model.

__pydantic_custom_init__: ClassVar[bool] = False[source]: Whether the model has a custom __init__ method.

__pydantic_decorators__: ClassVar[_decorators.DecoratorInfos] = DecoratorInfos(validators={}, field_validators={}, root_validators={}, field_serializers={}, model_serializers={}, model_validators={}, computed_fields={})[source]: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_extra__: dict[str, Any] | None[source]: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to 'allow'.

__pydantic_fields_set__: set[str][source]: The names of fields explicitly set during instantiation.

__pydantic_generic_metadata__: ClassVar[_generics.PydanticGenericMetadata] = {'args': (), 'origin': None, 'parameters': ()}[source]: 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.

classmethod __pydantic_init_subclass__(**kwargs)[source]

This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.

This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.

This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.

Parameters:: **kwargs (Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.
Return type:: None

__pydantic_parent_namespace__: ClassVar[Dict[str, Any] | None] = None[source]: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__: ClassVar[None | Literal['model_post_init']] = None[source]: The name of the post-init method for the model, if defined.

__pydantic_private__: dict[str, Any] | None[source]: Values of private attributes set on the model instance.

__pydantic_root_model__: ClassVar[bool] = False[source]: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__: ClassVar[SchemaSerializer] = SchemaSerializer(serializer=Model( ModelSerializer { class: Py( 0x000056196da3a140, ), serializer: Fields( GeneralFieldsSerializer { fields: { "type": SerField { key_py: Py( 0x00007f903823d958, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f9034697d70, ), ), serializer: Literal( LiteralSerializer { expected_int: {}, expected_str: { "solid3d_get_opposite_edge", }, expected_py: None, name: "literal['solid3d_get_opposite_edge']", }, ), }, ), ), required: true, }, "data": SerField { key_py: Py( 0x00007f9038238fa0, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196d937b80, ), serializer: Fields( GeneralFieldsSerializer { fields: { "edge": SerField { key_py: Py( 0x00007f9033b16160, ), alias: None, alias_py: None, serializer: Some( Str( StrSerializer, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 1, }, ), has_extra: false, root_model: false, name: "Solid3dGetOppositeEdge", }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "OptionSolid3DGetOppositeEdge", }, ), definitions=[])[source]: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__: ClassVar[SchemaValidator | PluggableSchemaValidator] = SchemaValidator(title="OptionSolid3DGetOppositeEdge", validator=Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "data", lookup_key: Simple { key: "data", py_key: Py( 0x00007f903336ce40, ), path: LookupPath( [ S( "data", Py( 0x00007f903336ce10, ), ), ], ), }, name_py: Py( 0x00007f9038238fa0, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "edge", lookup_key: Simple { key: "edge", py_key: Py( 0x00007f903336cd20, ), path: LookupPath( [ S( "edge", Py( 0x00007f903336ccf0, ), ), ], ), }, name_py: Py( 0x00007f9033b16160, ), validator: Str( StrValidator { strict: false, coerce_numbers_to_str: false, }, ), frozen: false, }, ], model_name: "Solid3dGetOppositeEdge", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d937b80, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "Solid3dGetOppositeEdge", }, ), frozen: false, }, Field { name: "type", lookup_key: Simple { key: "type", py_key: Py( 0x00007f903336cdb0, ), path: LookupPath( [ S( "type", Py( 0x00007f903336cd80, ), ), ], ), }, name_py: Py( 0x00007f903823d958, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f9034697d70, ), ), on_error: Raise, validator: Literal( LiteralValidator { lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "solid3d_get_opposite_edge": 0, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f9034697d70, ), ], }, expected_repr: "'solid3d_get_opposite_edge'", name: "literal['solid3d_get_opposite_edge']", }, ), validate_default: false, copy_default: false, name: "default[literal['solid3d_get_opposite_edge']]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "OptionSolid3DGetOppositeEdge", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196da3a140, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "OptionSolid3DGetOppositeEdge", }, ), definitions=[], cache_strings=True)[source]: The pydantic-core SchemaValidator used to validate instances of the model.

__repr__()[source]

Return repr(self).

Return type:: str

__repr_args__()[source]

Return type:: Iterable[tuple[str | None, Any]]

__repr_name__()[source]

Name of the instance’s class, used in __repr__.

Return type:: str

__repr_str__(join_str)[source]

Return type:: str

__rich_repr__()[source]

Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.

Return type:: Iterable[Any | tuple[Any] | tuple[str, Any] | tuple[str, Any, Any]]

__setattr__(name, value)[source]

Implement setattr(self, name, value).

Return type:: None

__setstate__(state)[source]

Return type:: None

__signature__: ClassVar[Signature] = <Signature (*, data: kittycad.models.solid3d_get_opposite_edge.Solid3dGetOppositeEdge, type: Literal['solid3d_get_opposite_edge'] = 'solid3d_get_opposite_edge') -> None>[source]: The synthesized __init__ [Signature][inspect.Signature] of the model.

__slots__ = ('__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__')[source]

__str__()[source]

Return str(self).

Return type:: str

_abc_impl = <_abc._abc_data object>[source]

_calculate_keys(*args, **kwargs)[source]

Return type:: Any

_check_frozen(name, value)[source]

Return type:: None

_copy_and_set_values(*args, **kwargs)[source]

Return type:: Any

classmethod _get_value(*args, **kwargs)[source]

Return type:: Any

_iter(*args, **kwargs)[source]

Return type:: Any

classmethod construct(_fields_set=None, **values)[source]

Return type:: Self

copy(*, include=None, exclude=None, update=None, deep=False)[source]

Returns a copy of the model.

!!! warning “Deprecated”: This method is now deprecated; use model_copy instead.

If you need include or exclude, use:

`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `

Parameters:

include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.

Returns:

A copy of the model with included, excluded and updated fields as specified.

data: Solid3dGetOppositeEdge[source]

dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)[source]

Return type:: Dict[str, Any]

classmethod from_orm(obj)[source]

Return type:: Self

json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)[source]

Return type:: str

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}[source]: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'protected_namespaces': ()}[source]: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod model_construct(_fields_set=None, **values)[source]

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note: model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == 'allow', then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == 'ignore' (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == 'forbid' does not result in an error if extra values are passed, but they will be ignored.

Parameters:

_fields_set (set[str] | None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.
values (Any) – Trusted or pre-validated data dictionary.

Return type:

Self

Returns:

A new instance of the Model class with validated data.

model_copy(*, update=None, deep=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy

Returns a copy of the model.

Parameters:

update (dict[str, Any] | None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.
deep (bool) – Set to True to make a deep copy of the model.

Return type:

Self

Returns:

New model instance.

model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters:

mode (Union[Literal['json', 'python'], str]) – The mode in which to_python 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.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to include in the output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to exclude from the output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to use the field’s alias in the dictionary key if defined.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A dictionary representation of the model.

model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

Generates a JSON representation of the model using Pydantic’s to_json method.

Parameters:

indent (int | None) – Indentation to use in the JSON output. If None is passed, the output will be compact.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to include in the JSON output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to exclude from the JSON output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to serialize using field aliases.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A JSON string representation of the model.

property model_extra: dict[str, Any] | None[source]

Get extra fields set during validation.

Returns:: A dictionary of extra fields, or None if config.extra is not set to "allow".

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=Solid3dGetOppositeEdge, required=True), 'type': FieldInfo(annotation=Literal['solid3d_get_opposite_edge'], required=False, default='solid3d_get_opposite_edge')}[source]

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

property model_fields_set: set[str][source]

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,: i.e. that were not filled from defaults.

classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')[source]

Generates a JSON schema for a model class.

Parameters:

by_alias (bool) – Whether to use attribute aliases or not.
ref_template (str) – The reference template.
schema_generator (type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modifications
mode (Literal['validation', 'serialization']) – The mode in which to generate the schema.

Return type:

Returns:

The JSON schema for the given model class.

classmethod model_parametrized_name(params)[source]

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

Parameters:: params (tuple[type[Any], ...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.
Return type:: str
Returns:: String representing the new class where params are passed to cls as type variables.
Raises:: TypeError – Raised when trying to generate concrete names for non-generic models.

model_post_init(_BaseModel__context)[source]

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

Return type:: None

classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)[source]

Try to rebuild the pydantic-core schema for the model.

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.

Parameters:

force (bool) – Whether to force the rebuilding of the model schema, defaults to False.
raise_errors (bool) – Whether to raise errors, defaults to True.
_parent_namespace_depth (int) – The depth level of the parent namespace, defaults to 2.
_types_namespace (dict[str, Any] | None) – The types namespace, defaults to None.

Return type:

Returns:

Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.

classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)[source]

Validate a pydantic model instance.

Parameters:

obj (Any) – The object to validate.
strict (bool | None) – Whether to enforce types strictly.
from_attributes (bool | None) – Whether to extract data from object attributes.
context (Any | None) – Additional context to pass to the validator.

Raises:

ValidationError – If the object could not be validated.

Return type:

Self

Returns:

The validated model instance.

classmethod model_validate_json(json_data, *, strict=None, context=None)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing

Validate the given JSON data against the Pydantic model.

Parameters:

json_data (str | bytes | bytearray) – The JSON data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

Raises:

ValidationError – If json_data is not a JSON string or the object could not be validated.

classmethod model_validate_strings(obj, *, strict=None, context=None)[source]

Validate the given object with string data against the Pydantic model.

Parameters:

obj (Any) – The object containing string data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod parse_obj(obj)[source]

Return type:: Self

classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod schema(by_alias=True, ref_template='#/$defs/{model}')[source]

Return type:: Dict[str, Any]

classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)[source]

Return type:: str

type: Literal['solid3d_get_opposite_edge'][source]

classmethod update_forward_refs(**localns)[source]

Return type:: None

classmethod validate(value)[source]

Return type:: Self

class kittycad.models.ok_modeling_cmd_response.OptionSolid3DGetPrevAdjacentEdge(**data)[source][source]

The response to the ‘Solid3dGetPrevAdjacentEdge’ endpoint

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__abstractmethods__ = frozenset({})[source]

__annotations__ = {'__class_vars__': 'ClassVar[set[str]]', '__private_attributes__': 'ClassVar[Dict[str, ModelPrivateAttr]]', '__pydantic_complete__': 'ClassVar[bool]', '__pydantic_core_schema__': 'ClassVar[CoreSchema]', '__pydantic_custom_init__': 'ClassVar[bool]', '__pydantic_decorators__': 'ClassVar[_decorators.DecoratorInfos]', '__pydantic_extra__': 'dict[str, Any] | None', '__pydantic_fields_set__': 'set[str]', '__pydantic_generic_metadata__': 'ClassVar[_generics.PydanticGenericMetadata]', '__pydantic_parent_namespace__': 'ClassVar[Dict[str, Any] | None]', '__pydantic_post_init__': "ClassVar[None | Literal['model_post_init']]", '__pydantic_private__': 'dict[str, Any] | None', '__pydantic_root_model__': 'ClassVar[bool]', '__pydantic_serializer__': 'ClassVar[SchemaSerializer]', '__pydantic_validator__': 'ClassVar[SchemaValidator | PluggableSchemaValidator]', '__signature__': 'ClassVar[Signature]', 'data': <class 'kittycad.models.solid3d_get_prev_adjacent_edge.Solid3dGetPrevAdjacentEdge'>, 'model_computed_fields': 'ClassVar[Dict[str, ComputedFieldInfo]]', 'model_config': 'ClassVar[ConfigDict]', 'model_fields': 'ClassVar[Dict[str, FieldInfo]]', 'type': typing.Literal['solid3d_get_prev_adjacent_edge']}[source]

classmethod __class_getitem__(typevar_values)[source]

Return type:: type[BaseModel] | PydanticRecursiveRef

__class_vars__: ClassVar[set[str]] = {}[source]: The names of the class variables defined on the model.

__copy__()[source]

Returns a shallow copy of the model.

Return type:: Self

__deepcopy__(memo=None)[source]

Returns a deep copy of the model.

Return type:: Self

__delattr__(item)[source]

Implement delattr(self, name).

Return type:: Any

__dict__[source]

__eq__(other)[source]

Return self==value.

Return type:: bool

property __fields_set__: set[str][source]

classmethod __get_pydantic_core_schema__(source, handler, /)[source]

Hook into generating the model’s CoreSchema.

Parameters:

source (type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.
handler (GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.

Return type:

Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]

Returns:

A pydantic-core CoreSchema.

classmethod __get_pydantic_json_schema__(core_schema, handler, /)[source]

Hook into generating the model’s JSON schema.

Parameters:

core_schema (Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({'type': 'nullable', 'schema': current_schema}), or just call the handler with the original schema.
handler (GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.

Return type:

Returns:

A JSON schema, as a Python object.

__getattr__(item)[source]

Return type:: Any

__getstate__()[source]

Helper for pickle.

Return type:: dict[Any, Any]

__hash__ = None[source]

__init__(**data)[source]

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__iter__()[source]

So dict(model) works.

Return type:: Generator[Tuple[str, Any], None, None]

__module__ = 'kittycad.models.ok_modeling_cmd_response'[source]

__pretty__(fmt, **kwargs)[source]

Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.

Return type:: Generator[Any, None, None]

__private_attributes__: ClassVar[Dict[str, ModelPrivateAttr]] = {}[source]: Metadata about the private attributes of the model.

__pydantic_complete__: ClassVar[bool] = True[source]: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__: ClassVar[CoreSchema] = {'cls': <class 'kittycad.models.ok_modeling_cmd_response.OptionSolid3DGetPrevAdjacentEdge'>, 'config': {'title': 'OptionSolid3DGetPrevAdjacentEdge'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.ok_modeling_cmd_response.OptionSolid3DGetPrevAdjacentEdge'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.ok_modeling_cmd_response.OptionSolid3DGetPrevAdjacentEdge'>>]}, 'ref': 'kittycad.models.ok_modeling_cmd_response.OptionSolid3DGetPrevAdjacentEdge:94667213636416', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'data': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.solid3d_get_prev_adjacent_edge.Solid3dGetPrevAdjacentEdge'>, 'config': {'title': 'Solid3dGetPrevAdjacentEdge'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.solid3d_get_prev_adjacent_edge.Solid3dGetPrevAdjacentEdge'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.solid3d_get_prev_adjacent_edge.Solid3dGetPrevAdjacentEdge'>>]}, 'ref': 'kittycad.models.solid3d_get_prev_adjacent_edge.Solid3dGetPrevAdjacentEdge:94667212557056', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'edge': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': None, 'schema': {'schema': {'type': 'str'}, 'type': 'nullable'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'Solid3dGetPrevAdjacentEdge', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}, 'type': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': 'solid3d_get_prev_adjacent_edge', 'schema': {'expected': ['solid3d_get_prev_adjacent_edge'], 'type': 'literal'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'OptionSolid3DGetPrevAdjacentEdge', 'type': 'model-fields'}, 'type': 'model'}[source]: The core schema of the model.

__pydantic_custom_init__: ClassVar[bool] = False[source]: Whether the model has a custom __init__ method.

__pydantic_decorators__: ClassVar[_decorators.DecoratorInfos] = DecoratorInfos(validators={}, field_validators={}, root_validators={}, field_serializers={}, model_serializers={}, model_validators={}, computed_fields={})[source]: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_extra__: dict[str, Any] | None[source]: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to 'allow'.

__pydantic_fields_set__: set[str][source]: The names of fields explicitly set during instantiation.

__pydantic_generic_metadata__: ClassVar[_generics.PydanticGenericMetadata] = {'args': (), 'origin': None, 'parameters': ()}[source]: 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.

classmethod __pydantic_init_subclass__(**kwargs)[source]

This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.

This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.

This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.

Parameters:: **kwargs (Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.
Return type:: None

__pydantic_parent_namespace__: ClassVar[Dict[str, Any] | None] = None[source]: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__: ClassVar[None | Literal['model_post_init']] = None[source]: The name of the post-init method for the model, if defined.

__pydantic_private__: dict[str, Any] | None[source]: Values of private attributes set on the model instance.

__pydantic_root_model__: ClassVar[bool] = False[source]: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__: ClassVar[SchemaSerializer] = SchemaSerializer(serializer=Model( ModelSerializer { class: Py( 0x000056196da40340, ), serializer: Fields( GeneralFieldsSerializer { fields: { "data": SerField { key_py: Py( 0x00007f9038238fa0, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196d938b00, ), serializer: Fields( GeneralFieldsSerializer { fields: { "edge": SerField { key_py: Py( 0x00007f9033b16160, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f9038148100, ), ), serializer: Nullable( NullableSerializer { serializer: Str( StrSerializer, ), }, ), }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 1, }, ), has_extra: false, root_model: false, name: "Solid3dGetPrevAdjacentEdge", }, ), ), required: true, }, "type": SerField { key_py: Py( 0x00007f903823d958, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f9034697dc0, ), ), serializer: Literal( LiteralSerializer { expected_int: {}, expected_str: { "solid3d_get_prev_adjacent_edge", }, expected_py: None, name: "literal['solid3d_get_prev_adjacent_edge']", }, ), }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "OptionSolid3DGetPrevAdjacentEdge", }, ), definitions=[])[source]: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__: ClassVar[SchemaValidator | PluggableSchemaValidator] = SchemaValidator(title="OptionSolid3DGetPrevAdjacentEdge", validator=Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "data", lookup_key: Simple { key: "data", py_key: Py( 0x00007f903336e8e0, ), path: LookupPath( [ S( "data", Py( 0x00007f903336e910, ), ), ], ), }, name_py: Py( 0x00007f9038238fa0, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "edge", lookup_key: Simple { key: "edge", py_key: Py( 0x00007f903336e880, ), path: LookupPath( [ S( "edge", Py( 0x00007f903336e8b0, ), ), ], ), }, name_py: Py( 0x00007f9033b16160, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f9038148100, ), ), on_error: Raise, validator: Nullable( NullableValidator { validator: Str( StrValidator { strict: false, coerce_numbers_to_str: false, }, ), name: "nullable[str]", }, ), validate_default: false, copy_default: false, name: "default[nullable[str]]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "Solid3dGetPrevAdjacentEdge", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d938b00, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "Solid3dGetPrevAdjacentEdge", }, ), frozen: false, }, Field { name: "type", lookup_key: Simple { key: "type", py_key: Py( 0x00007f903336e940, ), path: LookupPath( [ S( "type", Py( 0x00007f903336e970, ), ), ], ), }, name_py: Py( 0x00007f903823d958, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f9034697dc0, ), ), on_error: Raise, validator: Literal( LiteralValidator { lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "solid3d_get_prev_adjacent_edge": 0, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f9034697dc0, ), ], }, expected_repr: "'solid3d_get_prev_adjacent_edge'", name: "literal['solid3d_get_prev_adjacent_edge']", }, ), validate_default: false, copy_default: false, name: "default[literal['solid3d_get_prev_adjacent_edge']]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "OptionSolid3DGetPrevAdjacentEdge", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196da40340, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "OptionSolid3DGetPrevAdjacentEdge", }, ), definitions=[], cache_strings=True)[source]: The pydantic-core SchemaValidator used to validate instances of the model.

__repr__()[source]

Return repr(self).

Return type:: str

__repr_args__()[source]

Return type:: Iterable[tuple[str | None, Any]]

__repr_name__()[source]

Name of the instance’s class, used in __repr__.

Return type:: str

__repr_str__(join_str)[source]

Return type:: str

__rich_repr__()[source]

Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.

Return type:: Iterable[Any | tuple[Any] | tuple[str, Any] | tuple[str, Any, Any]]

__setattr__(name, value)[source]

Implement setattr(self, name, value).

Return type:: None

__setstate__(state)[source]

Return type:: None

__signature__: ClassVar[Signature] = <Signature (*, data: kittycad.models.solid3d_get_prev_adjacent_edge.Solid3dGetPrevAdjacentEdge, type: Literal['solid3d_get_prev_adjacent_edge'] = 'solid3d_get_prev_adjacent_edge') -> None>[source]: The synthesized __init__ [Signature][inspect.Signature] of the model.

__slots__ = ('__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__')[source]

__str__()[source]

Return str(self).

Return type:: str

_abc_impl = <_abc._abc_data object>[source]

_calculate_keys(*args, **kwargs)[source]

Return type:: Any

_check_frozen(name, value)[source]

Return type:: None

_copy_and_set_values(*args, **kwargs)[source]

Return type:: Any

classmethod _get_value(*args, **kwargs)[source]

Return type:: Any

_iter(*args, **kwargs)[source]

Return type:: Any

classmethod construct(_fields_set=None, **values)[source]

Return type:: Self

copy(*, include=None, exclude=None, update=None, deep=False)[source]

Returns a copy of the model.

!!! warning “Deprecated”: This method is now deprecated; use model_copy instead.

If you need include or exclude, use:

`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `

Parameters:

include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.

Returns:

A copy of the model with included, excluded and updated fields as specified.

data: Solid3dGetPrevAdjacentEdge[source]

dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)[source]

Return type:: Dict[str, Any]

classmethod from_orm(obj)[source]

Return type:: Self

json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)[source]

Return type:: str

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}[source]: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'protected_namespaces': ()}[source]: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod model_construct(_fields_set=None, **values)[source]

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note: model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == 'allow', then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == 'ignore' (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == 'forbid' does not result in an error if extra values are passed, but they will be ignored.

Parameters:

_fields_set (set[str] | None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.
values (Any) – Trusted or pre-validated data dictionary.

Return type:

Self

Returns:

A new instance of the Model class with validated data.

model_copy(*, update=None, deep=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy

Returns a copy of the model.

Parameters:

update (dict[str, Any] | None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.
deep (bool) – Set to True to make a deep copy of the model.

Return type:

Self

Returns:

New model instance.

model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters:

mode (Union[Literal['json', 'python'], str]) – The mode in which to_python 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.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to include in the output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to exclude from the output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to use the field’s alias in the dictionary key if defined.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A dictionary representation of the model.

model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

Generates a JSON representation of the model using Pydantic’s to_json method.

Parameters:

indent (int | None) – Indentation to use in the JSON output. If None is passed, the output will be compact.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to include in the JSON output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to exclude from the JSON output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to serialize using field aliases.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A JSON string representation of the model.

property model_extra: dict[str, Any] | None[source]

Get extra fields set during validation.

Returns:: A dictionary of extra fields, or None if config.extra is not set to "allow".

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=Solid3dGetPrevAdjacentEdge, required=True), 'type': FieldInfo(annotation=Literal['solid3d_get_prev_adjacent_edge'], required=False, default='solid3d_get_prev_adjacent_edge')}[source]

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

property model_fields_set: set[str][source]

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,: i.e. that were not filled from defaults.

classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')[source]

Generates a JSON schema for a model class.

Parameters:

by_alias (bool) – Whether to use attribute aliases or not.
ref_template (str) – The reference template.
schema_generator (type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modifications
mode (Literal['validation', 'serialization']) – The mode in which to generate the schema.

Return type:

Returns:

The JSON schema for the given model class.

classmethod model_parametrized_name(params)[source]

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

Parameters:: params (tuple[type[Any], ...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.
Return type:: str
Returns:: String representing the new class where params are passed to cls as type variables.
Raises:: TypeError – Raised when trying to generate concrete names for non-generic models.

model_post_init(_BaseModel__context)[source]

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

Return type:: None

classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)[source]

Try to rebuild the pydantic-core schema for the model.

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.

Parameters:

force (bool) – Whether to force the rebuilding of the model schema, defaults to False.
raise_errors (bool) – Whether to raise errors, defaults to True.
_parent_namespace_depth (int) – The depth level of the parent namespace, defaults to 2.
_types_namespace (dict[str, Any] | None) – The types namespace, defaults to None.

Return type:

Returns:

Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.

classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)[source]

Validate a pydantic model instance.

Parameters:

obj (Any) – The object to validate.
strict (bool | None) – Whether to enforce types strictly.
from_attributes (bool | None) – Whether to extract data from object attributes.
context (Any | None) – Additional context to pass to the validator.

Raises:

ValidationError – If the object could not be validated.

Return type:

Self

Returns:

The validated model instance.

classmethod model_validate_json(json_data, *, strict=None, context=None)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing

Validate the given JSON data against the Pydantic model.

Parameters:

json_data (str | bytes | bytearray) – The JSON data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

Raises:

ValidationError – If json_data is not a JSON string or the object could not be validated.

classmethod model_validate_strings(obj, *, strict=None, context=None)[source]

Validate the given object with string data against the Pydantic model.

Parameters:

obj (Any) – The object containing string data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod parse_obj(obj)[source]

Return type:: Self

classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod schema(by_alias=True, ref_template='#/$defs/{model}')[source]

Return type:: Dict[str, Any]

classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)[source]

Return type:: str

type: Literal['solid3d_get_prev_adjacent_edge'][source]

classmethod update_forward_refs(**localns)[source]

Return type:: None

classmethod validate(value)[source]

Return type:: Self

class kittycad.models.ok_modeling_cmd_response.OptionSolid3DShellFace(**data)[source][source]

The response to the ‘Solid3dShellFace’ endpoint

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__abstractmethods__ = frozenset({})[source]

__annotations__ = {'__class_vars__': 'ClassVar[set[str]]', '__private_attributes__': 'ClassVar[Dict[str, ModelPrivateAttr]]', '__pydantic_complete__': 'ClassVar[bool]', '__pydantic_core_schema__': 'ClassVar[CoreSchema]', '__pydantic_custom_init__': 'ClassVar[bool]', '__pydantic_decorators__': 'ClassVar[_decorators.DecoratorInfos]', '__pydantic_extra__': 'dict[str, Any] | None', '__pydantic_fields_set__': 'set[str]', '__pydantic_generic_metadata__': 'ClassVar[_generics.PydanticGenericMetadata]', '__pydantic_parent_namespace__': 'ClassVar[Dict[str, Any] | None]', '__pydantic_post_init__': "ClassVar[None | Literal['model_post_init']]", '__pydantic_private__': 'dict[str, Any] | None', '__pydantic_root_model__': 'ClassVar[bool]', '__pydantic_serializer__': 'ClassVar[SchemaSerializer]', '__pydantic_validator__': 'ClassVar[SchemaValidator | PluggableSchemaValidator]', '__signature__': 'ClassVar[Signature]', 'data': <class 'kittycad.models.solid3d_shell_face.Solid3dShellFace'>, 'model_computed_fields': 'ClassVar[Dict[str, ComputedFieldInfo]]', 'model_config': 'ClassVar[ConfigDict]', 'model_fields': 'ClassVar[Dict[str, FieldInfo]]', 'type': typing.Literal['solid3d_shell_face']}[source]

classmethod __class_getitem__(typevar_values)[source]

Return type:: type[BaseModel] | PydanticRecursiveRef

__class_vars__: ClassVar[set[str]] = {}[source]: The names of the class variables defined on the model.

__copy__()[source]

Returns a shallow copy of the model.

Return type:: Self

__deepcopy__(memo=None)[source]

Returns a deep copy of the model.

Return type:: Self

__delattr__(item)[source]

Implement delattr(self, name).

Return type:: Any

__dict__[source]

__eq__(other)[source]

Return self==value.

Return type:: bool

property __fields_set__: set[str][source]

classmethod __get_pydantic_core_schema__(source, handler, /)[source]

Hook into generating the model’s CoreSchema.

Parameters:

source (type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.
handler (GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.

Return type:

Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]

Returns:

A pydantic-core CoreSchema.

classmethod __get_pydantic_json_schema__(core_schema, handler, /)[source]

Hook into generating the model’s JSON schema.

Parameters:

core_schema (Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({'type': 'nullable', 'schema': current_schema}), or just call the handler with the original schema.
handler (GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.

Return type:

Returns:

A JSON schema, as a Python object.

__getattr__(item)[source]

Return type:: Any

__getstate__()[source]

Helper for pickle.

Return type:: dict[Any, Any]

__hash__ = None[source]

__init__(**data)[source]

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__iter__()[source]

So dict(model) works.

Return type:: Generator[Tuple[str, Any], None, None]

__module__ = 'kittycad.models.ok_modeling_cmd_response'[source]

__pretty__(fmt, **kwargs)[source]

Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.

Return type:: Generator[Any, None, None]

__private_attributes__: ClassVar[Dict[str, ModelPrivateAttr]] = {}[source]: Metadata about the private attributes of the model.

__pydantic_complete__: ClassVar[bool] = True[source]: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__: ClassVar[CoreSchema] = {'cls': <class 'kittycad.models.ok_modeling_cmd_response.OptionSolid3DShellFace'>, 'config': {'title': 'OptionSolid3DShellFace'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.ok_modeling_cmd_response.OptionSolid3DShellFace'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.ok_modeling_cmd_response.OptionSolid3DShellFace'>>]}, 'ref': 'kittycad.models.ok_modeling_cmd_response.OptionSolid3DShellFace:94667212747520', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'data': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.solid3d_shell_face.Solid3dShellFace'>, 'config': {'title': 'Solid3dShellFace'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.solid3d_shell_face.Solid3dShellFace'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.solid3d_shell_face.Solid3dShellFace'>>]}, 'ref': 'kittycad.models.solid3d_shell_face.Solid3dShellFace:94667212562912', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {}, 'model_name': 'Solid3dShellFace', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}, 'type': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': 'solid3d_shell_face', 'schema': {'expected': ['solid3d_shell_face'], 'type': 'literal'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'OptionSolid3DShellFace', 'type': 'model-fields'}, 'type': 'model'}[source]: The core schema of the model.

__pydantic_custom_init__: ClassVar[bool] = False[source]: Whether the model has a custom __init__ method.

__pydantic_decorators__: ClassVar[_decorators.DecoratorInfos] = DecoratorInfos(validators={}, field_validators={}, root_validators={}, field_serializers={}, model_serializers={}, model_validators={}, computed_fields={})[source]: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_extra__: dict[str, Any] | None[source]: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to 'allow'.

__pydantic_fields_set__: set[str][source]: The names of fields explicitly set during instantiation.

__pydantic_generic_metadata__: ClassVar[_generics.PydanticGenericMetadata] = {'args': (), 'origin': None, 'parameters': ()}[source]: 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.

classmethod __pydantic_init_subclass__(**kwargs)[source]

This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.

This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.

This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.

Parameters:: **kwargs (Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.
Return type:: None

__pydantic_parent_namespace__: ClassVar[Dict[str, Any] | None] = None[source]: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__: ClassVar[None | Literal['model_post_init']] = None[source]: The name of the post-init method for the model, if defined.

__pydantic_private__: dict[str, Any] | None[source]: Values of private attributes set on the model instance.

__pydantic_root_model__: ClassVar[bool] = False[source]: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__: ClassVar[SchemaSerializer] = SchemaSerializer(serializer=Model( ModelSerializer { class: Py( 0x000056196d967300, ), serializer: Fields( GeneralFieldsSerializer { fields: { "data": SerField { key_py: Py( 0x00007f9038238fa0, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196d93a1e0, ), serializer: Fields( GeneralFieldsSerializer { fields: {}, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 0, }, ), has_extra: false, root_model: false, name: "Solid3dShellFace", }, ), ), required: true, }, "type": SerField { key_py: Py( 0x00007f903823d958, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f90346e6e30, ), ), serializer: Literal( LiteralSerializer { expected_int: {}, expected_str: { "solid3d_shell_face", }, expected_py: None, name: "literal['solid3d_shell_face']", }, ), }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "OptionSolid3DShellFace", }, ), definitions=[])[source]: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__: ClassVar[SchemaValidator | PluggableSchemaValidator] = SchemaValidator(title="OptionSolid3DShellFace", validator=Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "data", lookup_key: Simple { key: "data", py_key: Py( 0x00007f9033606850, ), path: LookupPath( [ S( "data", Py( 0x00007f9033606880, ), ), ], ), }, name_py: Py( 0x00007f9038238fa0, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [], model_name: "Solid3dShellFace", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d93a1e0, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "Solid3dShellFace", }, ), frozen: false, }, Field { name: "type", lookup_key: Simple { key: "type", py_key: Py( 0x00007f90336068b0, ), path: LookupPath( [ S( "type", Py( 0x00007f90336068e0, ), ), ], ), }, name_py: Py( 0x00007f903823d958, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f90346e6e30, ), ), on_error: Raise, validator: Literal( LiteralValidator { lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "solid3d_shell_face": 0, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f90346e6e30, ), ], }, expected_repr: "'solid3d_shell_face'", name: "literal['solid3d_shell_face']", }, ), validate_default: false, copy_default: false, name: "default[literal['solid3d_shell_face']]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "OptionSolid3DShellFace", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d967300, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "OptionSolid3DShellFace", }, ), definitions=[], cache_strings=True)[source]: The pydantic-core SchemaValidator used to validate instances of the model.

__repr__()[source]

Return repr(self).

Return type:: str

__repr_args__()[source]

Return type:: Iterable[tuple[str | None, Any]]

__repr_name__()[source]

Name of the instance’s class, used in __repr__.

Return type:: str

__repr_str__(join_str)[source]

Return type:: str

__rich_repr__()[source]

Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.

Return type:: Iterable[Any | tuple[Any] | tuple[str, Any] | tuple[str, Any, Any]]

__setattr__(name, value)[source]

Implement setattr(self, name, value).

Return type:: None

__setstate__(state)[source]

Return type:: None

__signature__: ClassVar[Signature] = <Signature (*, data: kittycad.models.solid3d_shell_face.Solid3dShellFace, type: Literal['solid3d_shell_face'] = 'solid3d_shell_face') -> None>[source]: The synthesized __init__ [Signature][inspect.Signature] of the model.

__slots__ = ('__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__')[source]

__str__()[source]

Return str(self).

Return type:: str

_abc_impl = <_abc._abc_data object>[source]

_calculate_keys(*args, **kwargs)[source]

Return type:: Any

_check_frozen(name, value)[source]

Return type:: None

_copy_and_set_values(*args, **kwargs)[source]

Return type:: Any

classmethod _get_value(*args, **kwargs)[source]

Return type:: Any

_iter(*args, **kwargs)[source]

Return type:: Any

classmethod construct(_fields_set=None, **values)[source]

Return type:: Self

copy(*, include=None, exclude=None, update=None, deep=False)[source]

Returns a copy of the model.

!!! warning “Deprecated”: This method is now deprecated; use model_copy instead.

If you need include or exclude, use:

`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `

Parameters:

include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.

Returns:

A copy of the model with included, excluded and updated fields as specified.

data: Solid3dShellFace[source]

dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)[source]

Return type:: Dict[str, Any]

classmethod from_orm(obj)[source]

Return type:: Self

json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)[source]

Return type:: str

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}[source]: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'protected_namespaces': ()}[source]: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod model_construct(_fields_set=None, **values)[source]

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note: model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == 'allow', then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == 'ignore' (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == 'forbid' does not result in an error if extra values are passed, but they will be ignored.

Parameters:

_fields_set (set[str] | None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.
values (Any) – Trusted or pre-validated data dictionary.

Return type:

Self

Returns:

A new instance of the Model class with validated data.

model_copy(*, update=None, deep=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy

Returns a copy of the model.

Parameters:

update (dict[str, Any] | None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.
deep (bool) – Set to True to make a deep copy of the model.

Return type:

Self

Returns:

New model instance.

model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters:

mode (Union[Literal['json', 'python'], str]) – The mode in which to_python 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.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to include in the output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to exclude from the output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to use the field’s alias in the dictionary key if defined.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A dictionary representation of the model.

model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

Generates a JSON representation of the model using Pydantic’s to_json method.

Parameters:

indent (int | None) – Indentation to use in the JSON output. If None is passed, the output will be compact.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to include in the JSON output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to exclude from the JSON output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to serialize using field aliases.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A JSON string representation of the model.

property model_extra: dict[str, Any] | None[source]

Get extra fields set during validation.

Returns:: A dictionary of extra fields, or None if config.extra is not set to "allow".

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=Solid3dShellFace, required=True), 'type': FieldInfo(annotation=Literal['solid3d_shell_face'], required=False, default='solid3d_shell_face')}[source]

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

property model_fields_set: set[str][source]

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,: i.e. that were not filled from defaults.

classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')[source]

Generates a JSON schema for a model class.

Parameters:

by_alias (bool) – Whether to use attribute aliases or not.
ref_template (str) – The reference template.
schema_generator (type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modifications
mode (Literal['validation', 'serialization']) – The mode in which to generate the schema.

Return type:

Returns:

The JSON schema for the given model class.

classmethod model_parametrized_name(params)[source]

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

Parameters:: params (tuple[type[Any], ...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.
Return type:: str
Returns:: String representing the new class where params are passed to cls as type variables.
Raises:: TypeError – Raised when trying to generate concrete names for non-generic models.

model_post_init(_BaseModel__context)[source]

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

Return type:: None

classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)[source]

Try to rebuild the pydantic-core schema for the model.

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.

Parameters:

force (bool) – Whether to force the rebuilding of the model schema, defaults to False.
raise_errors (bool) – Whether to raise errors, defaults to True.
_parent_namespace_depth (int) – The depth level of the parent namespace, defaults to 2.
_types_namespace (dict[str, Any] | None) – The types namespace, defaults to None.

Return type:

Returns:

Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.

classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)[source]

Validate a pydantic model instance.

Parameters:

obj (Any) – The object to validate.
strict (bool | None) – Whether to enforce types strictly.
from_attributes (bool | None) – Whether to extract data from object attributes.
context (Any | None) – Additional context to pass to the validator.

Raises:

ValidationError – If the object could not be validated.

Return type:

Self

Returns:

The validated model instance.

classmethod model_validate_json(json_data, *, strict=None, context=None)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing

Validate the given JSON data against the Pydantic model.

Parameters:

json_data (str | bytes | bytearray) – The JSON data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

Raises:

ValidationError – If json_data is not a JSON string or the object could not be validated.

classmethod model_validate_strings(obj, *, strict=None, context=None)[source]

Validate the given object with string data against the Pydantic model.

Parameters:

obj (Any) – The object containing string data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod parse_obj(obj)[source]

Return type:: Self

classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod schema(by_alias=True, ref_template='#/$defs/{model}')[source]

Return type:: Dict[str, Any]

classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)[source]

Return type:: str

type: Literal['solid3d_shell_face'][source]

classmethod update_forward_refs(**localns)[source]

Return type:: None

classmethod validate(value)[source]

Return type:: Self

class kittycad.models.ok_modeling_cmd_response.OptionStartPath(**data)[source][source]

The response to the ‘StartPath’ endpoint

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__abstractmethods__ = frozenset({})[source]

__annotations__ = {'__class_vars__': 'ClassVar[set[str]]', '__private_attributes__': 'ClassVar[Dict[str, ModelPrivateAttr]]', '__pydantic_complete__': 'ClassVar[bool]', '__pydantic_core_schema__': 'ClassVar[CoreSchema]', '__pydantic_custom_init__': 'ClassVar[bool]', '__pydantic_decorators__': 'ClassVar[_decorators.DecoratorInfos]', '__pydantic_extra__': 'dict[str, Any] | None', '__pydantic_fields_set__': 'set[str]', '__pydantic_generic_metadata__': 'ClassVar[_generics.PydanticGenericMetadata]', '__pydantic_parent_namespace__': 'ClassVar[Dict[str, Any] | None]', '__pydantic_post_init__': "ClassVar[None | Literal['model_post_init']]", '__pydantic_private__': 'dict[str, Any] | None', '__pydantic_root_model__': 'ClassVar[bool]', '__pydantic_serializer__': 'ClassVar[SchemaSerializer]', '__pydantic_validator__': 'ClassVar[SchemaValidator | PluggableSchemaValidator]', '__signature__': 'ClassVar[Signature]', 'data': <class 'kittycad.models.start_path.StartPath'>, 'model_computed_fields': 'ClassVar[Dict[str, ComputedFieldInfo]]', 'model_config': 'ClassVar[ConfigDict]', 'model_fields': 'ClassVar[Dict[str, FieldInfo]]', 'type': typing.Literal['start_path']}[source]

classmethod __class_getitem__(typevar_values)[source]

Return type:: type[BaseModel] | PydanticRecursiveRef

__class_vars__: ClassVar[set[str]] = {}[source]: The names of the class variables defined on the model.

__copy__()[source]

Returns a shallow copy of the model.

Return type:: Self

__deepcopy__(memo=None)[source]

Returns a deep copy of the model.

Return type:: Self

__delattr__(item)[source]

Implement delattr(self, name).

Return type:: Any

__dict__[source]

__eq__(other)[source]

Return self==value.

Return type:: bool

property __fields_set__: set[str][source]

classmethod __get_pydantic_core_schema__(source, handler, /)[source]

Hook into generating the model’s CoreSchema.

Parameters:

source (type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.
handler (GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.

Return type:

Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]

Returns:

A pydantic-core CoreSchema.

classmethod __get_pydantic_json_schema__(core_schema, handler, /)[source]

Hook into generating the model’s JSON schema.

Parameters:

core_schema (Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({'type': 'nullable', 'schema': current_schema}), or just call the handler with the original schema.
handler (GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.

Return type:

Returns:

A JSON schema, as a Python object.

__getattr__(item)[source]

Return type:: Any

__getstate__()[source]

Helper for pickle.

Return type:: dict[Any, Any]

__hash__ = None[source]

__init__(**data)[source]

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__iter__()[source]

So dict(model) works.

Return type:: Generator[Tuple[str, Any], None, None]

__module__ = 'kittycad.models.ok_modeling_cmd_response'[source]

__pretty__(fmt, **kwargs)[source]

Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.

Return type:: Generator[Any, None, None]

__private_attributes__: ClassVar[Dict[str, ModelPrivateAttr]] = {}[source]: Metadata about the private attributes of the model.

__pydantic_complete__: ClassVar[bool] = True[source]: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__: ClassVar[CoreSchema] = {'cls': <class 'kittycad.models.ok_modeling_cmd_response.OptionStartPath'>, 'config': {'title': 'OptionStartPath'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.ok_modeling_cmd_response.OptionStartPath'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.ok_modeling_cmd_response.OptionStartPath'>>]}, 'ref': 'kittycad.models.ok_modeling_cmd_response.OptionStartPath:94667212668896', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'data': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.start_path.StartPath'>, 'config': {'title': 'StartPath'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.start_path.StartPath'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.start_path.StartPath'>>]}, 'ref': 'kittycad.models.start_path.StartPath:94667212566944', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {}, 'model_name': 'StartPath', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}, 'type': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': 'start_path', 'schema': {'expected': ['start_path'], 'type': 'literal'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'OptionStartPath', 'type': 'model-fields'}, 'type': 'model'}[source]: The core schema of the model.

__pydantic_custom_init__: ClassVar[bool] = False[source]: Whether the model has a custom __init__ method.

__pydantic_decorators__: ClassVar[_decorators.DecoratorInfos] = DecoratorInfos(validators={}, field_validators={}, root_validators={}, field_serializers={}, model_serializers={}, model_validators={}, computed_fields={})[source]: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_extra__: dict[str, Any] | None[source]: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to 'allow'.

__pydantic_fields_set__: set[str][source]: The names of fields explicitly set during instantiation.

__pydantic_generic_metadata__: ClassVar[_generics.PydanticGenericMetadata] = {'args': (), 'origin': None, 'parameters': ()}[source]: 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.

classmethod __pydantic_init_subclass__(**kwargs)[source]

This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.

This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.

This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.

Parameters:: **kwargs (Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.
Return type:: None

__pydantic_parent_namespace__: ClassVar[Dict[str, Any] | None] = None[source]: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__: ClassVar[None | Literal['model_post_init']] = None[source]: The name of the post-init method for the model, if defined.

__pydantic_private__: dict[str, Any] | None[source]: Values of private attributes set on the model instance.

__pydantic_root_model__: ClassVar[bool] = False[source]: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__: ClassVar[SchemaSerializer] = SchemaSerializer(serializer=Model( ModelSerializer { class: Py( 0x000056196d953fe0, ), serializer: Fields( GeneralFieldsSerializer { fields: { "type": SerField { key_py: Py( 0x00007f903823d958, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f90346e70f0, ), ), serializer: Literal( LiteralSerializer { expected_int: {}, expected_str: { "start_path", }, expected_py: None, name: "literal['start_path']", }, ), }, ), ), required: true, }, "data": SerField { key_py: Py( 0x00007f9038238fa0, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196d93b1a0, ), serializer: Fields( GeneralFieldsSerializer { fields: {}, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 0, }, ), has_extra: false, root_model: false, name: "StartPath", }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "OptionStartPath", }, ), definitions=[])[source]: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__: ClassVar[SchemaValidator | PluggableSchemaValidator] = SchemaValidator(title="OptionStartPath", validator=Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "data", lookup_key: Simple { key: "data", py_key: Py( 0x00007f9033605ec0, ), path: LookupPath( [ S( "data", Py( 0x00007f9033605ef0, ), ), ], ), }, name_py: Py( 0x00007f9038238fa0, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [], model_name: "StartPath", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d93b1a0, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "StartPath", }, ), frozen: false, }, Field { name: "type", lookup_key: Simple { key: "type", py_key: Py( 0x00007f9033605f20, ), path: LookupPath( [ S( "type", Py( 0x00007f9033605f50, ), ), ], ), }, name_py: Py( 0x00007f903823d958, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f90346e70f0, ), ), on_error: Raise, validator: Literal( LiteralValidator { lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "start_path": 0, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f90346e70f0, ), ], }, expected_repr: "'start_path'", name: "literal['start_path']", }, ), validate_default: false, copy_default: false, name: "default[literal['start_path']]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "OptionStartPath", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d953fe0, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "OptionStartPath", }, ), definitions=[], cache_strings=True)[source]: The pydantic-core SchemaValidator used to validate instances of the model.

__repr__()[source]

Return repr(self).

Return type:: str

__repr_args__()[source]

Return type:: Iterable[tuple[str | None, Any]]

__repr_name__()[source]

Name of the instance’s class, used in __repr__.

Return type:: str

__repr_str__(join_str)[source]

Return type:: str

__rich_repr__()[source]

Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.

Return type:: Iterable[Any | tuple[Any] | tuple[str, Any] | tuple[str, Any, Any]]

__setattr__(name, value)[source]

Implement setattr(self, name, value).

Return type:: None

__setstate__(state)[source]

Return type:: None

__signature__: ClassVar[Signature] = <Signature (*, data: kittycad.models.start_path.StartPath, type: Literal['start_path'] = 'start_path') -> None>[source]: The synthesized __init__ [Signature][inspect.Signature] of the model.

__slots__ = ('__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__')[source]

__str__()[source]

Return str(self).

Return type:: str

_abc_impl = <_abc._abc_data object>[source]

_calculate_keys(*args, **kwargs)[source]

Return type:: Any

_check_frozen(name, value)[source]

Return type:: None

_copy_and_set_values(*args, **kwargs)[source]

Return type:: Any

classmethod _get_value(*args, **kwargs)[source]

Return type:: Any

_iter(*args, **kwargs)[source]

Return type:: Any

classmethod construct(_fields_set=None, **values)[source]

Return type:: Self

copy(*, include=None, exclude=None, update=None, deep=False)[source]

Returns a copy of the model.

!!! warning “Deprecated”: This method is now deprecated; use model_copy instead.

If you need include or exclude, use:

`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `

Parameters:

include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.

Returns:

A copy of the model with included, excluded and updated fields as specified.

data: StartPath[source]

dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)[source]

Return type:: Dict[str, Any]

classmethod from_orm(obj)[source]

Return type:: Self

json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)[source]

Return type:: str

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}[source]: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'protected_namespaces': ()}[source]: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod model_construct(_fields_set=None, **values)[source]

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note: model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == 'allow', then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == 'ignore' (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == 'forbid' does not result in an error if extra values are passed, but they will be ignored.

Parameters:

_fields_set (set[str] | None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.
values (Any) – Trusted or pre-validated data dictionary.

Return type:

Self

Returns:

A new instance of the Model class with validated data.

model_copy(*, update=None, deep=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy

Returns a copy of the model.

Parameters:

update (dict[str, Any] | None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.
deep (bool) – Set to True to make a deep copy of the model.

Return type:

Self

Returns:

New model instance.

model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters:

mode (Union[Literal['json', 'python'], str]) – The mode in which to_python 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.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to include in the output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to exclude from the output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to use the field’s alias in the dictionary key if defined.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A dictionary representation of the model.

model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

Generates a JSON representation of the model using Pydantic’s to_json method.

Parameters:

indent (int | None) – Indentation to use in the JSON output. If None is passed, the output will be compact.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to include in the JSON output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to exclude from the JSON output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to serialize using field aliases.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A JSON string representation of the model.

property model_extra: dict[str, Any] | None[source]

Get extra fields set during validation.

Returns:: A dictionary of extra fields, or None if config.extra is not set to "allow".

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=StartPath, required=True), 'type': FieldInfo(annotation=Literal['start_path'], required=False, default='start_path')}[source]

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

property model_fields_set: set[str][source]

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,: i.e. that were not filled from defaults.

classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')[source]

Generates a JSON schema for a model class.

Parameters:

by_alias (bool) – Whether to use attribute aliases or not.
ref_template (str) – The reference template.
schema_generator (type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modifications
mode (Literal['validation', 'serialization']) – The mode in which to generate the schema.

Return type:

Returns:

The JSON schema for the given model class.

classmethod model_parametrized_name(params)[source]

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

Parameters:: params (tuple[type[Any], ...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.
Return type:: str
Returns:: String representing the new class where params are passed to cls as type variables.
Raises:: TypeError – Raised when trying to generate concrete names for non-generic models.

model_post_init(_BaseModel__context)[source]

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

Return type:: None

classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)[source]

Try to rebuild the pydantic-core schema for the model.

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.

Parameters:

force (bool) – Whether to force the rebuilding of the model schema, defaults to False.
raise_errors (bool) – Whether to raise errors, defaults to True.
_parent_namespace_depth (int) – The depth level of the parent namespace, defaults to 2.
_types_namespace (dict[str, Any] | None) – The types namespace, defaults to None.

Return type:

Returns:

Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.

classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)[source]

Validate a pydantic model instance.

Parameters:

obj (Any) – The object to validate.
strict (bool | None) – Whether to enforce types strictly.
from_attributes (bool | None) – Whether to extract data from object attributes.
context (Any | None) – Additional context to pass to the validator.

Raises:

ValidationError – If the object could not be validated.

Return type:

Self

Returns:

The validated model instance.

classmethod model_validate_json(json_data, *, strict=None, context=None)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing

Validate the given JSON data against the Pydantic model.

Parameters:

json_data (str | bytes | bytearray) – The JSON data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

Raises:

ValidationError – If json_data is not a JSON string or the object could not be validated.

classmethod model_validate_strings(obj, *, strict=None, context=None)[source]

Validate the given object with string data against the Pydantic model.

Parameters:

obj (Any) – The object containing string data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod parse_obj(obj)[source]

Return type:: Self

classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod schema(by_alias=True, ref_template='#/$defs/{model}')[source]

Return type:: Dict[str, Any]

classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)[source]

Return type:: str

type: Literal['start_path'][source]

classmethod update_forward_refs(**localns)[source]

Return type:: None

classmethod validate(value)[source]

Return type:: Self

class kittycad.models.ok_modeling_cmd_response.OptionSurfaceArea(**data)[source][source]

The response to the ‘SurfaceArea’ endpoint

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__abstractmethods__ = frozenset({})[source]

__annotations__ = {'__class_vars__': 'ClassVar[set[str]]', '__private_attributes__': 'ClassVar[Dict[str, ModelPrivateAttr]]', '__pydantic_complete__': 'ClassVar[bool]', '__pydantic_core_schema__': 'ClassVar[CoreSchema]', '__pydantic_custom_init__': 'ClassVar[bool]', '__pydantic_decorators__': 'ClassVar[_decorators.DecoratorInfos]', '__pydantic_extra__': 'dict[str, Any] | None', '__pydantic_fields_set__': 'set[str]', '__pydantic_generic_metadata__': 'ClassVar[_generics.PydanticGenericMetadata]', '__pydantic_parent_namespace__': 'ClassVar[Dict[str, Any] | None]', '__pydantic_post_init__': "ClassVar[None | Literal['model_post_init']]", '__pydantic_private__': 'dict[str, Any] | None', '__pydantic_root_model__': 'ClassVar[bool]', '__pydantic_serializer__': 'ClassVar[SchemaSerializer]', '__pydantic_validator__': 'ClassVar[SchemaValidator | PluggableSchemaValidator]', '__signature__': 'ClassVar[Signature]', 'data': <class 'kittycad.models.surface_area.SurfaceArea'>, 'model_computed_fields': 'ClassVar[Dict[str, ComputedFieldInfo]]', 'model_config': 'ClassVar[ConfigDict]', 'model_fields': 'ClassVar[Dict[str, FieldInfo]]', 'type': typing.Literal['surface_area']}[source]

classmethod __class_getitem__(typevar_values)[source]

Return type:: type[BaseModel] | PydanticRecursiveRef

__class_vars__: ClassVar[set[str]] = {}[source]: The names of the class variables defined on the model.

__copy__()[source]

Returns a shallow copy of the model.

Return type:: Self

__deepcopy__(memo=None)[source]

Returns a deep copy of the model.

Return type:: Self

__delattr__(item)[source]

Implement delattr(self, name).

Return type:: Any

__dict__[source]

__eq__(other)[source]

Return self==value.

Return type:: bool

property __fields_set__: set[str][source]

classmethod __get_pydantic_core_schema__(source, handler, /)[source]

Hook into generating the model’s CoreSchema.

Parameters:

source (type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.
handler (GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.

Return type:

Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]

Returns:

A pydantic-core CoreSchema.

classmethod __get_pydantic_json_schema__(core_schema, handler, /)[source]

Hook into generating the model’s JSON schema.

Parameters:

core_schema (Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({'type': 'nullable', 'schema': current_schema}), or just call the handler with the original schema.
handler (GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.

Return type:

Returns:

A JSON schema, as a Python object.

__getattr__(item)[source]

Return type:: Any

__getstate__()[source]

Helper for pickle.

Return type:: dict[Any, Any]

__hash__ = None[source]

__init__(**data)[source]

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__iter__()[source]

So dict(model) works.

Return type:: Generator[Tuple[str, Any], None, None]

__module__ = 'kittycad.models.ok_modeling_cmd_response'[source]

__pretty__(fmt, **kwargs)[source]

Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.

Return type:: Generator[Any, None, None]

__private_attributes__: ClassVar[Dict[str, ModelPrivateAttr]] = {}[source]: Metadata about the private attributes of the model.

__pydantic_complete__: ClassVar[bool] = True[source]: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__: ClassVar[CoreSchema] = {'cls': <class 'kittycad.models.ok_modeling_cmd_response.OptionSurfaceArea'>, 'config': {'title': 'OptionSurfaceArea'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.ok_modeling_cmd_response.OptionSurfaceArea'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.ok_modeling_cmd_response.OptionSurfaceArea'>>]}, 'ref': 'kittycad.models.ok_modeling_cmd_response.OptionSurfaceArea:94667213985520', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'data': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.surface_area.SurfaceArea'>, 'config': {'title': 'SurfaceArea'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.surface_area.SurfaceArea'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.surface_area.SurfaceArea'>>]}, 'ref': 'kittycad.models.surface_area.SurfaceArea:94667212584880', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'output_unit': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <enum 'UnitArea'>, 'members': [UnitArea.CM2, UnitArea.DM2, UnitArea.FT2, UnitArea.IN2, UnitArea.KM2, UnitArea.M2, UnitArea.MM2, UnitArea.YD2], 'metadata': {'pydantic_js_functions': [<function GenerateSchema._enum_schema.<locals>.get_json_schema>]}, 'ref': 'kittycad.models.unit_area.UnitArea:94667203558336', 'sub_type': 'str', 'type': 'enum'}, 'type': 'model-field'}, 'surface_area': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'type': 'float'}, 'type': 'model-field'}}, 'model_name': 'SurfaceArea', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}, 'type': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': 'surface_area', 'schema': {'expected': ['surface_area'], 'type': 'literal'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'OptionSurfaceArea', 'type': 'model-fields'}, 'type': 'model'}[source]: The core schema of the model.

__pydantic_custom_init__: ClassVar[bool] = False[source]: Whether the model has a custom __init__ method.

__pydantic_decorators__: ClassVar[_decorators.DecoratorInfos] = DecoratorInfos(validators={}, field_validators={}, root_validators={}, field_serializers={}, model_serializers={}, model_validators={}, computed_fields={})[source]: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_extra__: dict[str, Any] | None[source]: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to 'allow'.

__pydantic_fields_set__: set[str][source]: The names of fields explicitly set during instantiation.

__pydantic_generic_metadata__: ClassVar[_generics.PydanticGenericMetadata] = {'args': (), 'origin': None, 'parameters': ()}[source]: 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.

classmethod __pydantic_init_subclass__(**kwargs)[source]

This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.

This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.

This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.

Parameters:: **kwargs (Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.
Return type:: None

__pydantic_parent_namespace__: ClassVar[Dict[str, Any] | None] = None[source]: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__: ClassVar[None | Literal['model_post_init']] = None[source]: The name of the post-init method for the model, if defined.

__pydantic_private__: dict[str, Any] | None[source]: Values of private attributes set on the model instance.

__pydantic_root_model__: ClassVar[bool] = False[source]: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__: ClassVar[SchemaSerializer] = SchemaSerializer(serializer=Model( ModelSerializer { class: Py( 0x000056196da956f0, ), serializer: Fields( GeneralFieldsSerializer { fields: { "data": SerField { key_py: Py( 0x00007f9038238fa0, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196d93f7b0, ), serializer: Fields( GeneralFieldsSerializer { fields: { "output_unit": SerField { key_py: Py( 0x00007f903459f8b0, ), alias: None, alias_py: None, serializer: Some( Enum( EnumSerializer { class: Py( 0x000056196d0a3bc0, ), serializer: Some( Str( StrSerializer, ), ), }, ), ), required: true, }, "surface_area": SerField { key_py: Py( 0x00007f90346e76b0, ), alias: None, alias_py: None, serializer: Some( Float( FloatSerializer { inf_nan_mode: Null, }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "SurfaceArea", }, ), ), required: true, }, "type": SerField { key_py: Py( 0x00007f903823d958, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f90346e76b0, ), ), serializer: Literal( LiteralSerializer { expected_int: {}, expected_str: { "surface_area", }, expected_py: None, name: "literal['surface_area']", }, ), }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "OptionSurfaceArea", }, ), definitions=[])[source]: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__: ClassVar[SchemaValidator | PluggableSchemaValidator] = SchemaValidator(title="OptionSurfaceArea", validator=Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "data", lookup_key: Simple { key: "data", py_key: Py( 0x00007f90333aaa00, ), path: LookupPath( [ S( "data", Py( 0x00007f90333aaa30, ), ), ], ), }, name_py: Py( 0x00007f9038238fa0, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "output_unit", lookup_key: Simple { key: "output_unit", py_key: Py( 0x00007f90333cbaf0, ), path: LookupPath( [ S( "output_unit", Py( 0x00007f90333cbab0, ), ), ], ), }, name_py: Py( 0x00007f903459f8b0, ), validator: StrEnum( EnumValidator { phantom: PhantomData<_pydantic_core::validators::enum_::StrEnumValidator>, class: Py( 0x000056196d0a3bc0, ), lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "dm2": 1, "km2": 4, "mm2": 6, "m2": 5, "ft2": 2, "yd2": 7, "in2": 3, "cm2": 0, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f9033cab590, ), Py( 0x00007f9033cab5f0, ), Py( 0x00007f9033cab650, ), Py( 0x00007f9033cab6b0, ), Py( 0x00007f9033cab710, ), Py( 0x00007f9033cab770, ), Py( 0x00007f9033cab7d0, ), Py( 0x00007f9033cab830, ), ], }, missing: None, expected_repr: "'cm2', 'dm2', 'ft2', 'in2', 'km2', 'm2', 'mm2' or 'yd2'", strict: false, class_repr: "UnitArea", name: "str-enum[UnitArea]", }, ), frozen: false, }, Field { name: "surface_area", lookup_key: Simple { key: "surface_area", py_key: Py( 0x00007f90333cbb70, ), path: LookupPath( [ S( "surface_area", Py( 0x00007f90333cbb30, ), ), ], ), }, name_py: Py( 0x00007f90346e76b0, ), validator: Float( FloatValidator { strict: false, allow_inf_nan: true, }, ), frozen: false, }, ], model_name: "SurfaceArea", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d93f7b0, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "SurfaceArea", }, ), frozen: false, }, Field { name: "type", lookup_key: Simple { key: "type", py_key: Py( 0x00007f90333aaa60, ), path: LookupPath( [ S( "type", Py( 0x00007f90333aaa90, ), ), ], ), }, name_py: Py( 0x00007f903823d958, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f90346e76b0, ), ), on_error: Raise, validator: Literal( LiteralValidator { lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "surface_area": 0, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f90346e76b0, ), ], }, expected_repr: "'surface_area'", name: "literal['surface_area']", }, ), validate_default: false, copy_default: false, name: "default[literal['surface_area']]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "OptionSurfaceArea", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196da956f0, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "OptionSurfaceArea", }, ), definitions=[], cache_strings=True)[source]: The pydantic-core SchemaValidator used to validate instances of the model.

__repr__()[source]

Return repr(self).

Return type:: str

__repr_args__()[source]

Return type:: Iterable[tuple[str | None, Any]]

__repr_name__()[source]

Name of the instance’s class, used in __repr__.

Return type:: str

__repr_str__(join_str)[source]

Return type:: str

__rich_repr__()[source]

Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.

Return type:: Iterable[Any | tuple[Any] | tuple[str, Any] | tuple[str, Any, Any]]

__setattr__(name, value)[source]

Implement setattr(self, name, value).

Return type:: None

__setstate__(state)[source]

Return type:: None

__signature__: ClassVar[Signature] = <Signature (*, data: kittycad.models.surface_area.SurfaceArea, type: Literal['surface_area'] = 'surface_area') -> None>[source]: The synthesized __init__ [Signature][inspect.Signature] of the model.

__slots__ = ('__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__')[source]

__str__()[source]

Return str(self).

Return type:: str

_abc_impl = <_abc._abc_data object>[source]

_calculate_keys(*args, **kwargs)[source]

Return type:: Any

_check_frozen(name, value)[source]

Return type:: None

_copy_and_set_values(*args, **kwargs)[source]

Return type:: Any

classmethod _get_value(*args, **kwargs)[source]

Return type:: Any

_iter(*args, **kwargs)[source]

Return type:: Any

classmethod construct(_fields_set=None, **values)[source]

Return type:: Self

copy(*, include=None, exclude=None, update=None, deep=False)[source]

Returns a copy of the model.

!!! warning “Deprecated”: This method is now deprecated; use model_copy instead.

If you need include or exclude, use:

`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `

Parameters:

include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.

Returns:

A copy of the model with included, excluded and updated fields as specified.

data: SurfaceArea[source]

dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)[source]

Return type:: Dict[str, Any]

classmethod from_orm(obj)[source]

Return type:: Self

json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)[source]

Return type:: str

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}[source]: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'protected_namespaces': ()}[source]: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod model_construct(_fields_set=None, **values)[source]

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note: model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == 'allow', then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == 'ignore' (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == 'forbid' does not result in an error if extra values are passed, but they will be ignored.

Parameters:

_fields_set (set[str] | None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.
values (Any) – Trusted or pre-validated data dictionary.

Return type:

Self

Returns:

A new instance of the Model class with validated data.

model_copy(*, update=None, deep=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy

Returns a copy of the model.

Parameters:

update (dict[str, Any] | None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.
deep (bool) – Set to True to make a deep copy of the model.

Return type:

Self

Returns:

New model instance.

model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters:

mode (Union[Literal['json', 'python'], str]) – The mode in which to_python 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.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to include in the output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to exclude from the output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to use the field’s alias in the dictionary key if defined.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A dictionary representation of the model.

model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

Generates a JSON representation of the model using Pydantic’s to_json method.

Parameters:

indent (int | None) – Indentation to use in the JSON output. If None is passed, the output will be compact.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to include in the JSON output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to exclude from the JSON output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to serialize using field aliases.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A JSON string representation of the model.

property model_extra: dict[str, Any] | None[source]

Get extra fields set during validation.

Returns:: A dictionary of extra fields, or None if config.extra is not set to "allow".

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=SurfaceArea, required=True), 'type': FieldInfo(annotation=Literal['surface_area'], required=False, default='surface_area')}[source]

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

property model_fields_set: set[str][source]

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,: i.e. that were not filled from defaults.

classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')[source]

Generates a JSON schema for a model class.

Parameters:

by_alias (bool) – Whether to use attribute aliases or not.
ref_template (str) – The reference template.
schema_generator (type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modifications
mode (Literal['validation', 'serialization']) – The mode in which to generate the schema.

Return type:

Returns:

The JSON schema for the given model class.

classmethod model_parametrized_name(params)[source]

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

Parameters:: params (tuple[type[Any], ...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.
Return type:: str
Returns:: String representing the new class where params are passed to cls as type variables.
Raises:: TypeError – Raised when trying to generate concrete names for non-generic models.

model_post_init(_BaseModel__context)[source]

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

Return type:: None

classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)[source]

Try to rebuild the pydantic-core schema for the model.

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.

Parameters:

force (bool) – Whether to force the rebuilding of the model schema, defaults to False.
raise_errors (bool) – Whether to raise errors, defaults to True.
_parent_namespace_depth (int) – The depth level of the parent namespace, defaults to 2.
_types_namespace (dict[str, Any] | None) – The types namespace, defaults to None.

Return type:

Returns:

Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.

classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)[source]

Validate a pydantic model instance.

Parameters:

obj (Any) – The object to validate.
strict (bool | None) – Whether to enforce types strictly.
from_attributes (bool | None) – Whether to extract data from object attributes.
context (Any | None) – Additional context to pass to the validator.

Raises:

ValidationError – If the object could not be validated.

Return type:

Self

Returns:

The validated model instance.

classmethod model_validate_json(json_data, *, strict=None, context=None)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing

Validate the given JSON data against the Pydantic model.

Parameters:

json_data (str | bytes | bytearray) – The JSON data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

Raises:

ValidationError – If json_data is not a JSON string or the object could not be validated.

classmethod model_validate_strings(obj, *, strict=None, context=None)[source]

Validate the given object with string data against the Pydantic model.

Parameters:

obj (Any) – The object containing string data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod parse_obj(obj)[source]

Return type:: Self

classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod schema(by_alias=True, ref_template='#/$defs/{model}')[source]

Return type:: Dict[str, Any]

classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)[source]

Return type:: str

type: Literal['surface_area'][source]

classmethod update_forward_refs(**localns)[source]

Return type:: None

classmethod validate(value)[source]

Return type:: Self

class kittycad.models.ok_modeling_cmd_response.OptionTakeSnapshot(**data)[source][source]

The response to the ‘TakeSnapshot’ endpoint

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__abstractmethods__ = frozenset({})[source]

__annotations__ = {'__class_vars__': 'ClassVar[set[str]]', '__private_attributes__': 'ClassVar[Dict[str, ModelPrivateAttr]]', '__pydantic_complete__': 'ClassVar[bool]', '__pydantic_core_schema__': 'ClassVar[CoreSchema]', '__pydantic_custom_init__': 'ClassVar[bool]', '__pydantic_decorators__': 'ClassVar[_decorators.DecoratorInfos]', '__pydantic_extra__': 'dict[str, Any] | None', '__pydantic_fields_set__': 'set[str]', '__pydantic_generic_metadata__': 'ClassVar[_generics.PydanticGenericMetadata]', '__pydantic_parent_namespace__': 'ClassVar[Dict[str, Any] | None]', '__pydantic_post_init__': "ClassVar[None | Literal['model_post_init']]", '__pydantic_private__': 'dict[str, Any] | None', '__pydantic_root_model__': 'ClassVar[bool]', '__pydantic_serializer__': 'ClassVar[SchemaSerializer]', '__pydantic_validator__': 'ClassVar[SchemaValidator | PluggableSchemaValidator]', '__signature__': 'ClassVar[Signature]', 'data': <class 'kittycad.models.take_snapshot.TakeSnapshot'>, 'model_computed_fields': 'ClassVar[Dict[str, ComputedFieldInfo]]', 'model_config': 'ClassVar[ConfigDict]', 'model_fields': 'ClassVar[Dict[str, FieldInfo]]', 'type': typing.Literal['take_snapshot']}[source]

classmethod __class_getitem__(typevar_values)[source]

Return type:: type[BaseModel] | PydanticRecursiveRef

__class_vars__: ClassVar[set[str]] = {}[source]: The names of the class variables defined on the model.

__copy__()[source]

Returns a shallow copy of the model.

Return type:: Self

__deepcopy__(memo=None)[source]

Returns a deep copy of the model.

Return type:: Self

__delattr__(item)[source]

Implement delattr(self, name).

Return type:: Any

__dict__[source]

__eq__(other)[source]

Return self==value.

Return type:: bool

property __fields_set__: set[str][source]

classmethod __get_pydantic_core_schema__(source, handler, /)[source]

Hook into generating the model’s CoreSchema.

Parameters:

source (type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.
handler (GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.

Return type:

Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]

Returns:

A pydantic-core CoreSchema.

classmethod __get_pydantic_json_schema__(core_schema, handler, /)[source]

Hook into generating the model’s JSON schema.

Parameters:

core_schema (Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({'type': 'nullable', 'schema': current_schema}), or just call the handler with the original schema.
handler (GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.

Return type:

Returns:

A JSON schema, as a Python object.

__getattr__(item)[source]

Return type:: Any

__getstate__()[source]

Helper for pickle.

Return type:: dict[Any, Any]

__hash__ = None[source]

__init__(**data)[source]

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__iter__()[source]

So dict(model) works.

Return type:: Generator[Tuple[str, Any], None, None]

__module__ = 'kittycad.models.ok_modeling_cmd_response'[source]

__pretty__(fmt, **kwargs)[source]

Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.

Return type:: Generator[Any, None, None]

__private_attributes__: ClassVar[Dict[str, ModelPrivateAttr]] = {}[source]: Metadata about the private attributes of the model.

__pydantic_complete__: ClassVar[bool] = True[source]: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__: ClassVar[CoreSchema] = {'cls': <class 'kittycad.models.ok_modeling_cmd_response.OptionTakeSnapshot'>, 'config': {'title': 'OptionTakeSnapshot'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.ok_modeling_cmd_response.OptionTakeSnapshot'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.ok_modeling_cmd_response.OptionTakeSnapshot'>>]}, 'ref': 'kittycad.models.ok_modeling_cmd_response.OptionTakeSnapshot:94667213704656', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'data': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.take_snapshot.TakeSnapshot'>, 'config': {'title': 'TakeSnapshot'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.take_snapshot.TakeSnapshot'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.take_snapshot.TakeSnapshot'>>]}, 'ref': 'kittycad.models.take_snapshot.TakeSnapshot:94667212591584', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'contents': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'function': {'function': <bound method Base64Data.validate of <class 'kittycad.models.base64data.Base64Data'>>, 'type': 'no-info'}, 'schema': {'choices': [{'type': 'str'}, {'type': 'bytes'}], 'type': 'union'}, 'serialization': {'function': <bound method Base64Data.serialize of <class 'kittycad.models.base64data.Base64Data'>>, 'type': 'function-plain'}, 'type': 'function-after'}, 'type': 'model-field'}}, 'model_name': 'TakeSnapshot', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}, 'type': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': 'take_snapshot', 'schema': {'expected': ['take_snapshot'], 'type': 'literal'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'OptionTakeSnapshot', 'type': 'model-fields'}, 'type': 'model'}[source]: The core schema of the model.

__pydantic_custom_init__: ClassVar[bool] = False[source]: Whether the model has a custom __init__ method.

__pydantic_decorators__: ClassVar[_decorators.DecoratorInfos] = DecoratorInfos(validators={}, field_validators={}, root_validators={}, field_serializers={}, model_serializers={}, model_validators={}, computed_fields={})[source]: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_extra__: dict[str, Any] | None[source]: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to 'allow'.

__pydantic_fields_set__: set[str][source]: The names of fields explicitly set during instantiation.

__pydantic_generic_metadata__: ClassVar[_generics.PydanticGenericMetadata] = {'args': (), 'origin': None, 'parameters': ()}[source]: 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.

classmethod __pydantic_init_subclass__(**kwargs)[source]

This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.

This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.

This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.

Parameters:: **kwargs (Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.
Return type:: None

__pydantic_parent_namespace__: ClassVar[Dict[str, Any] | None] = None[source]: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__: ClassVar[None | Literal['model_post_init']] = None[source]: The name of the post-init method for the model, if defined.

__pydantic_private__: dict[str, Any] | None[source]: Values of private attributes set on the model instance.

__pydantic_root_model__: ClassVar[bool] = False[source]: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__: ClassVar[SchemaSerializer] = SchemaSerializer(serializer=Model( ModelSerializer { class: Py( 0x000056196da50dd0, ), serializer: Fields( GeneralFieldsSerializer { fields: { "data": SerField { key_py: Py( 0x00007f9038238fa0, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196d9411e0, ), serializer: Fields( GeneralFieldsSerializer { fields: { "contents": SerField { key_py: Py( 0x00007f90381f5880, ), alias: None, alias_py: None, serializer: Some( Function( FunctionPlainSerializer { func: Py( 0x00007f903353d480, ), name: "plain_function[serialize]", function_name: "serialize", return_serializer: Any( AnySerializer, ), fallback_serializer: None, when_used: Always, is_field_serializer: false, info_arg: false, }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 1, }, ), has_extra: false, root_model: false, name: "TakeSnapshot", }, ), ), required: true, }, "type": SerField { key_py: Py( 0x00007f903823d958, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f90346e7730, ), ), serializer: Literal( LiteralSerializer { expected_int: {}, expected_str: { "take_snapshot", }, expected_py: None, name: "literal['take_snapshot']", }, ), }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "OptionTakeSnapshot", }, ), definitions=[])[source]: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__: ClassVar[SchemaValidator | PluggableSchemaValidator] = SchemaValidator(title="OptionTakeSnapshot", validator=Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "data", lookup_key: Simple { key: "data", py_key: Py( 0x00007f903336dfb0, ), path: LookupPath( [ S( "data", Py( 0x00007f903336ddd0, ), ), ], ), }, name_py: Py( 0x00007f9038238fa0, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "contents", lookup_key: Simple { key: "contents", py_key: Py( 0x00007f90333a02f0, ), path: LookupPath( [ S( "contents", Py( 0x00007f90333a02b0, ), ), ], ), }, name_py: Py( 0x00007f90381f5880, ), validator: FunctionAfter( FunctionAfterValidator { validator: Union( UnionValidator { mode: Smart, choices: [ ( Str( StrValidator { strict: false, coerce_numbers_to_str: false, }, ), None, ), ( Bytes( BytesValidator { strict: false, bytes_mode: ValBytesMode { ser: Utf8, }, }, ), None, ), ], custom_error: None, strict: false, name: "union[str,bytes]", }, ), func: Py( 0x00007f903353cd40, ), config: Py( 0x00007f90333a0040, ), name: "function-after[validate(), union[str,bytes]]", field_name: None, info_arg: false, }, ), frozen: false, }, ], model_name: "TakeSnapshot", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d9411e0, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "TakeSnapshot", }, ), frozen: false, }, Field { name: "type", lookup_key: Simple { key: "type", py_key: Py( 0x00007f903336dc20, ), path: LookupPath( [ S( "type", Py( 0x00007f903336f270, ), ), ], ), }, name_py: Py( 0x00007f903823d958, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f90346e7730, ), ), on_error: Raise, validator: Literal( LiteralValidator { lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "take_snapshot": 0, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f90346e7730, ), ], }, expected_repr: "'take_snapshot'", name: "literal['take_snapshot']", }, ), validate_default: false, copy_default: false, name: "default[literal['take_snapshot']]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "OptionTakeSnapshot", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196da50dd0, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "OptionTakeSnapshot", }, ), definitions=[], cache_strings=True)[source]: The pydantic-core SchemaValidator used to validate instances of the model.

__repr__()[source]

Return repr(self).

Return type:: str

__repr_args__()[source]

Return type:: Iterable[tuple[str | None, Any]]

__repr_name__()[source]

Name of the instance’s class, used in __repr__.

Return type:: str

__repr_str__(join_str)[source]

Return type:: str

__rich_repr__()[source]

Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.

Return type:: Iterable[Any | tuple[Any] | tuple[str, Any] | tuple[str, Any, Any]]

__setattr__(name, value)[source]

Implement setattr(self, name, value).

Return type:: None

__setstate__(state)[source]

Return type:: None

__signature__: ClassVar[Signature] = <Signature (*, data: kittycad.models.take_snapshot.TakeSnapshot, type: Literal['take_snapshot'] = 'take_snapshot') -> None>[source]: The synthesized __init__ [Signature][inspect.Signature] of the model.

__slots__ = ('__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__')[source]

__str__()[source]

Return str(self).

Return type:: str

_abc_impl = <_abc._abc_data object>[source]

_calculate_keys(*args, **kwargs)[source]

Return type:: Any

_check_frozen(name, value)[source]

Return type:: None

_copy_and_set_values(*args, **kwargs)[source]

Return type:: Any

classmethod _get_value(*args, **kwargs)[source]

Return type:: Any

_iter(*args, **kwargs)[source]

Return type:: Any

classmethod construct(_fields_set=None, **values)[source]

Return type:: Self

copy(*, include=None, exclude=None, update=None, deep=False)[source]

Returns a copy of the model.

!!! warning “Deprecated”: This method is now deprecated; use model_copy instead.

If you need include or exclude, use:

`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `

Parameters:

include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.

Returns:

A copy of the model with included, excluded and updated fields as specified.

data: TakeSnapshot[source]

dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)[source]

Return type:: Dict[str, Any]

classmethod from_orm(obj)[source]

Return type:: Self

json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)[source]

Return type:: str

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}[source]: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'protected_namespaces': ()}[source]: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod model_construct(_fields_set=None, **values)[source]

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note: model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == 'allow', then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == 'ignore' (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == 'forbid' does not result in an error if extra values are passed, but they will be ignored.

Parameters:

_fields_set (set[str] | None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.
values (Any) – Trusted or pre-validated data dictionary.

Return type:

Self

Returns:

A new instance of the Model class with validated data.

model_copy(*, update=None, deep=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy

Returns a copy of the model.

Parameters:

update (dict[str, Any] | None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.
deep (bool) – Set to True to make a deep copy of the model.

Return type:

Self

Returns:

New model instance.

model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters:

mode (Union[Literal['json', 'python'], str]) – The mode in which to_python 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.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to include in the output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to exclude from the output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to use the field’s alias in the dictionary key if defined.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A dictionary representation of the model.

model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

Generates a JSON representation of the model using Pydantic’s to_json method.

Parameters:

indent (int | None) – Indentation to use in the JSON output. If None is passed, the output will be compact.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to include in the JSON output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to exclude from the JSON output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to serialize using field aliases.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A JSON string representation of the model.

property model_extra: dict[str, Any] | None[source]

Get extra fields set during validation.

Returns:: A dictionary of extra fields, or None if config.extra is not set to "allow".

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=TakeSnapshot, required=True), 'type': FieldInfo(annotation=Literal['take_snapshot'], required=False, default='take_snapshot')}[source]

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

property model_fields_set: set[str][source]

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,: i.e. that were not filled from defaults.

classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')[source]

Generates a JSON schema for a model class.

Parameters:

by_alias (bool) – Whether to use attribute aliases or not.
ref_template (str) – The reference template.
schema_generator (type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modifications
mode (Literal['validation', 'serialization']) – The mode in which to generate the schema.

Return type:

Returns:

The JSON schema for the given model class.

classmethod model_parametrized_name(params)[source]

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

Parameters:: params (tuple[type[Any], ...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.
Return type:: str
Returns:: String representing the new class where params are passed to cls as type variables.
Raises:: TypeError – Raised when trying to generate concrete names for non-generic models.

model_post_init(_BaseModel__context)[source]

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

Return type:: None

classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)[source]

Try to rebuild the pydantic-core schema for the model.

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.

Parameters:

force (bool) – Whether to force the rebuilding of the model schema, defaults to False.
raise_errors (bool) – Whether to raise errors, defaults to True.
_parent_namespace_depth (int) – The depth level of the parent namespace, defaults to 2.
_types_namespace (dict[str, Any] | None) – The types namespace, defaults to None.

Return type:

Returns:

Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.

classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)[source]

Validate a pydantic model instance.

Parameters:

obj (Any) – The object to validate.
strict (bool | None) – Whether to enforce types strictly.
from_attributes (bool | None) – Whether to extract data from object attributes.
context (Any | None) – Additional context to pass to the validator.

Raises:

ValidationError – If the object could not be validated.

Return type:

Self

Returns:

The validated model instance.

classmethod model_validate_json(json_data, *, strict=None, context=None)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing

Validate the given JSON data against the Pydantic model.

Parameters:

json_data (str | bytes | bytearray) – The JSON data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

Raises:

ValidationError – If json_data is not a JSON string or the object could not be validated.

classmethod model_validate_strings(obj, *, strict=None, context=None)[source]

Validate the given object with string data against the Pydantic model.

Parameters:

obj (Any) – The object containing string data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod parse_obj(obj)[source]

Return type:: Self

classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod schema(by_alias=True, ref_template='#/$defs/{model}')[source]

Return type:: Dict[str, Any]

classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)[source]

Return type:: str

type: Literal['take_snapshot'][source]

classmethod update_forward_refs(**localns)[source]

Return type:: None

classmethod validate(value)[source]

Return type:: Self

class kittycad.models.ok_modeling_cmd_response.OptionUpdateAnnotation(**data)[source][source]

The response to the ‘UpdateAnnotation’ endpoint

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__abstractmethods__ = frozenset({})[source]

__annotations__ = {'__class_vars__': 'ClassVar[set[str]]', '__private_attributes__': 'ClassVar[Dict[str, ModelPrivateAttr]]', '__pydantic_complete__': 'ClassVar[bool]', '__pydantic_core_schema__': 'ClassVar[CoreSchema]', '__pydantic_custom_init__': 'ClassVar[bool]', '__pydantic_decorators__': 'ClassVar[_decorators.DecoratorInfos]', '__pydantic_extra__': 'dict[str, Any] | None', '__pydantic_fields_set__': 'set[str]', '__pydantic_generic_metadata__': 'ClassVar[_generics.PydanticGenericMetadata]', '__pydantic_parent_namespace__': 'ClassVar[Dict[str, Any] | None]', '__pydantic_post_init__': "ClassVar[None | Literal['model_post_init']]", '__pydantic_private__': 'dict[str, Any] | None', '__pydantic_root_model__': 'ClassVar[bool]', '__pydantic_serializer__': 'ClassVar[SchemaSerializer]', '__pydantic_validator__': 'ClassVar[SchemaValidator | PluggableSchemaValidator]', '__signature__': 'ClassVar[Signature]', 'data': <class 'kittycad.models.update_annotation.UpdateAnnotation'>, 'model_computed_fields': 'ClassVar[Dict[str, ComputedFieldInfo]]', 'model_config': 'ClassVar[ConfigDict]', 'model_fields': 'ClassVar[Dict[str, FieldInfo]]', 'type': typing.Literal['update_annotation']}[source]

classmethod __class_getitem__(typevar_values)[source]

Return type:: type[BaseModel] | PydanticRecursiveRef

__class_vars__: ClassVar[set[str]] = {}[source]: The names of the class variables defined on the model.

__copy__()[source]

Returns a shallow copy of the model.

Return type:: Self

__deepcopy__(memo=None)[source]

Returns a deep copy of the model.

Return type:: Self

__delattr__(item)[source]

Implement delattr(self, name).

Return type:: Any

__dict__[source]

__eq__(other)[source]

Return self==value.

Return type:: bool

property __fields_set__: set[str][source]

classmethod __get_pydantic_core_schema__(source, handler, /)[source]

Hook into generating the model’s CoreSchema.

Parameters:

source (type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.
handler (GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.

Return type:

Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]

Returns:

A pydantic-core CoreSchema.

classmethod __get_pydantic_json_schema__(core_schema, handler, /)[source]

Hook into generating the model’s JSON schema.

Parameters:

core_schema (Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({'type': 'nullable', 'schema': current_schema}), or just call the handler with the original schema.
handler (GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.

Return type:

Returns:

A JSON schema, as a Python object.

__getattr__(item)[source]

Return type:: Any

__getstate__()[source]

Helper for pickle.

Return type:: dict[Any, Any]

__hash__ = None[source]

__init__(**data)[source]

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__iter__()[source]

So dict(model) works.

Return type:: Generator[Tuple[str, Any], None, None]

__module__ = 'kittycad.models.ok_modeling_cmd_response'[source]

__pretty__(fmt, **kwargs)[source]

Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.

Return type:: Generator[Any, None, None]

__private_attributes__: ClassVar[Dict[str, ModelPrivateAttr]] = {}[source]: Metadata about the private attributes of the model.

__pydantic_complete__: ClassVar[bool] = True[source]: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__: ClassVar[CoreSchema] = {'cls': <class 'kittycad.models.ok_modeling_cmd_response.OptionUpdateAnnotation'>, 'config': {'title': 'OptionUpdateAnnotation'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.ok_modeling_cmd_response.OptionUpdateAnnotation'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.ok_modeling_cmd_response.OptionUpdateAnnotation'>>]}, 'ref': 'kittycad.models.ok_modeling_cmd_response.OptionUpdateAnnotation:94667212887648', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'data': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.update_annotation.UpdateAnnotation'>, 'config': {'title': 'UpdateAnnotation'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.update_annotation.UpdateAnnotation'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.update_annotation.UpdateAnnotation'>>]}, 'ref': 'kittycad.models.update_annotation.UpdateAnnotation:94667212570672', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {}, 'model_name': 'UpdateAnnotation', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}, 'type': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': 'update_annotation', 'schema': {'expected': ['update_annotation'], 'type': 'literal'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'OptionUpdateAnnotation', 'type': 'model-fields'}, 'type': 'model'}[source]: The core schema of the model.

__pydantic_custom_init__: ClassVar[bool] = False[source]: Whether the model has a custom __init__ method.

__pydantic_decorators__: ClassVar[_decorators.DecoratorInfos] = DecoratorInfos(validators={}, field_validators={}, root_validators={}, field_serializers={}, model_serializers={}, model_validators={}, computed_fields={})[source]: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_extra__: dict[str, Any] | None[source]: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to 'allow'.

__pydantic_fields_set__: set[str][source]: The names of fields explicitly set during instantiation.

__pydantic_generic_metadata__: ClassVar[_generics.PydanticGenericMetadata] = {'args': (), 'origin': None, 'parameters': ()}[source]: 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.

classmethod __pydantic_init_subclass__(**kwargs)[source]

This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.

This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.

This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.

Parameters:: **kwargs (Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.
Return type:: None

__pydantic_parent_namespace__: ClassVar[Dict[str, Any] | None] = None[source]: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__: ClassVar[None | Literal['model_post_init']] = None[source]: The name of the post-init method for the model, if defined.

__pydantic_private__: dict[str, Any] | None[source]: Values of private attributes set on the model instance.

__pydantic_root_model__: ClassVar[bool] = False[source]: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__: ClassVar[SchemaSerializer] = SchemaSerializer(serializer=Model( ModelSerializer { class: Py( 0x000056196d989660, ), serializer: Fields( GeneralFieldsSerializer { fields: { "type": SerField { key_py: Py( 0x00007f903823d958, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f90346ed0f0, ), ), serializer: Literal( LiteralSerializer { expected_int: {}, expected_str: { "update_annotation", }, expected_py: None, name: "literal['update_annotation']", }, ), }, ), ), required: true, }, "data": SerField { key_py: Py( 0x00007f9038238fa0, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196d93c030, ), serializer: Fields( GeneralFieldsSerializer { fields: {}, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 0, }, ), has_extra: false, root_model: false, name: "UpdateAnnotation", }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "OptionUpdateAnnotation", }, ), definitions=[])[source]: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__: ClassVar[SchemaValidator | PluggableSchemaValidator] = SchemaValidator(title="OptionUpdateAnnotation", validator=Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "data", lookup_key: Simple { key: "data", py_key: Py( 0x00007f90334d51d0, ), path: LookupPath( [ S( "data", Py( 0x00007f90334d5200, ), ), ], ), }, name_py: Py( 0x00007f9038238fa0, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [], model_name: "UpdateAnnotation", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d93c030, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "UpdateAnnotation", }, ), frozen: false, }, Field { name: "type", lookup_key: Simple { key: "type", py_key: Py( 0x00007f90334d5230, ), path: LookupPath( [ S( "type", Py( 0x00007f90334d5260, ), ), ], ), }, name_py: Py( 0x00007f903823d958, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f90346ed0f0, ), ), on_error: Raise, validator: Literal( LiteralValidator { lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "update_annotation": 0, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f90346ed0f0, ), ], }, expected_repr: "'update_annotation'", name: "literal['update_annotation']", }, ), validate_default: false, copy_default: false, name: "default[literal['update_annotation']]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "OptionUpdateAnnotation", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d989660, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "OptionUpdateAnnotation", }, ), definitions=[], cache_strings=True)[source]: The pydantic-core SchemaValidator used to validate instances of the model.

__repr__()[source]

Return repr(self).

Return type:: str

__repr_args__()[source]

Return type:: Iterable[tuple[str | None, Any]]

__repr_name__()[source]

Name of the instance’s class, used in __repr__.

Return type:: str

__repr_str__(join_str)[source]

Return type:: str

__rich_repr__()[source]

Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.

Return type:: Iterable[Any | tuple[Any] | tuple[str, Any] | tuple[str, Any, Any]]

__setattr__(name, value)[source]

Implement setattr(self, name, value).

Return type:: None

__setstate__(state)[source]

Return type:: None

__signature__: ClassVar[Signature] = <Signature (*, data: kittycad.models.update_annotation.UpdateAnnotation, type: Literal['update_annotation'] = 'update_annotation') -> None>[source]: The synthesized __init__ [Signature][inspect.Signature] of the model.

__slots__ = ('__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__')[source]

__str__()[source]

Return str(self).

Return type:: str

_abc_impl = <_abc._abc_data object>[source]

_calculate_keys(*args, **kwargs)[source]

Return type:: Any

_check_frozen(name, value)[source]

Return type:: None

_copy_and_set_values(*args, **kwargs)[source]

Return type:: Any

classmethod _get_value(*args, **kwargs)[source]

Return type:: Any

_iter(*args, **kwargs)[source]

Return type:: Any

classmethod construct(_fields_set=None, **values)[source]

Return type:: Self

copy(*, include=None, exclude=None, update=None, deep=False)[source]

Returns a copy of the model.

!!! warning “Deprecated”: This method is now deprecated; use model_copy instead.

If you need include or exclude, use:

`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `

Parameters:

include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.

Returns:

A copy of the model with included, excluded and updated fields as specified.

data: UpdateAnnotation[source]

dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)[source]

Return type:: Dict[str, Any]

classmethod from_orm(obj)[source]

Return type:: Self

json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)[source]

Return type:: str

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}[source]: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'protected_namespaces': ()}[source]: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod model_construct(_fields_set=None, **values)[source]

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note: model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == 'allow', then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == 'ignore' (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == 'forbid' does not result in an error if extra values are passed, but they will be ignored.

Parameters:

_fields_set (set[str] | None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.
values (Any) – Trusted or pre-validated data dictionary.

Return type:

Self

Returns:

A new instance of the Model class with validated data.

model_copy(*, update=None, deep=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy

Returns a copy of the model.

Parameters:

update (dict[str, Any] | None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.
deep (bool) – Set to True to make a deep copy of the model.

Return type:

Self

Returns:

New model instance.

model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters:

mode (Union[Literal['json', 'python'], str]) – The mode in which to_python 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.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to include in the output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to exclude from the output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to use the field’s alias in the dictionary key if defined.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A dictionary representation of the model.

model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

Generates a JSON representation of the model using Pydantic’s to_json method.

Parameters:

indent (int | None) – Indentation to use in the JSON output. If None is passed, the output will be compact.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to include in the JSON output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to exclude from the JSON output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to serialize using field aliases.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A JSON string representation of the model.

property model_extra: dict[str, Any] | None[source]

Get extra fields set during validation.

Returns:: A dictionary of extra fields, or None if config.extra is not set to "allow".

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=UpdateAnnotation, required=True), 'type': FieldInfo(annotation=Literal['update_annotation'], required=False, default='update_annotation')}[source]

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

property model_fields_set: set[str][source]

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,: i.e. that were not filled from defaults.

classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')[source]

Generates a JSON schema for a model class.

Parameters:

by_alias (bool) – Whether to use attribute aliases or not.
ref_template (str) – The reference template.
schema_generator (type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modifications
mode (Literal['validation', 'serialization']) – The mode in which to generate the schema.

Return type:

Returns:

The JSON schema for the given model class.

classmethod model_parametrized_name(params)[source]

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

Parameters:: params (tuple[type[Any], ...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.
Return type:: str
Returns:: String representing the new class where params are passed to cls as type variables.
Raises:: TypeError – Raised when trying to generate concrete names for non-generic models.

model_post_init(_BaseModel__context)[source]

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

Return type:: None

classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)[source]

Try to rebuild the pydantic-core schema for the model.

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.

Parameters:

force (bool) – Whether to force the rebuilding of the model schema, defaults to False.
raise_errors (bool) – Whether to raise errors, defaults to True.
_parent_namespace_depth (int) – The depth level of the parent namespace, defaults to 2.
_types_namespace (dict[str, Any] | None) – The types namespace, defaults to None.

Return type:

Returns:

Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.

classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)[source]

Validate a pydantic model instance.

Parameters:

obj (Any) – The object to validate.
strict (bool | None) – Whether to enforce types strictly.
from_attributes (bool | None) – Whether to extract data from object attributes.
context (Any | None) – Additional context to pass to the validator.

Raises:

ValidationError – If the object could not be validated.

Return type:

Self

Returns:

The validated model instance.

classmethod model_validate_json(json_data, *, strict=None, context=None)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing

Validate the given JSON data against the Pydantic model.

Parameters:

json_data (str | bytes | bytearray) – The JSON data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

Raises:

ValidationError – If json_data is not a JSON string or the object could not be validated.

classmethod model_validate_strings(obj, *, strict=None, context=None)[source]

Validate the given object with string data against the Pydantic model.

Parameters:

obj (Any) – The object containing string data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod parse_obj(obj)[source]

Return type:: Self

classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod schema(by_alias=True, ref_template='#/$defs/{model}')[source]

Return type:: Dict[str, Any]

classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)[source]

Return type:: str

type: Literal['update_annotation'][source]

classmethod update_forward_refs(**localns)[source]

Return type:: None

classmethod validate(value)[source]

Return type:: Self

class kittycad.models.ok_modeling_cmd_response.OptionViewIsometric(**data)[source][source]

The response to the ‘ViewIsometric’ endpoint

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__abstractmethods__ = frozenset({})[source]

__annotations__ = {'__class_vars__': 'ClassVar[set[str]]', '__private_attributes__': 'ClassVar[Dict[str, ModelPrivateAttr]]', '__pydantic_complete__': 'ClassVar[bool]', '__pydantic_core_schema__': 'ClassVar[CoreSchema]', '__pydantic_custom_init__': 'ClassVar[bool]', '__pydantic_decorators__': 'ClassVar[_decorators.DecoratorInfos]', '__pydantic_extra__': 'dict[str, Any] | None', '__pydantic_fields_set__': 'set[str]', '__pydantic_generic_metadata__': 'ClassVar[_generics.PydanticGenericMetadata]', '__pydantic_parent_namespace__': 'ClassVar[Dict[str, Any] | None]', '__pydantic_post_init__': "ClassVar[None | Literal['model_post_init']]", '__pydantic_private__': 'dict[str, Any] | None', '__pydantic_root_model__': 'ClassVar[bool]', '__pydantic_serializer__': 'ClassVar[SchemaSerializer]', '__pydantic_validator__': 'ClassVar[SchemaValidator | PluggableSchemaValidator]', '__signature__': 'ClassVar[Signature]', 'data': <class 'kittycad.models.view_isometric.ViewIsometric'>, 'model_computed_fields': 'ClassVar[Dict[str, ComputedFieldInfo]]', 'model_config': 'ClassVar[ConfigDict]', 'model_fields': 'ClassVar[Dict[str, FieldInfo]]', 'type': typing.Literal['view_isometric']}[source]

classmethod __class_getitem__(typevar_values)[source]

Return type:: type[BaseModel] | PydanticRecursiveRef

__class_vars__: ClassVar[set[str]] = {}[source]: The names of the class variables defined on the model.

__copy__()[source]

Returns a shallow copy of the model.

Return type:: Self

__deepcopy__(memo=None)[source]

Returns a deep copy of the model.

Return type:: Self

__delattr__(item)[source]

Implement delattr(self, name).

Return type:: Any

__dict__[source]

__eq__(other)[source]

Return self==value.

Return type:: bool

property __fields_set__: set[str][source]

classmethod __get_pydantic_core_schema__(source, handler, /)[source]

Hook into generating the model’s CoreSchema.

Parameters:

source (type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.
handler (GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.

Return type:

Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]

Returns:

A pydantic-core CoreSchema.

classmethod __get_pydantic_json_schema__(core_schema, handler, /)[source]

Hook into generating the model’s JSON schema.

Parameters:

core_schema (Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({'type': 'nullable', 'schema': current_schema}), or just call the handler with the original schema.
handler (GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.

Return type:

Returns:

A JSON schema, as a Python object.

__getattr__(item)[source]

Return type:: Any

__getstate__()[source]

Helper for pickle.

Return type:: dict[Any, Any]

__hash__ = None[source]

__init__(**data)[source]

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__iter__()[source]

So dict(model) works.

Return type:: Generator[Tuple[str, Any], None, None]

__module__ = 'kittycad.models.ok_modeling_cmd_response'[source]

__pretty__(fmt, **kwargs)[source]

Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.

Return type:: Generator[Any, None, None]

__private_attributes__: ClassVar[Dict[str, ModelPrivateAttr]] = {}[source]: Metadata about the private attributes of the model.

__pydantic_complete__: ClassVar[bool] = True[source]: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__: ClassVar[CoreSchema] = {'definitions': [{'cls': <class 'kittycad.models.point3d.Point3d'>, 'config': {'title': 'Point3d'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.point3d.Point3d'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.point3d.Point3d'>>]}, 'ref': 'kittycad.models.point3d.Point3d:94667194426368', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'x': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'type': 'float'}, 'type': 'model-field'}, 'y': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'type': 'float'}, 'type': 'model-field'}, 'z': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'type': 'float'}, 'type': 'model-field'}}, 'model_name': 'Point3d', 'type': 'model-fields'}, 'type': 'model'}], 'schema': {'cls': <class 'kittycad.models.ok_modeling_cmd_response.OptionViewIsometric'>, 'config': {'title': 'OptionViewIsometric'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.ok_modeling_cmd_response.OptionViewIsometric'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.ok_modeling_cmd_response.OptionViewIsometric'>>]}, 'ref': 'kittycad.models.ok_modeling_cmd_response.OptionViewIsometric:94667213491200', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'data': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.view_isometric.ViewIsometric'>, 'config': {'title': 'ViewIsometric'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.view_isometric.ViewIsometric'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.view_isometric.ViewIsometric'>>]}, 'ref': 'kittycad.models.view_isometric.ViewIsometric:94667212573888', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'settings': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.camera_settings.CameraSettings'>, 'config': {'title': 'CameraSettings'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.camera_settings.CameraSettings'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.camera_settings.CameraSettings'>>]}, 'ref': 'kittycad.models.camera_settings.CameraSettings:94667204631840', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'center': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'schema_ref': 'kittycad.models.point3d.Point3d:94667194426368', 'type': 'definition-ref'}, 'type': 'model-field'}, 'fov_y': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': None, 'schema': {'schema': {'type': 'float'}, 'type': 'nullable'}, 'type': 'default'}, 'type': 'model-field'}, 'orientation': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.point4d.Point4d'>, 'config': {'title': 'Point4d'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.point4d.Point4d'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.point4d.Point4d'>>]}, 'ref': 'kittycad.models.point4d.Point4d:94667204627760', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'w': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'type': 'float'}, 'type': 'model-field'}, 'x': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'type': 'float'}, 'type': 'model-field'}, 'y': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'type': 'float'}, 'type': 'model-field'}, 'z': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'type': 'float'}, 'type': 'model-field'}}, 'model_name': 'Point4d', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}, 'ortho': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'type': 'bool'}, 'type': 'model-field'}, 'ortho_scale': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': None, 'schema': {'schema': {'type': 'float'}, 'type': 'nullable'}, 'type': 'default'}, 'type': 'model-field'}, 'pos': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'schema_ref': 'kittycad.models.point3d.Point3d:94667194426368', 'type': 'definition-ref'}, 'type': 'model-field'}, 'up': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'schema_ref': 'kittycad.models.point3d.Point3d:94667194426368', 'type': 'definition-ref'}, 'type': 'model-field'}}, 'model_name': 'CameraSettings', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}}, 'model_name': 'ViewIsometric', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}, 'type': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': 'view_isometric', 'schema': {'expected': ['view_isometric'], 'type': 'literal'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'OptionViewIsometric', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'definitions'}[source]: The core schema of the model.

__pydantic_custom_init__: ClassVar[bool] = False[source]: Whether the model has a custom __init__ method.

__pydantic_decorators__: ClassVar[_decorators.DecoratorInfos] = DecoratorInfos(validators={}, field_validators={}, root_validators={}, field_serializers={}, model_serializers={}, model_validators={}, computed_fields={})[source]: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_extra__: dict[str, Any] | None[source]: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to 'allow'.

__pydantic_fields_set__: set[str][source]: The names of fields explicitly set during instantiation.

__pydantic_generic_metadata__: ClassVar[_generics.PydanticGenericMetadata] = {'args': (), 'origin': None, 'parameters': ()}[source]: 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.

classmethod __pydantic_init_subclass__(**kwargs)[source]

This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.

This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.

This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.

Parameters:: **kwargs (Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.
Return type:: None

__pydantic_parent_namespace__: ClassVar[Dict[str, Any] | None] = None[source]: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__: ClassVar[None | Literal['model_post_init']] = None[source]: The name of the post-init method for the model, if defined.

__pydantic_private__: dict[str, Any] | None[source]: Values of private attributes set on the model instance.

__pydantic_root_model__: ClassVar[bool] = False[source]: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__: ClassVar[SchemaSerializer] = SchemaSerializer(serializer=Model( ModelSerializer { class: Py( 0x000056196da1cc00, ), serializer: Fields( GeneralFieldsSerializer { fields: { "data": SerField { key_py: Py( 0x00007f9038238fa0, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196d93ccc0, ), serializer: Fields( GeneralFieldsSerializer { fields: { "settings": SerField { key_py: Py( 0x00007f903711fa30, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196d1a9d20, ), serializer: Fields( GeneralFieldsSerializer { fields: { "pos": SerField { key_py: Py( 0x00007f903823c150, ), alias: None, alias_py: None, serializer: Some( Recursive( DefinitionRefSerializer { definition: "...", retry_with_lax_check: true, }, ), ), required: true, }, "orientation": SerField { key_py: Py( 0x00007f9033c27ef0, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196d1a8d30, ), serializer: Fields( GeneralFieldsSerializer { fields: { "y": SerField { key_py: Py( 0x00007f903823f558, ), alias: None, alias_py: None, serializer: Some( Float( FloatSerializer { inf_nan_mode: Null, }, ), ), required: true, }, "z": SerField { key_py: Py( 0x00007f903823f588, ), alias: None, alias_py: None, serializer: Some( Float( FloatSerializer { inf_nan_mode: Null, }, ), ), required: true, }, "w": SerField { key_py: Py( 0x00007f903823f4f8, ), alias: None, alias_py: None, serializer: Some( Float( FloatSerializer { inf_nan_mode: Null, }, ), ), required: true, }, "x": SerField { key_py: Py( 0x00007f903823de18, ), alias: None, alias_py: None, serializer: Some( Float( FloatSerializer { inf_nan_mode: Null, }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 4, }, ), has_extra: false, root_model: false, name: "Point4d", }, ), ), required: true, }, "ortho": SerField { key_py: Py( 0x00007f9033e16550, ), alias: None, alias_py: None, serializer: Some( Bool( BoolSerializer, ), ), required: true, }, "up": SerField { key_py: Py( 0x00007f9036ff7720, ), alias: None, alias_py: None, serializer: Some( Recursive( DefinitionRefSerializer { definition: "...", retry_with_lax_check: true, }, ), ), required: true, }, "fov_y": SerField { key_py: Py( 0x00007f9033e16400, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f9038148100, ), ), serializer: Nullable( NullableSerializer { serializer: Float( FloatSerializer { inf_nan_mode: Null, }, ), }, ), }, ), ), required: true, }, "center": SerField { key_py: Py( 0x00007f9037b08150, ), alias: None, alias_py: None, serializer: Some( Recursive( DefinitionRefSerializer { definition: "...", retry_with_lax_check: true, }, ), ), required: true, }, "ortho_scale": SerField { key_py: Py( 0x00007f9033c27eb0, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f9038148100, ), ), serializer: Nullable( NullableSerializer { serializer: Float( FloatSerializer { inf_nan_mode: Null, }, ), }, ), }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 7, }, ), has_extra: false, root_model: false, name: "CameraSettings", }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 1, }, ), has_extra: false, root_model: false, name: "ViewIsometric", }, ), ), required: true, }, "type": SerField { key_py: Py( 0x00007f903823d958, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f90346ed630, ), ), serializer: Literal( LiteralSerializer { expected_int: {}, expected_str: { "view_isometric", }, expected_py: None, name: "literal['view_isometric']", }, ), }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "OptionViewIsometric", }, ), definitions=[Model(ModelSerializer { class: Py(0x56196c7ee400), serializer: Fields(GeneralFieldsSerializer { fields: {"x": SerField { key_py: Py(0x7f903823de18), alias: None, alias_py: None, serializer: Some(Float(FloatSerializer { inf_nan_mode: Null })), required: true }, "z": SerField { key_py: Py(0x7f903823f588), alias: None, alias_py: None, serializer: Some(Float(FloatSerializer { inf_nan_mode: Null })), required: true }, "y": SerField { key_py: Py(0x7f903823f558), alias: None, alias_py: None, serializer: Some(Float(FloatSerializer { inf_nan_mode: Null })), required: true }}, computed_fields: Some(ComputedFields([])), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None }, required_fields: 3 }), has_extra: false, root_model: false, name: "Point3d" })])[source]: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__: ClassVar[SchemaValidator | PluggableSchemaValidator] = SchemaValidator(title="OptionViewIsometric", validator=Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "data", lookup_key: Simple { key: "data", py_key: Py( 0x00007f903336cb70, ), path: LookupPath( [ S( "data", Py( 0x00007f903336cba0, ), ), ], ), }, name_py: Py( 0x00007f9038238fa0, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "settings", lookup_key: Simple { key: "settings", py_key: Py( 0x00007f903336a1f0, ), path: LookupPath( [ S( "settings", Py( 0x00007f903336a030, ), ), ], ), }, name_py: Py( 0x00007f903711fa30, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "center", lookup_key: Simple { key: "center", py_key: Py( 0x00007f903336c2a0, ), path: LookupPath( [ S( "center", Py( 0x00007f903336c210, ), ), ], ), }, name_py: Py( 0x00007f9037b08150, ), validator: DefinitionRef( DefinitionRefValidator { definition: "...", }, ), frozen: false, }, Field { name: "fov_y", lookup_key: Simple { key: "fov_y", py_key: Py( 0x00007f903336c3f0, ), path: LookupPath( [ S( "fov_y", Py( 0x00007f903336c1b0, ), ), ], ), }, name_py: Py( 0x00007f9033e16400, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f9038148100, ), ), on_error: Raise, validator: Nullable( NullableValidator { validator: Float( FloatValidator { strict: false, allow_inf_nan: true, }, ), name: "nullable[float]", }, ), validate_default: false, copy_default: false, name: "default[nullable[float]]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, Field { name: "orientation", lookup_key: Simple { key: "orientation", py_key: Py( 0x00007f9033369eb0, ), path: LookupPath( [ S( "orientation", Py( 0x00007f903336a130, ), ), ], ), }, name_py: Py( 0x00007f9033c27ef0, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "w", lookup_key: Simple { key: "w", py_key: Py( 0x00007f903823f4f8, ), path: LookupPath( [ S( "w", Py( 0x00007f903823f4f8, ), ), ], ), }, name_py: Py( 0x00007f903823f4f8, ), validator: Float( FloatValidator { strict: false, allow_inf_nan: true, }, ), frozen: false, }, Field { name: "x", lookup_key: Simple { key: "x", py_key: Py( 0x00007f903823f528, ), path: LookupPath( [ S( "x", Py( 0x00007f903823f528, ), ), ], ), }, name_py: Py( 0x00007f903823de18, ), validator: Float( FloatValidator { strict: false, allow_inf_nan: true, }, ), frozen: false, }, Field { name: "y", lookup_key: Simple { key: "y", py_key: Py( 0x00007f903823f558, ), path: LookupPath( [ S( "y", Py( 0x00007f903823f558, ), ), ], ), }, name_py: Py( 0x00007f903823f558, ), validator: Float( FloatValidator { strict: false, allow_inf_nan: true, }, ), frozen: false, }, Field { name: "z", lookup_key: Simple { key: "z", py_key: Py( 0x00007f903823f588, ), path: LookupPath( [ S( "z", Py( 0x00007f903823f588, ), ), ], ), }, name_py: Py( 0x00007f903823f588, ), validator: Float( FloatValidator { strict: false, allow_inf_nan: true, }, ), frozen: false, }, ], model_name: "Point4d", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d1a8d30, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "Point4d", }, ), frozen: false, }, Field { name: "ortho", lookup_key: Simple { key: "ortho", py_key: Py( 0x00007f903336c120, ), path: LookupPath( [ S( "ortho", Py( 0x00007f903336c150, ), ), ], ), }, name_py: Py( 0x00007f9033e16550, ), validator: Bool( BoolValidator { strict: false, }, ), frozen: false, }, Field { name: "ortho_scale", lookup_key: Simple { key: "ortho_scale", py_key: Py( 0x00007f903336a330, ), path: LookupPath( [ S( "ortho_scale", Py( 0x00007f903336a170, ), ), ], ), }, name_py: Py( 0x00007f9033c27eb0, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f9038148100, ), ), on_error: Raise, validator: Nullable( NullableValidator { validator: Float( FloatValidator { strict: false, allow_inf_nan: true, }, ), name: "nullable[float]", }, ), validate_default: false, copy_default: false, name: "default[nullable[float]]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, Field { name: "pos", lookup_key: Simple { key: "pos", py_key: Py( 0x00007f903336c0f0, ), path: LookupPath( [ S( "pos", Py( 0x00007f903336c180, ), ), ], ), }, name_py: Py( 0x00007f903823c150, ), validator: DefinitionRef( DefinitionRefValidator { definition: "...", }, ), frozen: false, }, Field { name: "up", lookup_key: Simple { key: "up", py_key: Py( 0x00007f903336c060, ), path: LookupPath( [ S( "up", Py( 0x00007f903336cab0, ), ), ], ), }, name_py: Py( 0x00007f9036ff7720, ), validator: DefinitionRef( DefinitionRefValidator { definition: "...", }, ), frozen: false, }, ], model_name: "CameraSettings", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d1a9d20, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "CameraSettings", }, ), frozen: false, }, ], model_name: "ViewIsometric", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d93ccc0, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "ViewIsometric", }, ), frozen: false, }, Field { name: "type", lookup_key: Simple { key: "type", py_key: Py( 0x00007f903336cbd0, ), path: LookupPath( [ S( "type", Py( 0x00007f903336cc00, ), ), ], ), }, name_py: Py( 0x00007f903823d958, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f90346ed630, ), ), on_error: Raise, validator: Literal( LiteralValidator { lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "view_isometric": 0, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f90346ed630, ), ], }, expected_repr: "'view_isometric'", name: "literal['view_isometric']", }, ), validate_default: false, copy_default: false, name: "default[literal['view_isometric']]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "OptionViewIsometric", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196da1cc00, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "OptionViewIsometric", }, ), definitions=[Model(ModelValidator { revalidate: Never, validator: ModelFields(ModelFieldsValidator { fields: [Field { name: "x", lookup_key: Simple { key: "x", py_key: Py(0x7f903823f528), path: LookupPath([S("x", Py(0x7f903823f528))]) }, name_py: Py(0x7f903823de18), validator: Float(FloatValidator { strict: false, allow_inf_nan: true }), frozen: false }, Field { name: "y", lookup_key: Simple { key: "y", py_key: Py(0x7f903823f558), path: LookupPath([S("y", Py(0x7f903823f558))]) }, name_py: Py(0x7f903823f558), validator: Float(FloatValidator { strict: false, allow_inf_nan: true }), frozen: false }, Field { name: "z", lookup_key: Simple { key: "z", py_key: Py(0x7f903823f588), path: LookupPath([S("z", Py(0x7f903823f588))]) }, name_py: Py(0x7f903823f588), validator: Float(FloatValidator { strict: false, allow_inf_nan: true }), frozen: false }], model_name: "Point3d", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true }), class: Py(0x56196c7ee400), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py(0x7f903629a320), name: "Point3d" })], cache_strings=True)[source]: The pydantic-core SchemaValidator used to validate instances of the model.

__repr__()[source]

Return repr(self).

Return type:: str

__repr_args__()[source]

Return type:: Iterable[tuple[str | None, Any]]

__repr_name__()[source]

Name of the instance’s class, used in __repr__.

Return type:: str

__repr_str__(join_str)[source]

Return type:: str

__rich_repr__()[source]

Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.

Return type:: Iterable[Any | tuple[Any] | tuple[str, Any] | tuple[str, Any, Any]]

__setattr__(name, value)[source]

Implement setattr(self, name, value).

Return type:: None

__setstate__(state)[source]

Return type:: None

__signature__: ClassVar[Signature] = <Signature (*, data: kittycad.models.view_isometric.ViewIsometric, type: Literal['view_isometric'] = 'view_isometric') -> None>[source]: The synthesized __init__ [Signature][inspect.Signature] of the model.

__slots__ = ('__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__')[source]

__str__()[source]

Return str(self).

Return type:: str

_abc_impl = <_abc._abc_data object>[source]

_calculate_keys(*args, **kwargs)[source]

Return type:: Any

_check_frozen(name, value)[source]

Return type:: None

_copy_and_set_values(*args, **kwargs)[source]

Return type:: Any

classmethod _get_value(*args, **kwargs)[source]

Return type:: Any

_iter(*args, **kwargs)[source]

Return type:: Any

classmethod construct(_fields_set=None, **values)[source]

Return type:: Self

copy(*, include=None, exclude=None, update=None, deep=False)[source]

Returns a copy of the model.

!!! warning “Deprecated”: This method is now deprecated; use model_copy instead.

If you need include or exclude, use:

`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `

Parameters:

include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.

Returns:

A copy of the model with included, excluded and updated fields as specified.

data: ViewIsometric[source]

dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)[source]

Return type:: Dict[str, Any]

classmethod from_orm(obj)[source]

Return type:: Self

json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)[source]

Return type:: str

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}[source]: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'protected_namespaces': ()}[source]: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod model_construct(_fields_set=None, **values)[source]

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note: model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == 'allow', then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == 'ignore' (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == 'forbid' does not result in an error if extra values are passed, but they will be ignored.

Parameters:

_fields_set (set[str] | None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.
values (Any) – Trusted or pre-validated data dictionary.

Return type:

Self

Returns:

A new instance of the Model class with validated data.

model_copy(*, update=None, deep=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy

Returns a copy of the model.

Parameters:

update (dict[str, Any] | None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.
deep (bool) – Set to True to make a deep copy of the model.

Return type:

Self

Returns:

New model instance.

model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters:

mode (Union[Literal['json', 'python'], str]) – The mode in which to_python 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.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to include in the output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to exclude from the output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to use the field’s alias in the dictionary key if defined.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A dictionary representation of the model.

model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

Generates a JSON representation of the model using Pydantic’s to_json method.

Parameters:

indent (int | None) – Indentation to use in the JSON output. If None is passed, the output will be compact.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to include in the JSON output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to exclude from the JSON output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to serialize using field aliases.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A JSON string representation of the model.

property model_extra: dict[str, Any] | None[source]

Get extra fields set during validation.

Returns:: A dictionary of extra fields, or None if config.extra is not set to "allow".

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=ViewIsometric, required=True), 'type': FieldInfo(annotation=Literal['view_isometric'], required=False, default='view_isometric')}[source]

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

property model_fields_set: set[str][source]

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,: i.e. that were not filled from defaults.

classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')[source]

Generates a JSON schema for a model class.

Parameters:

by_alias (bool) – Whether to use attribute aliases or not.
ref_template (str) – The reference template.
schema_generator (type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modifications
mode (Literal['validation', 'serialization']) – The mode in which to generate the schema.

Return type:

Returns:

The JSON schema for the given model class.

classmethod model_parametrized_name(params)[source]

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

Parameters:: params (tuple[type[Any], ...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.
Return type:: str
Returns:: String representing the new class where params are passed to cls as type variables.
Raises:: TypeError – Raised when trying to generate concrete names for non-generic models.

model_post_init(_BaseModel__context)[source]

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

Return type:: None

classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)[source]

Try to rebuild the pydantic-core schema for the model.

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.

Parameters:

force (bool) – Whether to force the rebuilding of the model schema, defaults to False.
raise_errors (bool) – Whether to raise errors, defaults to True.
_parent_namespace_depth (int) – The depth level of the parent namespace, defaults to 2.
_types_namespace (dict[str, Any] | None) – The types namespace, defaults to None.

Return type:

Returns:

Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.

classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)[source]

Validate a pydantic model instance.

Parameters:

obj (Any) – The object to validate.
strict (bool | None) – Whether to enforce types strictly.
from_attributes (bool | None) – Whether to extract data from object attributes.
context (Any | None) – Additional context to pass to the validator.

Raises:

ValidationError – If the object could not be validated.

Return type:

Self

Returns:

The validated model instance.

classmethod model_validate_json(json_data, *, strict=None, context=None)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing

Validate the given JSON data against the Pydantic model.

Parameters:

json_data (str | bytes | bytearray) – The JSON data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

Raises:

ValidationError – If json_data is not a JSON string or the object could not be validated.

classmethod model_validate_strings(obj, *, strict=None, context=None)[source]

Validate the given object with string data against the Pydantic model.

Parameters:

obj (Any) – The object containing string data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod parse_obj(obj)[source]

Return type:: Self

classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod schema(by_alias=True, ref_template='#/$defs/{model}')[source]

Return type:: Dict[str, Any]

classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)[source]

Return type:: str

type: Literal['view_isometric'][source]

classmethod update_forward_refs(**localns)[source]

Return type:: None

classmethod validate(value)[source]

Return type:: Self

class kittycad.models.ok_modeling_cmd_response.OptionVolume(**data)[source][source]

The response to the ‘Volume’ endpoint

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__abstractmethods__ = frozenset({})[source]

__annotations__ = {'__class_vars__': 'ClassVar[set[str]]', '__private_attributes__': 'ClassVar[Dict[str, ModelPrivateAttr]]', '__pydantic_complete__': 'ClassVar[bool]', '__pydantic_core_schema__': 'ClassVar[CoreSchema]', '__pydantic_custom_init__': 'ClassVar[bool]', '__pydantic_decorators__': 'ClassVar[_decorators.DecoratorInfos]', '__pydantic_extra__': 'dict[str, Any] | None', '__pydantic_fields_set__': 'set[str]', '__pydantic_generic_metadata__': 'ClassVar[_generics.PydanticGenericMetadata]', '__pydantic_parent_namespace__': 'ClassVar[Dict[str, Any] | None]', '__pydantic_post_init__': "ClassVar[None | Literal['model_post_init']]", '__pydantic_private__': 'dict[str, Any] | None', '__pydantic_root_model__': 'ClassVar[bool]', '__pydantic_serializer__': 'ClassVar[SchemaSerializer]', '__pydantic_validator__': 'ClassVar[SchemaValidator | PluggableSchemaValidator]', '__signature__': 'ClassVar[Signature]', 'data': <class 'kittycad.models.volume.Volume'>, 'model_computed_fields': 'ClassVar[Dict[str, ComputedFieldInfo]]', 'model_config': 'ClassVar[ConfigDict]', 'model_fields': 'ClassVar[Dict[str, FieldInfo]]', 'type': typing.Literal['volume']}[source]

classmethod __class_getitem__(typevar_values)[source]

Return type:: type[BaseModel] | PydanticRecursiveRef

__class_vars__: ClassVar[set[str]] = {}[source]: The names of the class variables defined on the model.

__copy__()[source]

Returns a shallow copy of the model.

Return type:: Self

__deepcopy__(memo=None)[source]

Returns a deep copy of the model.

Return type:: Self

__delattr__(item)[source]

Implement delattr(self, name).

Return type:: Any

__dict__[source]

__eq__(other)[source]

Return self==value.

Return type:: bool

property __fields_set__: set[str][source]

classmethod __get_pydantic_core_schema__(source, handler, /)[source]

Hook into generating the model’s CoreSchema.

Parameters:

source (type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.
handler (GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.

Return type:

Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]

Returns:

A pydantic-core CoreSchema.

classmethod __get_pydantic_json_schema__(core_schema, handler, /)[source]

Hook into generating the model’s JSON schema.

Parameters:

core_schema (Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({'type': 'nullable', 'schema': current_schema}), or just call the handler with the original schema.
handler (GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.

Return type:

Returns:

A JSON schema, as a Python object.

__getattr__(item)[source]

Return type:: Any

__getstate__()[source]

Helper for pickle.

Return type:: dict[Any, Any]

__hash__ = None[source]

__init__(**data)[source]

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__iter__()[source]

So dict(model) works.

Return type:: Generator[Tuple[str, Any], None, None]

__module__ = 'kittycad.models.ok_modeling_cmd_response'[source]

__pretty__(fmt, **kwargs)[source]

Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.

Return type:: Generator[Any, None, None]

__private_attributes__: ClassVar[Dict[str, ModelPrivateAttr]] = {}[source]: Metadata about the private attributes of the model.

__pydantic_complete__: ClassVar[bool] = True[source]: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__: ClassVar[CoreSchema] = {'cls': <class 'kittycad.models.ok_modeling_cmd_response.OptionVolume'>, 'config': {'title': 'OptionVolume'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.ok_modeling_cmd_response.OptionVolume'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.ok_modeling_cmd_response.OptionVolume'>>]}, 'ref': 'kittycad.models.ok_modeling_cmd_response.OptionVolume:94667213959536', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'data': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.volume.Volume'>, 'config': {'title': 'Volume'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.volume.Volume'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.volume.Volume'>>]}, 'ref': 'kittycad.models.volume.Volume:94667212630080', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'output_unit': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <enum 'UnitVolume'>, 'members': [UnitVolume.CM3, UnitVolume.FT3, UnitVolume.IN3, UnitVolume.M3, UnitVolume.YD3, UnitVolume.USFLOZ, UnitVolume.USGAL, UnitVolume.L, UnitVolume.ML], 'metadata': {'pydantic_js_functions': [<function GenerateSchema._enum_schema.<locals>.get_json_schema>]}, 'ref': 'kittycad.models.unit_volume.UnitVolume:94667203562672', 'sub_type': 'str', 'type': 'enum'}, 'type': 'model-field'}, 'volume': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'type': 'float'}, 'type': 'model-field'}}, 'model_name': 'Volume', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}, 'type': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': 'volume', 'schema': {'expected': ['volume'], 'type': 'literal'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'OptionVolume', 'type': 'model-fields'}, 'type': 'model'}[source]: The core schema of the model.

__pydantic_custom_init__: ClassVar[bool] = False[source]: Whether the model has a custom __init__ method.

__pydantic_decorators__: ClassVar[_decorators.DecoratorInfos] = DecoratorInfos(validators={}, field_validators={}, root_validators={}, field_serializers={}, model_serializers={}, model_validators={}, computed_fields={})[source]: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_extra__: dict[str, Any] | None[source]: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to 'allow'.

__pydantic_fields_set__: set[str][source]: The names of fields explicitly set during instantiation.

__pydantic_generic_metadata__: ClassVar[_generics.PydanticGenericMetadata] = {'args': (), 'origin': None, 'parameters': ()}[source]: 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.

classmethod __pydantic_init_subclass__(**kwargs)[source]

This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.

This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.

This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.

Parameters:: **kwargs (Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.
Return type:: None

__pydantic_parent_namespace__: ClassVar[Dict[str, Any] | None] = None[source]: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__: ClassVar[None | Literal['model_post_init']] = None[source]: The name of the post-init method for the model, if defined.

__pydantic_private__: dict[str, Any] | None[source]: Values of private attributes set on the model instance.

__pydantic_root_model__: ClassVar[bool] = False[source]: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__: ClassVar[SchemaSerializer] = SchemaSerializer(serializer=Model( ModelSerializer { class: Py( 0x000056196da8f170, ), serializer: Fields( GeneralFieldsSerializer { fields: { "data": SerField { key_py: Py( 0x00007f9038238fa0, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196d94a840, ), serializer: Fields( GeneralFieldsSerializer { fields: { "volume": SerField { key_py: Py( 0x00007f903823dbb0, ), alias: None, alias_py: None, serializer: Some( Float( FloatSerializer { inf_nan_mode: Null, }, ), ), required: true, }, "output_unit": SerField { key_py: Py( 0x00007f903459f8b0, ), alias: None, alias_py: None, serializer: Some( Enum( EnumSerializer { class: Py( 0x000056196d0a4cb0, ), serializer: Some( Str( StrSerializer, ), ), }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "Volume", }, ), ), required: true, }, "type": SerField { key_py: Py( 0x00007f903823d958, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f903823dbb0, ), ), serializer: Literal( LiteralSerializer { expected_int: {}, expected_str: { "volume", }, expected_py: None, name: "literal['volume']", }, ), }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "OptionVolume", }, ), definitions=[])[source]: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__: ClassVar[SchemaValidator | PluggableSchemaValidator] = SchemaValidator(title="OptionVolume", validator=Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "data", lookup_key: Simple { key: "data", py_key: Py( 0x00007f90333a9170, ), path: LookupPath( [ S( "data", Py( 0x00007f90333a9020, ), ), ], ), }, name_py: Py( 0x00007f9038238fa0, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "output_unit", lookup_key: Simple { key: "output_unit", py_key: Py( 0x00007f90333c90f0, ), path: LookupPath( [ S( "output_unit", Py( 0x00007f90333c90b0, ), ), ], ), }, name_py: Py( 0x00007f903459f8b0, ), validator: StrEnum( EnumValidator { phantom: PhantomData<_pydantic_core::validators::enum_::StrEnumValidator>, class: Py( 0x000056196d0a4cb0, ), lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "cm3": 0, "yd3": 4, "l": 7, "usgal": 6, "ft3": 1, "m3": 3, "in3": 2, "usfloz": 5, "ml": 8, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f9033cabb90, ), Py( 0x00007f9033cabbf0, ), Py( 0x00007f9033cabc50, ), Py( 0x00007f9033cabcb0, ), Py( 0x00007f9033cabd10, ), Py( 0x00007f9033cabd70, ), Py( 0x00007f9033cabdd0, ), Py( 0x00007f9033cabe30, ), Py( 0x00007f9033cabe90, ), ], }, missing: None, expected_repr: "'cm3', 'ft3', 'in3', 'm3', 'yd3', 'usfloz', 'usgal', 'l' or 'ml'", strict: false, class_repr: "UnitVolume", name: "str-enum[UnitVolume]", }, ), frozen: false, }, Field { name: "volume", lookup_key: Simple { key: "volume", py_key: Py( 0x00007f90333a89c0, ), path: LookupPath( [ S( "volume", Py( 0x00007f90333a90e0, ), ), ], ), }, name_py: Py( 0x00007f903823dbb0, ), validator: Float( FloatValidator { strict: false, allow_inf_nan: true, }, ), frozen: false, }, ], model_name: "Volume", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d94a840, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "Volume", }, ), frozen: false, }, Field { name: "type", lookup_key: Simple { key: "type", py_key: Py( 0x00007f90333a9050, ), path: LookupPath( [ S( "type", Py( 0x00007f90333a9f50, ), ), ], ), }, name_py: Py( 0x00007f903823d958, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f903823dbb0, ), ), on_error: Raise, validator: Literal( LiteralValidator { lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "volume": 0, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f903823dbb0, ), ], }, expected_repr: "'volume'", name: "literal['volume']", }, ), validate_default: false, copy_default: false, name: "default[literal['volume']]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "OptionVolume", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196da8f170, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "OptionVolume", }, ), definitions=[], cache_strings=True)[source]: The pydantic-core SchemaValidator used to validate instances of the model.

__repr__()[source]

Return repr(self).

Return type:: str

__repr_args__()[source]

Return type:: Iterable[tuple[str | None, Any]]

__repr_name__()[source]

Name of the instance’s class, used in __repr__.

Return type:: str

__repr_str__(join_str)[source]

Return type:: str

__rich_repr__()[source]

Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.

Return type:: Iterable[Any | tuple[Any] | tuple[str, Any] | tuple[str, Any, Any]]

__setattr__(name, value)[source]

Implement setattr(self, name, value).

Return type:: None

__setstate__(state)[source]

Return type:: None

__signature__: ClassVar[Signature] = <Signature (*, data: kittycad.models.volume.Volume, type: Literal['volume'] = 'volume') -> None>[source]: The synthesized __init__ [Signature][inspect.Signature] of the model.

__slots__ = ('__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__')[source]

__str__()[source]

Return str(self).

Return type:: str

_abc_impl = <_abc._abc_data object>[source]

_calculate_keys(*args, **kwargs)[source]

Return type:: Any

_check_frozen(name, value)[source]

Return type:: None

_copy_and_set_values(*args, **kwargs)[source]

Return type:: Any

classmethod _get_value(*args, **kwargs)[source]

Return type:: Any

_iter(*args, **kwargs)[source]

Return type:: Any

classmethod construct(_fields_set=None, **values)[source]

Return type:: Self

copy(*, include=None, exclude=None, update=None, deep=False)[source]

Returns a copy of the model.

!!! warning “Deprecated”: This method is now deprecated; use model_copy instead.

If you need include or exclude, use:

`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `

Parameters:

include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.

Returns:

A copy of the model with included, excluded and updated fields as specified.

data: Volume[source]

dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)[source]

Return type:: Dict[str, Any]

classmethod from_orm(obj)[source]

Return type:: Self

json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)[source]

Return type:: str

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}[source]: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'protected_namespaces': ()}[source]: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod model_construct(_fields_set=None, **values)[source]

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note: model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == 'allow', then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == 'ignore' (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == 'forbid' does not result in an error if extra values are passed, but they will be ignored.

Parameters:

_fields_set (set[str] | None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.
values (Any) – Trusted or pre-validated data dictionary.

Return type:

Self

Returns:

A new instance of the Model class with validated data.

model_copy(*, update=None, deep=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy

Returns a copy of the model.

Parameters:

update (dict[str, Any] | None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.
deep (bool) – Set to True to make a deep copy of the model.

Return type:

Self

Returns:

New model instance.

model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters:

mode (Union[Literal['json', 'python'], str]) – The mode in which to_python 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.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to include in the output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to exclude from the output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to use the field’s alias in the dictionary key if defined.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A dictionary representation of the model.

model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

Generates a JSON representation of the model using Pydantic’s to_json method.

Parameters:

indent (int | None) – Indentation to use in the JSON output. If None is passed, the output will be compact.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to include in the JSON output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to exclude from the JSON output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to serialize using field aliases.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A JSON string representation of the model.

property model_extra: dict[str, Any] | None[source]

Get extra fields set during validation.

Returns:: A dictionary of extra fields, or None if config.extra is not set to "allow".

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=Volume, required=True), 'type': FieldInfo(annotation=Literal['volume'], required=False, default='volume')}[source]

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

property model_fields_set: set[str][source]

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,: i.e. that were not filled from defaults.

classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')[source]

Generates a JSON schema for a model class.

Parameters:

by_alias (bool) – Whether to use attribute aliases or not.
ref_template (str) – The reference template.
schema_generator (type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modifications
mode (Literal['validation', 'serialization']) – The mode in which to generate the schema.

Return type:

Returns:

The JSON schema for the given model class.

classmethod model_parametrized_name(params)[source]

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

Parameters:: params (tuple[type[Any], ...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.
Return type:: str
Returns:: String representing the new class where params are passed to cls as type variables.
Raises:: TypeError – Raised when trying to generate concrete names for non-generic models.

model_post_init(_BaseModel__context)[source]

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

Return type:: None

classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)[source]

Try to rebuild the pydantic-core schema for the model.

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.

Parameters:

force (bool) – Whether to force the rebuilding of the model schema, defaults to False.
raise_errors (bool) – Whether to raise errors, defaults to True.
_parent_namespace_depth (int) – The depth level of the parent namespace, defaults to 2.
_types_namespace (dict[str, Any] | None) – The types namespace, defaults to None.

Return type:

Returns:

Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.

classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)[source]

Validate a pydantic model instance.

Parameters:

obj (Any) – The object to validate.
strict (bool | None) – Whether to enforce types strictly.
from_attributes (bool | None) – Whether to extract data from object attributes.
context (Any | None) – Additional context to pass to the validator.

Raises:

ValidationError – If the object could not be validated.

Return type:

Self

Returns:

The validated model instance.

classmethod model_validate_json(json_data, *, strict=None, context=None)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing

Validate the given JSON data against the Pydantic model.

Parameters:

json_data (str | bytes | bytearray) – The JSON data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

Raises:

ValidationError – If json_data is not a JSON string or the object could not be validated.

classmethod model_validate_strings(obj, *, strict=None, context=None)[source]

Validate the given object with string data against the Pydantic model.

Parameters:

obj (Any) – The object containing string data to validate.
strict (bool | None) – Whether to enforce types strictly.
context (Any | None) – Extra variables to pass to the validator.

Return type:

Self

Returns:

The validated Pydantic model.

classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod parse_obj(obj)[source]

Return type:: Self

classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]

Return type:: Self

classmethod schema(by_alias=True, ref_template='#/$defs/{model}')[source]

Return type:: Dict[str, Any]

classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)[source]

Return type:: str

type: Literal['volume'][source]

classmethod update_forward_refs(**localns)[source]

Return type:: None

classmethod validate(value)[source]

Return type:: Self

class kittycad.models.ok_modeling_cmd_response.OptionZoomToFit(**data)[source][source]

The response to the ‘ZoomToFit’ endpoint

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__abstractmethods__ = frozenset({})[source]

__annotations__ = {'__class_vars__': 'ClassVar[set[str]]', '__private_attributes__': 'ClassVar[Dict[str, ModelPrivateAttr]]', '__pydantic_complete__': 'ClassVar[bool]', '__pydantic_core_schema__': 'ClassVar[CoreSchema]', '__pydantic_custom_init__': 'ClassVar[bool]', '__pydantic_decorators__': 'ClassVar[_decorators.DecoratorInfos]', '__pydantic_extra__': 'dict[str, Any] | None', '__pydantic_fields_set__': 'set[str]', '__pydantic_generic_metadata__': 'ClassVar[_generics.PydanticGenericMetadata]', '__pydantic_parent_namespace__': 'ClassVar[Dict[str, Any] | None]', '__pydantic_post_init__': "ClassVar[None | Literal['model_post_init']]", '__pydantic_private__': 'dict[str, Any] | None', '__pydantic_root_model__': 'ClassVar[bool]', '__pydantic_serializer__': 'ClassVar[SchemaSerializer]', '__pydantic_validator__': 'ClassVar[SchemaValidator | PluggableSchemaValidator]', '__signature__': 'ClassVar[Signature]', 'data': <class 'kittycad.models.zoom_to_fit.ZoomToFit'>, 'model_computed_fields': 'ClassVar[Dict[str, ComputedFieldInfo]]', 'model_config': 'ClassVar[ConfigDict]', 'model_fields': 'ClassVar[Dict[str, FieldInfo]]', 'type': typing.Literal['zoom_to_fit']}[source]

classmethod __class_getitem__(typevar_values)[source]

Return type:: type[BaseModel] | PydanticRecursiveRef

__class_vars__: ClassVar[set[str]] = {}[source]: The names of the class variables defined on the model.

__copy__()[source]

Returns a shallow copy of the model.

Return type:: Self

__deepcopy__(memo=None)[source]

Returns a deep copy of the model.

Return type:: Self

__delattr__(item)[source]

Implement delattr(self, name).

Return type:: Any

__dict__[source]

__eq__(other)[source]

Return self==value.

Return type:: bool

property __fields_set__: set[str][source]

classmethod __get_pydantic_core_schema__(source, handler, /)[source]

Hook into generating the model’s CoreSchema.

Parameters:

source (type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.
handler (GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.

Return type:

Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]

Returns:

A pydantic-core CoreSchema.

classmethod __get_pydantic_json_schema__(core_schema, handler, /)[source]

Hook into generating the model’s JSON schema.

Parameters:

core_schema (Union[AnySchema, NoneSchema, BoolSchema, IntSchema, FloatSchema, DecimalSchema, StringSchema, BytesSchema, DateSchema, TimeSchema, DatetimeSchema, TimedeltaSchema, LiteralSchema, EnumSchema, IsInstanceSchema, IsSubclassSchema, CallableSchema, ListSchema, TupleSchema, SetSchema, FrozenSetSchema, GeneratorSchema, DictSchema, AfterValidatorFunctionSchema, BeforeValidatorFunctionSchema, WrapValidatorFunctionSchema, PlainValidatorFunctionSchema, WithDefaultSchema, NullableSchema, UnionSchema, TaggedUnionSchema, ChainSchema, LaxOrStrictSchema, JsonOrPythonSchema, TypedDictSchema, ModelFieldsSchema, ModelSchema, DataclassArgsSchema, DataclassSchema, ArgumentsSchema, CallSchema, CustomErrorSchema, JsonSchema, UrlSchema, MultiHostUrlSchema, DefinitionsSchema, DefinitionReferenceSchema, UuidSchema, ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({'type': 'nullable', 'schema': current_schema}), or just call the handler with the original schema.
handler (GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.

Return type:

Returns:

A JSON schema, as a Python object.

__getattr__(item)[source]

Return type:: Any

__getstate__()[source]

Helper for pickle.

Return type:: dict[Any, Any]

__hash__ = None[source]

__init__(**data)[source]

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

__iter__()[source]

So dict(model) works.

Return type:: Generator[Tuple[str, Any], None, None]

__module__ = 'kittycad.models.ok_modeling_cmd_response'[source]

__pretty__(fmt, **kwargs)[source]

Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.

Return type:: Generator[Any, None, None]

__private_attributes__: ClassVar[Dict[str, ModelPrivateAttr]] = {}[source]: Metadata about the private attributes of the model.

__pydantic_complete__: ClassVar[bool] = True[source]: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__: ClassVar[CoreSchema] = {'definitions': [{'cls': <class 'kittycad.models.point3d.Point3d'>, 'config': {'title': 'Point3d'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.point3d.Point3d'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.point3d.Point3d'>>]}, 'ref': 'kittycad.models.point3d.Point3d:94667194426368', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'x': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'type': 'float'}, 'type': 'model-field'}, 'y': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'type': 'float'}, 'type': 'model-field'}, 'z': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'type': 'float'}, 'type': 'model-field'}}, 'model_name': 'Point3d', 'type': 'model-fields'}, 'type': 'model'}], 'schema': {'cls': <class 'kittycad.models.ok_modeling_cmd_response.OptionZoomToFit'>, 'config': {'title': 'OptionZoomToFit'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.ok_modeling_cmd_response.OptionZoomToFit'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.ok_modeling_cmd_response.OptionZoomToFit'>>]}, 'ref': 'kittycad.models.ok_modeling_cmd_response.OptionZoomToFit:94667213453904', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'data': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.zoom_to_fit.ZoomToFit'>, 'config': {'title': 'ZoomToFit'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.zoom_to_fit.ZoomToFit'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.zoom_to_fit.ZoomToFit'>>]}, 'ref': 'kittycad.models.zoom_to_fit.ZoomToFit:94667212638464', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'settings': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.camera_settings.CameraSettings'>, 'config': {'title': 'CameraSettings'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.camera_settings.CameraSettings'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.camera_settings.CameraSettings'>>]}, 'ref': 'kittycad.models.camera_settings.CameraSettings:94667204631840', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'center': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'schema_ref': 'kittycad.models.point3d.Point3d:94667194426368', 'type': 'definition-ref'}, 'type': 'model-field'}, 'fov_y': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': None, 'schema': {'schema': {'type': 'float'}, 'type': 'nullable'}, 'type': 'default'}, 'type': 'model-field'}, 'orientation': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'cls': <class 'kittycad.models.point4d.Point4d'>, 'config': {'title': 'Point4d'}, 'custom_init': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'kittycad.models.point4d.Point4d'>, title=None), <bound method BaseModel.__get_pydantic_json_schema__ of <class 'kittycad.models.point4d.Point4d'>>]}, 'ref': 'kittycad.models.point4d.Point4d:94667204627760', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'w': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'type': 'float'}, 'type': 'model-field'}, 'x': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'type': 'float'}, 'type': 'model-field'}, 'y': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'type': 'float'}, 'type': 'model-field'}, 'z': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'type': 'float'}, 'type': 'model-field'}}, 'model_name': 'Point4d', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}, 'ortho': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'type': 'bool'}, 'type': 'model-field'}, 'ortho_scale': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': None, 'schema': {'schema': {'type': 'float'}, 'type': 'nullable'}, 'type': 'default'}, 'type': 'model-field'}, 'pos': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'schema_ref': 'kittycad.models.point3d.Point3d:94667194426368', 'type': 'definition-ref'}, 'type': 'model-field'}, 'up': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'schema_ref': 'kittycad.models.point3d.Point3d:94667194426368', 'type': 'definition-ref'}, 'type': 'model-field'}}, 'model_name': 'CameraSettings', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}}, 'model_name': 'ZoomToFit', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'model-field'}, 'type': {'metadata': {'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>], 'pydantic_js_functions': []}, 'schema': {'default': 'zoom_to_fit', 'schema': {'expected': ['zoom_to_fit'], 'type': 'literal'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'OptionZoomToFit', 'type': 'model-fields'}, 'type': 'model'}, 'type': 'definitions'}[source]: The core schema of the model.

__pydantic_custom_init__: ClassVar[bool] = False[source]: Whether the model has a custom __init__ method.

__pydantic_decorators__: ClassVar[_decorators.DecoratorInfos] = DecoratorInfos(validators={}, field_validators={}, root_validators={}, field_serializers={}, model_serializers={}, model_validators={}, computed_fields={})[source]: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_extra__: dict[str, Any] | None[source]: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to 'allow'.

__pydantic_fields_set__: set[str][source]: The names of fields explicitly set during instantiation.

__pydantic_generic_metadata__: ClassVar[_generics.PydanticGenericMetadata] = {'args': (), 'origin': None, 'parameters': ()}[source]: 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.

classmethod __pydantic_init_subclass__(**kwargs)[source]

This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.

This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.

This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.

Parameters:: **kwargs (Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.
Return type:: None

__pydantic_parent_namespace__: ClassVar[Dict[str, Any] | None] = None[source]: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__: ClassVar[None | Literal['model_post_init']] = None[source]: The name of the post-init method for the model, if defined.

__pydantic_private__: dict[str, Any] | None[source]: Values of private attributes set on the model instance.

__pydantic_root_model__: ClassVar[bool] = False[source]: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__: ClassVar[SchemaSerializer] = SchemaSerializer(serializer=Model( ModelSerializer { class: Py( 0x000056196da13a50, ), serializer: Fields( GeneralFieldsSerializer { fields: { "type": SerField { key_py: Py( 0x00007f903823d958, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f90346eda70, ), ), serializer: Literal( LiteralSerializer { expected_int: {}, expected_str: { "zoom_to_fit", }, expected_py: None, name: "literal['zoom_to_fit']", }, ), }, ), ), required: true, }, "data": SerField { key_py: Py( 0x00007f9038238fa0, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196d94c900, ), serializer: Fields( GeneralFieldsSerializer { fields: { "settings": SerField { key_py: Py( 0x00007f903711fa30, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196d1a9d20, ), serializer: Fields( GeneralFieldsSerializer { fields: { "center": SerField { key_py: Py( 0x00007f9037b08150, ), alias: None, alias_py: None, serializer: Some( Recursive( DefinitionRefSerializer { definition: "...", retry_with_lax_check: true, }, ), ), required: true, }, "fov_y": SerField { key_py: Py( 0x00007f9033e16400, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f9038148100, ), ), serializer: Nullable( NullableSerializer { serializer: Float( FloatSerializer { inf_nan_mode: Null, }, ), }, ), }, ), ), required: true, }, "orientation": SerField { key_py: Py( 0x00007f9033c27ef0, ), alias: None, alias_py: None, serializer: Some( Model( ModelSerializer { class: Py( 0x000056196d1a8d30, ), serializer: Fields( GeneralFieldsSerializer { fields: { "w": SerField { key_py: Py( 0x00007f903823f4f8, ), alias: None, alias_py: None, serializer: Some( Float( FloatSerializer { inf_nan_mode: Null, }, ), ), required: true, }, "y": SerField { key_py: Py( 0x00007f903823f558, ), alias: None, alias_py: None, serializer: Some( Float( FloatSerializer { inf_nan_mode: Null, }, ), ), required: true, }, "z": SerField { key_py: Py( 0x00007f903823f588, ), alias: None, alias_py: None, serializer: Some( Float( FloatSerializer { inf_nan_mode: Null, }, ), ), required: true, }, "x": SerField { key_py: Py( 0x00007f903823de18, ), alias: None, alias_py: None, serializer: Some( Float( FloatSerializer { inf_nan_mode: Null, }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 4, }, ), has_extra: false, root_model: false, name: "Point4d", }, ), ), required: true, }, "ortho": SerField { key_py: Py( 0x00007f9033e16550, ), alias: None, alias_py: None, serializer: Some( Bool( BoolSerializer, ), ), required: true, }, "ortho_scale": SerField { key_py: Py( 0x00007f9033c27eb0, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f9038148100, ), ), serializer: Nullable( NullableSerializer { serializer: Float( FloatSerializer { inf_nan_mode: Null, }, ), }, ), }, ), ), required: true, }, "pos": SerField { key_py: Py( 0x00007f903823c150, ), alias: None, alias_py: None, serializer: Some( Recursive( DefinitionRefSerializer { definition: "...", retry_with_lax_check: true, }, ), ), required: true, }, "up": SerField { key_py: Py( 0x00007f9036ff7720, ), alias: None, alias_py: None, serializer: Some( Recursive( DefinitionRefSerializer { definition: "...", retry_with_lax_check: true, }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 7, }, ), has_extra: false, root_model: false, name: "CameraSettings", }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 1, }, ), has_extra: false, root_model: false, name: "ZoomToFit", }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), has_extra: false, root_model: false, name: "OptionZoomToFit", }, ), definitions=[Model(ModelSerializer { class: Py(0x56196c7ee400), serializer: Fields(GeneralFieldsSerializer { fields: {"x": SerField { key_py: Py(0x7f903823de18), alias: None, alias_py: None, serializer: Some(Float(FloatSerializer { inf_nan_mode: Null })), required: true }, "y": SerField { key_py: Py(0x7f903823f558), alias: None, alias_py: None, serializer: Some(Float(FloatSerializer { inf_nan_mode: Null })), required: true }, "z": SerField { key_py: Py(0x7f903823f588), alias: None, alias_py: None, serializer: Some(Float(FloatSerializer { inf_nan_mode: Null })), required: true }}, computed_fields: Some(ComputedFields([])), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None }, required_fields: 3 }), has_extra: false, root_model: false, name: "Point3d" })])[source]: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__: ClassVar[SchemaValidator | PluggableSchemaValidator] = SchemaValidator(title="OptionZoomToFit", validator=Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "data", lookup_key: Simple { key: "data", py_key: Py( 0x00007f9033522130, ), path: LookupPath( [ S( "data", Py( 0x00007f9033523210, ), ), ], ), }, name_py: Py( 0x00007f9038238fa0, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "settings", lookup_key: Simple { key: "settings", py_key: Py( 0x00007f903335ed70, ), path: LookupPath( [ S( "settings", Py( 0x00007f903335d7f0, ), ), ], ), }, name_py: Py( 0x00007f903711fa30, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "center", lookup_key: Simple { key: "center", py_key: Py( 0x00007f9033522ee0, ), path: LookupPath( [ S( "center", Py( 0x00007f90335213b0, ), ), ], ), }, name_py: Py( 0x00007f9037b08150, ), validator: DefinitionRef( DefinitionRefValidator { definition: "...", }, ), frozen: false, }, Field { name: "fov_y", lookup_key: Simple { key: "fov_y", py_key: Py( 0x00007f90335213e0, ), path: LookupPath( [ S( "fov_y", Py( 0x00007f9033521710, ), ), ], ), }, name_py: Py( 0x00007f9033e16400, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f9038148100, ), ), on_error: Raise, validator: Nullable( NullableValidator { validator: Float( FloatValidator { strict: false, allow_inf_nan: true, }, ), name: "nullable[float]", }, ), validate_default: false, copy_default: false, name: "default[nullable[float]]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, Field { name: "orientation", lookup_key: Simple { key: "orientation", py_key: Py( 0x00007f90334b1f30, ), path: LookupPath( [ S( "orientation", Py( 0x00007f90345df630, ), ), ], ), }, name_py: Py( 0x00007f9033c27ef0, ), validator: Model( ModelValidator { revalidate: Never, validator: ModelFields( ModelFieldsValidator { fields: [ Field { name: "w", lookup_key: Simple { key: "w", py_key: Py( 0x00007f903823f4f8, ), path: LookupPath( [ S( "w", Py( 0x00007f903823f4f8, ), ), ], ), }, name_py: Py( 0x00007f903823f4f8, ), validator: Float( FloatValidator { strict: false, allow_inf_nan: true, }, ), frozen: false, }, Field { name: "x", lookup_key: Simple { key: "x", py_key: Py( 0x00007f903823f528, ), path: LookupPath( [ S( "x", Py( 0x00007f903823f528, ), ), ], ), }, name_py: Py( 0x00007f903823de18, ), validator: Float( FloatValidator { strict: false, allow_inf_nan: true, }, ), frozen: false, }, Field { name: "y", lookup_key: Simple { key: "y", py_key: Py( 0x00007f903823f558, ), path: LookupPath( [ S( "y", Py( 0x00007f903823f558, ), ), ], ), }, name_py: Py( 0x00007f903823f558, ), validator: Float( FloatValidator { strict: false, allow_inf_nan: true, }, ), frozen: false, }, Field { name: "z", lookup_key: Simple { key: "z", py_key: Py( 0x00007f903823f588, ), path: LookupPath( [ S( "z", Py( 0x00007f903823f588, ), ), ], ), }, name_py: Py( 0x00007f903823f588, ), validator: Float( FloatValidator { strict: false, allow_inf_nan: true, }, ), frozen: false, }, ], model_name: "Point4d", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d1a8d30, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "Point4d", }, ), frozen: false, }, Field { name: "ortho", lookup_key: Simple { key: "ortho", py_key: Py( 0x00007f9033520b40, ), path: LookupPath( [ S( "ortho", Py( 0x00007f9033521bc0, ), ), ], ), }, name_py: Py( 0x00007f9033e16550, ), validator: Bool( BoolValidator { strict: false, }, ), frozen: false, }, Field { name: "ortho_scale", lookup_key: Simple { key: "ortho_scale", py_key: Py( 0x00007f90337edfb0, ), path: LookupPath( [ S( "ortho_scale", Py( 0x00007f903335edf0, ), ), ], ), }, name_py: Py( 0x00007f9033c27eb0, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f9038148100, ), ), on_error: Raise, validator: Nullable( NullableValidator { validator: Float( FloatValidator { strict: false, allow_inf_nan: true, }, ), name: "nullable[float]", }, ), validate_default: false, copy_default: false, name: "default[nullable[float]]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, Field { name: "pos", lookup_key: Simple { key: "pos", py_key: Py( 0x00007f9033521410, ), path: LookupPath( [ S( "pos", Py( 0x00007f90335233c0, ), ), ], ), }, name_py: Py( 0x00007f903823c150, ), validator: DefinitionRef( DefinitionRefValidator { definition: "...", }, ), frozen: false, }, Field { name: "up", lookup_key: Simple { key: "up", py_key: Py( 0x00007f9033523540, ), path: LookupPath( [ S( "up", Py( 0x00007f90335232a0, ), ), ], ), }, name_py: Py( 0x00007f9036ff7720, ), validator: DefinitionRef( DefinitionRefValidator { definition: "...", }, ), frozen: false, }, ], model_name: "CameraSettings", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d1a9d20, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "CameraSettings", }, ), frozen: false, }, ], model_name: "ZoomToFit", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196d94c900, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "ZoomToFit", }, ), frozen: false, }, Field { name: "type", lookup_key: Simple { key: "type", py_key: Py( 0x00007f9033522250, ), path: LookupPath( [ S( "type", Py( 0x00007f9033521e30, ), ), ], ), }, name_py: Py( 0x00007f903823d958, ), validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f90346eda70, ), ), on_error: Raise, validator: Literal( LiteralValidator { lookup: LiteralLookup { expected_bool: None, expected_int: None, expected_str: Some( { "zoom_to_fit": 0, }, ), expected_py_dict: None, expected_py_values: None, values: [ Py( 0x00007f90346eda70, ), ], }, expected_repr: "'zoom_to_fit'", name: "literal['zoom_to_fit']", }, ), validate_default: false, copy_default: false, name: "default[literal['zoom_to_fit']]", undefined: Py( 0x00007f903629a320, ), }, ), frozen: false, }, ], model_name: "OptionZoomToFit", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true, }, ), class: Py( 0x000056196da13a50, ), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py( 0x00007f903629a320, ), name: "OptionZoomToFit", }, ), definitions=[Model(ModelValidator { revalidate: Never, validator: ModelFields(ModelFieldsValidator { fields: [Field { name: "x", lookup_key: Simple { key: "x", py_key: Py(0x7f903823f528), path: LookupPath([S("x", Py(0x7f903823f528))]) }, name_py: Py(0x7f903823de18), validator: Float(FloatValidator { strict: false, allow_inf_nan: true }), frozen: false }, Field { name: "y", lookup_key: Simple { key: "y", py_key: Py(0x7f903823f558), path: LookupPath([S("y", Py(0x7f903823f558))]) }, name_py: Py(0x7f903823f558), validator: Float(FloatValidator { strict: false, allow_inf_nan: true }), frozen: false }, Field { name: "z", lookup_key: Simple { key: "z", py_key: Py(0x7f903823f588), path: LookupPath([S("z", Py(0x7f903823f588))]) }, name_py: Py(0x7f903823f588), validator: Float(FloatValidator { strict: false, allow_inf_nan: true }), frozen: false }], model_name: "Point3d", extra_behavior: Ignore, extras_validator: None, strict: false, from_attributes: false, loc_by_alias: true }), class: Py(0x56196c7ee400), post_init: None, frozen: false, custom_init: false, root_model: false, undefined: Py(0x7f903629a320), name: "Point3d" })], cache_strings=True)[source]: The pydantic-core SchemaValidator used to validate instances of the model.

__repr__()[source]

Return repr(self).

Return type:: str

__repr_args__()[source]

Return type:: Iterable[tuple[str | None, Any]]

__repr_name__()[source]

Name of the instance’s class, used in __repr__.

Return type:: str

__repr_str__(join_str)[source]

Return type:: str

__rich_repr__()[source]

Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.

Return type:: Iterable[Any | tuple[Any] | tuple[str, Any] | tuple[str, Any, Any]]

__setattr__(name, value)[source]

Implement setattr(self, name, value).

Return type:: None

__setstate__(state)[source]

Return type:: None

__signature__: ClassVar[Signature] = <Signature (*, data: kittycad.models.zoom_to_fit.ZoomToFit, type: Literal['zoom_to_fit'] = 'zoom_to_fit') -> None>[source]: The synthesized __init__ [Signature][inspect.Signature] of the model.

__slots__ = ('__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__')[source]

__str__()[source]

Return str(self).

Return type:: str

_abc_impl = <_abc._abc_data object>[source]

_calculate_keys(*args, **kwargs)[source]

Return type:: Any

_check_frozen(name, value)[source]

Return type:: None

_copy_and_set_values(*args, **kwargs)[source]

Return type:: Any

classmethod _get_value(*args, **kwargs)[source]

Return type:: Any

_iter(*args, **kwargs)[source]

Return type:: Any

classmethod construct(_fields_set=None, **values)[source]

Return type:: Self

copy(*, include=None, exclude=None, update=None, deep=False)[source]

Returns a copy of the model.

!!! warning “Deprecated”: This method is now deprecated; use model_copy instead.

If you need include or exclude, use:

`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `

Parameters:

include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.

Returns:

A copy of the model with included, excluded and updated fields as specified.

data: ZoomToFit[source]

dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)[source]

Return type:: Dict[str, Any]

classmethod from_orm(obj)[source]

Return type:: Self

json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)[source]

Return type:: str

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}[source]: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'protected_namespaces': ()}[source]: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod model_construct(_fields_set=None, **values)[source]

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note: model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == 'allow', then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == 'ignore' (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == 'forbid' does not result in an error if extra values are passed, but they will be ignored.

Parameters:

_fields_set (set[str] | None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.
values (Any) – Trusted or pre-validated data dictionary.

Return type:

Self

Returns:

A new instance of the Model class with validated data.

model_copy(*, update=None, deep=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy

Returns a copy of the model.

Parameters:

update (dict[str, Any] | None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.
deep (bool) – Set to True to make a deep copy of the model.

Return type:

Self

Returns:

New model instance.

model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters:

mode (Union[Literal['json', 'python'], str]) – The mode in which to_python 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.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to include in the output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – A set of fields to exclude from the output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to use the field’s alias in the dictionary key if defined.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A dictionary representation of the model.

model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)[source]

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

Generates a JSON representation of the model using Pydantic’s to_json method.

Parameters:

indent (int | None) – Indentation to use in the JSON output. If None is passed, the output will be compact.
include (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to include in the JSON output.
exclude (Union[Set[int], Set[str], Mapping[int, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], Mapping[str, Union[Set[int], Set[str], Mapping[int, Union[IncEx, Literal[True]]], Mapping[str, Union[IncEx, Literal[True]]], Literal[True]]], None]) – Field(s) to exclude from the JSON output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool) – Whether to serialize using field aliases.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

Returns:

A JSON string representation of the model.

property model_extra: dict[str, Any] | None[source]

Get extra fields set during validation.

Returns:: A dictionary of extra fields, or None if config.extra is not set to "allow".

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data': FieldInfo(annotation=ZoomToFit, required=True), 'type': FieldInfo(annotation=Literal['zoom_to_fit'], required=False, default='zoom_to_fit')}[source]

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

property model_fields_set: set[str][source]

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,: i.e. that were not filled from defaults.

classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')[source]

Generates a JSON schema for a model class.

Parameters:

by_alias (bool) – Whether to use attribute aliases or not.
ref_template (str) – The reference template.
schema_generator (type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modifications
mode (Literal['validation', 'serialization']) – The mode in which to generate the schema.

Return type:

Returns:

The JSON schema for the given model class.

classmethod model_parametrized_name(params)[source]

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

Parameters:: params (tuple[type[Any], ...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.
Return type:: str
Returns:: String representing the new class where params are passed to cls as type variables.
Raises:: TypeError – Raised when trying to generate concrete names for non-generic models.

model_post_init(_BaseModel__context)[source]

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

Return type:: None

classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)[source]

Try to rebuild the pydantic-core schema for the model.

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.

Parameters:

force (bool) – Whether to force the rebuilding of the model schema, defaults to False.
raise_errors (bool) – Whether to raise errors, defaults to True.
_parent_namespace_depth (int) – The depth level of the parent namespace, defaults to 2.
_types_namespace (dict[str, Any] | None) – The types namespace, defaults to None.

Return type: