updates for generating python types (#918)

jessfraz · web-flow · commit 5d20b9c0530a · 2025-08-11T13:44:11.000-07:00
* updates for generating python types

Signed-off-by: Jessie Frazelle &lt;github@jessfraz.com&gt;

* updates

Signed-off-by: Jessie Frazelle &lt;github@jessfraz.com&gt;

* updates

Signed-off-by: Jessie Frazelle &lt;github@jessfraz.com&gt;

* updates

Signed-off-by: Jessie Frazelle &lt;github@jessfraz.com&gt;

* updates

Signed-off-by: Jessie Frazelle &lt;github@jessfraz.com&gt;

* updates

Signed-off-by: Jessie Frazelle &lt;github@jessfraz.com&gt;

---------

Signed-off-by: Jessie Frazelle &lt;github@jessfraz.com&gt;
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/flake.lock b/flake.lock
diff --git a/flake.nix b/flake.nix
@@ -53,6 +53,7 @@
             rustToolchain
 
             cargo-nextest
+            cargo-sort
 
             just
             openssl
diff --git a/modeling-cmds/Cargo.toml b/modeling-cmds/Cargo.toml
@@ -23,7 +23,7 @@ convert_client_crate = ["dep:kittycad"]
 websocket = ["dep:serde_json"]
 webrtc = ["dep:webrtc"]
 unstable_exhaustive = []
-python = ["dep:pyo3"]
+python = ["dep:pyo3", "dep:pyo3-stub-gen"]
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
@@ -42,6 +42,7 @@ measurements = "0.11.0"
 parse-display = "0.9.1"
 parse-display-derive = "0.9.0"
 pyo3 = { version = "0.25.1", optional = true }
+pyo3-stub-gen = { version = "0.12.2", optional = true }
 schemars = { version = "0.8.22", features = [
   "bigdecimal04",
   "chrono",
@@ -54,10 +55,10 @@ serde_json = { version = "1.0.139", optional = true }
 slog = { version = "2.7.0", optional = true }
 tabled = { version = "0.18", optional = true }
 ts-rs = { version = "11.0.1", optional = true, features = [
-	"chrono-impl",
-    "uuid-impl",
-    "no-serde-warnings",
-    "serde-json-impl",
+  "chrono-impl",
+  "uuid-impl",
+  "no-serde-warnings",
+  "serde-json-impl",
 ] }
 uuid = { version = "1.16.0", features = ["serde", "v4", "js"] }
 webrtc = { version = "0.12", optional = true }
@@ -67,4 +68,3 @@ bson = "2.14.0"
 
 [lints]
 workspace = true
-
diff --git a/modeling-cmds/src/base64.rs b/modeling-cmds/src/base64.rs
@@ -18,6 +18,7 @@ static ALLOWED_DECODING_FORMATS: &[data_encoding::Encoding] = &[
 ];
 
 #[derive(Debug, Clone, PartialEq, Eq)]
+#[cfg_attr(feature = "python", pyo3::pyclass, pyo3_stub_gen::derive::gen_stub_pyclass)]
 /// A container for binary that should be base64 encoded in serialisation. In reverse
 /// when deserializing, will decode from many different types of base64 possible.
 pub struct Base64Data(pub Vec<u8>);
diff --git a/modeling-cmds/src/coord.rs b/modeling-cmds/src/coord.rs
@@ -12,6 +12,7 @@ use serde::{Deserialize, Serialize};
 #[display(style = "snake_case")]
 #[cfg_attr(feature = "ts-rs", derive(ts_rs::TS))]
 #[cfg_attr(feature = "ts-rs", ts(export_to = "ModelingCmd.ts"))]
+#[cfg_attr(feature = "python", pyo3::pyclass, pyo3_stub_gen::derive::gen_stub_pyclass_enum)]
 pub enum Axis {
     /// 'Y' axis.
     Y = 1,
@@ -25,6 +26,7 @@ pub enum Axis {
 #[display(style = "snake_case")]
 #[cfg_attr(feature = "ts-rs", derive(ts_rs::TS))]
 #[cfg_attr(feature = "ts-rs", ts(export_to = "ModelingCmd.ts"))]
+#[cfg_attr(feature = "python", pyo3::pyclass, pyo3_stub_gen::derive::gen_stub_pyclass_enum)]
 pub enum Direction {
     /// Increasing numbers.
     Positive = 1,
@@ -48,6 +50,7 @@ impl std::ops::Mul for Direction {
 #[display("({axis}, {direction})")]
 #[cfg_attr(feature = "ts-rs", derive(ts_rs::TS))]
 #[cfg_attr(feature = "ts-rs", ts(export_to = "ModelingCmd.ts"))]
+#[cfg_attr(feature = "python", pyo3::pyclass, pyo3_stub_gen::derive::gen_stub_pyclass)]
 pub struct AxisDirectionPair {
     /// Axis specifier.
     pub axis: Axis,
@@ -67,6 +70,7 @@ pub struct AxisDirectionPair {
 #[display("forward: {forward}, up: {up}")]
 #[cfg_attr(feature = "ts-rs", derive(ts_rs::TS))]
 #[cfg_attr(feature = "ts-rs", ts(export_to = "ModelingCmd.ts"))]
+#[cfg_attr(feature = "python", pyo3::pyclass, pyo3_stub_gen::derive::gen_stub_pyclass)]
 pub struct System {
     /// Axis the front face of a model looks along.
     pub forward: AxisDirectionPair,
diff --git a/modeling-cmds/src/def_enum.rs b/modeling-cmds/src/def_enum.rs
@@ -1187,11 +1187,12 @@ define_modeling_cmd_enum! {
         }
 
         /// Enum containing the variety of image formats snapshots may be exported to.
-        #[derive(Debug, Clone, PartialEq, Serialize, Deserialize, JsonSchema, FromStr, Display)]
+        #[derive(Debug, Clone, Copy, PartialEq, Serialize, Deserialize, JsonSchema, FromStr, Display)]
         #[serde(rename_all = "snake_case")]
         #[display(style = "snake_case")]
         #[cfg_attr(feature = "ts-rs", derive(ts_rs::TS))]
         #[cfg_attr(feature = "ts-rs", ts(export_to = "ModelingCmd.ts"))]
+        #[cfg_attr(feature = "python", pyo3::pyclass, pyo3_stub_gen::derive::gen_stub_pyclass_enum)]
         pub enum ImageFormat {
             /// .png format
             Png,
diff --git a/modeling-cmds/src/format/dxf.rs b/modeling-cmds/src/format/dxf.rs
@@ -12,6 +12,7 @@ pub mod export {
     #[serde(rename = "DxfStorage", rename_all = "snake_case")]
     #[cfg_attr(feature = "ts-rs", derive(ts_rs::TS))]
     #[cfg_attr(feature = "ts-rs", ts(export_to = "ModelingCmd.ts"))]
+    #[cfg_attr(feature = "python", pyo3::pyclass, pyo3_stub_gen::derive::gen_stub_pyclass_enum)]
     pub enum Storage {
         /// Plaintext encoding.
         ///
@@ -29,13 +30,14 @@ pub mod export {
     #[serde(rename = "DxfExportOptions")]
     #[cfg_attr(feature = "ts-rs", derive(ts_rs::TS))]
     #[cfg_attr(feature = "ts-rs", ts(export_to = "ModelingCmd.ts"))]
-    #[cfg_attr(feature = "python", pyo3::pyclass)]
+    #[cfg_attr(feature = "python", pyo3::pyclass, pyo3_stub_gen::derive::gen_stub_pyclass)]
     pub struct Options {
         /// Export storage.
         pub storage: Storage,
     }
 
     #[cfg(feature = "python")]
+    #[pyo3_stub_gen::derive::gen_stub_pymethods]
     #[pyo3::pymethods]
     impl Options {
         #[new]
diff --git a/modeling-cmds/src/format/fbx.rs b/modeling-cmds/src/format/fbx.rs
@@ -11,10 +11,11 @@ pub mod import {
     #[serde(rename = "FbxImportOptions")]
     #[cfg_attr(feature = "ts-rs", derive(ts_rs::TS))]
     #[cfg_attr(feature = "ts-rs", ts(export_to = "ModelingCmd.ts"))]
-    #[cfg_attr(feature = "python", pyo3::pyclass)]
+    #[cfg_attr(feature = "python", pyo3::pyclass, pyo3_stub_gen::derive::gen_stub_pyclass)]
     pub struct Options {}
 
     #[cfg(feature = "python")]
+    #[pyo3_stub_gen::derive::gen_stub_pymethods]
     #[pyo3::pymethods]
     impl Options {
         #[new]
@@ -33,7 +34,7 @@ pub mod export {
     #[derive(Clone, Debug, Default, Eq, Hash, PartialEq, Serialize, Deserialize, JsonSchema)]
     #[serde(rename = "FbxExportOptions")]
     #[cfg_attr(feature = "ts-rs", derive(ts_rs::TS))]
-    #[cfg_attr(feature = "python", pyo3::pyclass)]
+    #[cfg_attr(feature = "python", pyo3::pyclass, pyo3_stub_gen::derive::gen_stub_pyclass)]
     #[cfg_attr(feature = "ts-rs", ts(export_to = "ModelingCmd.ts"))]
     pub struct Options {
         /// Specifies which kind of FBX will be exported.
@@ -44,6 +45,7 @@ pub mod export {
     }
 
     #[cfg(feature = "python")]
+    #[pyo3_stub_gen::derive::gen_stub_pymethods]
     #[pyo3::pymethods]
     impl Options {
         #[new]
@@ -77,6 +79,7 @@ pub mod export {
     #[serde(rename = "FbxStorage", rename_all = "snake_case")]
     #[cfg_attr(feature = "ts-rs", derive(ts_rs::TS))]
     #[cfg_attr(feature = "ts-rs", ts(export_to = "ModelingCmd.ts"))]
+    #[cfg_attr(feature = "python", pyo3::pyclass, pyo3_stub_gen::derive::gen_stub_pyclass_enum)]
     pub enum Storage {
         /// ASCII FBX encoding.
         Ascii,
diff --git a/modeling-cmds/src/format/gltf.rs b/modeling-cmds/src/format/gltf.rs
@@ -12,10 +12,11 @@ pub mod import {
     #[serde(rename = "GltfImportOptions")]
     #[cfg_attr(feature = "ts-rs", derive(ts_rs::TS))]
     #[cfg_attr(feature = "ts-rs", ts(export_to = "ModelingCmd.ts"))]
-    #[cfg_attr(feature = "python", pyo3::pyclass)]
+    #[cfg_attr(feature = "python", pyo3::pyclass, pyo3_stub_gen::derive::gen_stub_pyclass)]
     pub struct Options {}
 
     #[cfg(feature = "python")]
+    #[pyo3_stub_gen::derive::gen_stub_pymethods]
     #[pyo3::pymethods]
     impl Options {
         #[new]
@@ -34,7 +35,7 @@ pub mod export {
     #[display("storage: {storage}, presentation: {presentation}")]
     #[serde(rename = "GltfExportOptions")]
     #[cfg_attr(feature = "ts-rs", derive(ts_rs::TS))]
-    #[cfg_attr(feature = "python", pyo3::pyclass)]
+    #[cfg_attr(feature = "python", pyo3::pyclass, pyo3_stub_gen::derive::gen_stub_pyclass)]
     #[cfg_attr(feature = "ts-rs", ts(export_to = "ModelingCmd.ts"))]
     pub struct Options {
         /// Specifies which kind of glTF 2.0 will be exported.
@@ -44,6 +45,7 @@ pub mod export {
     }
 
     #[cfg(feature = "python")]
+    #[pyo3_stub_gen::derive::gen_stub_pymethods]
     #[pyo3::pymethods]
     impl Options {
         #[new]
@@ -61,6 +63,7 @@ pub mod export {
     #[serde(rename = "GltfStorage", rename_all = "snake_case")]
     #[cfg_attr(feature = "ts-rs", derive(ts_rs::TS))]
     #[cfg_attr(feature = "ts-rs", ts(export_to = "ModelingCmd.ts"))]
+    #[cfg_attr(feature = "python", pyo3::pyclass, pyo3_stub_gen::derive::gen_stub_pyclass_enum)]
     pub enum Storage {
         /// Binary glTF 2.0.
         ///
diff --git a/modeling-cmds/src/format/mod.rs b/modeling-cmds/src/format/mod.rs
@@ -79,7 +79,11 @@ pub type InputFormat = InputFormat3d;
 #[derive(Clone, Debug, Eq, Hash, PartialEq, Serialize, Deserialize, JsonSchema, Display, FromStr)]
 #[serde(tag = "type", rename_all = "snake_case")]
 #[display(style = "snake_case")]
-#[cfg_attr(feature = "python", pyo3::pyclass)]
+#[cfg_attr(
+    feature = "python",
+    pyo3::pyclass,
+    pyo3_stub_gen::derive::gen_stub_pyclass_complex_enum
+)]
 #[cfg_attr(feature = "ts-rs", derive(ts_rs::TS))]
 #[cfg_attr(feature = "ts-rs", ts(export_to = "ModelingCmd.ts"))]
 pub enum InputFormat3d {
diff --git a/modeling-cmds/src/format/obj.rs b/modeling-cmds/src/format/obj.rs
@@ -14,7 +14,7 @@ pub mod import {
     #[serde(rename = "ObjImportOptions")]
     #[cfg_attr(feature = "ts-rs", derive(ts_rs::TS))]
     #[cfg_attr(feature = "ts-rs", ts(export_to = "ModelingCmd.ts"))]
-    #[cfg_attr(feature = "python", pyo3::pyclass)]
+    #[cfg_attr(feature = "python", pyo3::pyclass, pyo3_stub_gen::derive::gen_stub_pyclass)]
     pub struct Options {
         /// Co-ordinate system of input data.
         ///
@@ -33,6 +33,7 @@ pub mod import {
     }
 
     #[cfg(feature = "python")]
+    #[pyo3_stub_gen::derive::gen_stub_pymethods]
     #[pyo3::pymethods]
     impl Options {
         #[new]
@@ -61,7 +62,7 @@ pub mod export {
     #[display("coords: {coords}, units: {units}")]
     #[serde(rename = "ObjExportOptions")]
     #[cfg_attr(feature = "ts-rs", derive(ts_rs::TS))]
-    #[cfg_attr(feature = "python", pyo3::pyclass)]
+    #[cfg_attr(feature = "python", pyo3::pyclass, pyo3_stub_gen::derive::gen_stub_pyclass)]
     #[cfg_attr(feature = "ts-rs", ts(export_to = "ModelingCmd.ts"))]
     pub struct Options {
         /// Co-ordinate system of output data.
@@ -78,6 +79,7 @@ pub mod export {
     }
 
     #[cfg(feature = "python")]
+    #[pyo3_stub_gen::derive::gen_stub_pymethods]
     #[pyo3::pymethods]
     impl Options {
         #[new]
diff --git a/modeling-cmds/src/format/ply.rs b/modeling-cmds/src/format/ply.rs
@@ -14,7 +14,7 @@ pub mod import {
     #[serde(rename = "PlyImportOptions")]
     #[cfg_attr(feature = "ts-rs", derive(ts_rs::TS))]
     #[cfg_attr(feature = "ts-rs", ts(export_to = "ModelingCmd.ts"))]
-    #[cfg_attr(feature = "python", pyo3::pyclass)]
+    #[cfg_attr(feature = "python", pyo3::pyclass, pyo3_stub_gen::derive::gen_stub_pyclass)]
     pub struct Options {
         /// Co-ordinate system of input data.
         ///
@@ -33,6 +33,7 @@ pub mod import {
     }
 
     #[cfg(feature = "python")]
+    #[pyo3_stub_gen::derive::gen_stub_pymethods]
     #[pyo3::pymethods]
     impl Options {
         #[new]
@@ -62,7 +63,7 @@ pub mod export {
     #[display("coords: {coords}, selection: {selection}, storage: {storage}, units: {units}")]
     #[serde(rename = "PlyExportOptions")]
     #[cfg_attr(feature = "ts-rs", derive(ts_rs::TS))]
-    #[cfg_attr(feature = "python", pyo3::pyclass)]
+    #[cfg_attr(feature = "python", pyo3::pyclass, pyo3_stub_gen::derive::gen_stub_pyclass)]
     #[cfg_attr(feature = "ts-rs", ts(export_to = "ModelingCmd.ts"))]
     pub struct Options {
         /// Co-ordinate system of output data.
@@ -85,6 +86,7 @@ pub mod export {
     }
 
     #[cfg(feature = "python")]
+    #[pyo3_stub_gen::derive::gen_stub_pymethods]
     #[pyo3::pymethods]
     impl Options {
         #[new]
diff --git a/modeling-cmds/src/format/sldprt.rs b/modeling-cmds/src/format/sldprt.rs
@@ -11,7 +11,7 @@ pub mod import {
     #[serde(default, rename = "SldprtImportOptions")]
     #[cfg_attr(feature = "ts-rs", derive(ts_rs::TS))]
     #[cfg_attr(feature = "ts-rs", ts(export_to = "ModelingCmd.ts"))]
-    #[cfg_attr(feature = "python", pyo3::pyclass)]
+    #[cfg_attr(feature = "python", pyo3::pyclass, pyo3_stub_gen::derive::gen_stub_pyclass)]
     pub struct Options {
         /// Splits all closed faces into two open faces.
         ///
@@ -20,6 +20,7 @@ pub mod import {
     }
 
     #[cfg(feature = "python")]
+    #[pyo3_stub_gen::derive::gen_stub_pymethods]
     #[pyo3::pymethods]
     impl Options {
         #[new]
diff --git a/modeling-cmds/src/format/step.rs b/modeling-cmds/src/format/step.rs
@@ -14,7 +14,7 @@ pub mod import {
     #[serde(default, rename = "StepImportOptions")]
     #[cfg_attr(feature = "ts-rs", derive(ts_rs::TS))]
     #[cfg_attr(feature = "ts-rs", ts(export_to = "ModelingCmd.ts"))]
-    #[cfg_attr(feature = "python", pyo3::pyclass)]
+    #[cfg_attr(feature = "python", pyo3::pyclass, pyo3_stub_gen::derive::gen_stub_pyclass)]
     pub struct Options {
         /// Splits all closed faces into two open faces.
         ///
@@ -23,6 +23,7 @@ pub mod import {
     }
 
     #[cfg(feature = "python")]
+    #[pyo3_stub_gen::derive::gen_stub_pymethods]
     #[pyo3::pymethods]
     impl Options {
         #[new]
@@ -41,7 +42,7 @@ pub mod export {
     #[derive(Clone, Debug, Deserialize, Eq, Hash, JsonSchema, PartialEq, Serialize)]
     #[serde(rename = "StepExportOptions")]
     #[cfg_attr(feature = "ts-rs", derive(ts_rs::TS))]
-    #[cfg_attr(feature = "python", pyo3::pyclass)]
+    #[cfg_attr(feature = "python", pyo3::pyclass, pyo3_stub_gen::derive::gen_stub_pyclass)]
     #[cfg_attr(feature = "ts-rs", ts(export_to = "ModelingCmd.ts"))]
     pub struct Options {
         /// Co-ordinate system of output data.
@@ -56,6 +57,7 @@ pub mod export {
     }
 
     #[cfg(feature = "python")]
+    #[pyo3_stub_gen::derive::gen_stub_pymethods]
     #[pyo3::pymethods]
     impl Options {
         #[new]
diff --git a/modeling-cmds/src/format/stl.rs b/modeling-cmds/src/format/stl.rs
diff --git a/modeling-cmds/src/shared.rs b/modeling-cmds/src/shared.rs
diff --git a/modeling-cmds/src/units.rs b/modeling-cmds/src/units.rs
diff --git a/modeling-cmds/src/websocket.rs b/modeling-cmds/src/websocket.rs
