Use Python identifiers as an approximation to avoid quoting property names (#210)

DanielRosenwasser · web-flow · commit d02cddcb5178 · 2024-03-12T10:38:10.000-07:00
* Use Python identifiers as an approximation for when property names can avoid quoting.

* Update snapshots.

* Remove re
diff --git a/python/src/typechat/_internal/ts_conversion/ts_node_to_string.py b/python/src/typechat/_internal/ts_conversion/ts_node_to_string.py
@@ -64,12 +64,11 @@ def ts_type_to_str(type_node: TypeNode) -> str:
         #     raise NotImplementedError(f"Unhandled type {type(type_node)}")
     assert_never(type_node)
 
-
 def object_member_to_str(member: PropertyDeclarationNode | IndexSignatureDeclarationNode) -> str:
     match member:
         case PropertyDeclarationNode(name, is_optional, comment, annotation):
             comment = comment_to_str(comment, "    ")
-            if not name.isalnum():
+            if not name.isidentifier():
                 name = json.dumps(name)
             return f"{comment}    {name}{'?' if is_optional else ''}: {ts_type_to_str(annotation)};"
         case IndexSignatureDeclarationNode(key_type, value_type):
diff --git a/python/tests/__py3.11_snapshots__/test_conflicting_names_1/test_conflicting_names_1.schema.d.ts b/python/tests/__py3.11_snapshots__/test_conflicting_names_1/test_conflicting_names_1.schema.d.ts
@@ -1,6 +1,6 @@
 // Entry point is: 'Derived'
 
 interface Derived {
-    "my_attr_1": string;
-    "my_attr_2": number;
+    my_attr_1: string;
+    my_attr_2: number;
 }
diff --git a/python/tests/__py3.11_snapshots__/test_hello_world/test_generic_alias1.schema.d.ts b/python/tests/__py3.11_snapshots__/test_hello_world/test_generic_alias1.schema.d.ts
@@ -22,9 +22,9 @@ interface D extends C<string> {
     y: boolean | null;
     z?: number[] | null;
     other?: IndirectC;
-    "non_class"?: NonClass;
+    non_class?: NonClass;
     // This comes from later metadata.
-    "multiple_metadata"?: string;
+    multiple_metadata?: string;
 }
 
 interface NonClass {
diff --git a/python/tests/__py3.12_snapshots__/test_conflicting_names_1/test_conflicting_names_1.schema.d.ts b/python/tests/__py3.12_snapshots__/test_conflicting_names_1/test_conflicting_names_1.schema.d.ts
@@ -7,9 +7,9 @@ interface Derived extends C, C {
 }
 
 interface C {
-    "my_attr_2": number;
+    my_attr_2: number;
 }
 
 interface C {
-    "my_attr_1": string;
+    my_attr_1: string;
 }
diff --git a/python/tests/__py3.12_snapshots__/test_hello_world/test_generic_alias1.schema.d.ts b/python/tests/__py3.12_snapshots__/test_hello_world/test_generic_alias1.schema.d.ts
@@ -22,9 +22,9 @@ interface D extends C<string> {
     y: boolean | null;
     z?: number[] | null;
     other?: IndirectC;
-    "non_class"?: NonClass;
+    non_class?: NonClass;
     // This comes from later metadata.
-    "multiple_metadata"?: string;
+    multiple_metadata?: string;
 }
 
 interface NonClass {
diff --git a/python/tests/__snapshots__/test_dataclasses/test_data_classes.schema.d.ts b/python/tests/__snapshots__/test_dataclasses/test_data_classes.schema.d.ts
@@ -1,15 +1,15 @@
 // Entry point is: 'Response'
 
 interface Response {
-    "attr_1": string;
+    attr_1: string;
     // Hello!
-    "attr_2": number;
-    "attr_3": string | null;
-    "attr_4"?: string;
-    "attr_5"?: string | null;
-    "attr_6"?: string[];
-    "attr_7"?: Options;
-    "_underscore_attr_1"?: number;
+    attr_2: number;
+    attr_3: string | null;
+    attr_4?: string;
+    attr_5?: string | null;
+    attr_6?: string[];
+    attr_7?: Options;
+    _underscore_attr_1?: number;
 }
 
 // TODO: someone add something here.
diff --git a/python/tests/__snapshots__/test_generic_alias_1/test_generic_alias1.schema.d.ts b/python/tests/__snapshots__/test_generic_alias_1/test_generic_alias1.schema.d.ts
@@ -4,10 +4,10 @@ type FirstOrSecond<T> = First<T> | Second<T>
 
 interface Second<T> {
     kind: "second";
-    "second_attr": T;
+    second_attr: T;
 }
 
 interface First<T> {
     kind: "first";
-    "first_attr": T;
+    first_attr: T;
 }
diff --git a/python/tests/__snapshots__/test_generic_alias_2/test_generic_alias1.schema.d.ts b/python/tests/__snapshots__/test_generic_alias_2/test_generic_alias1.schema.d.ts
@@ -8,10 +8,10 @@ type FirstOrSecond<T> = First<T> | Second<T>
 
 interface Second<T> {
     kind: "second";
-    "second_attr": T;
+    second_attr: T;
 }
 
 interface First<T> {
     kind: "first";
-    "first_attr": T;
+    first_attr: T;
 }
diff --git a/python/tests/__snapshots__/test_tuple_errors_1/test_tuples_2.schema.d.ts b/python/tests/__snapshots__/test_tuple_errors_1/test_tuples_2.schema.d.ts
@@ -12,12 +12,12 @@
 // !!! The tuple type 'tuple[int, ..., int, ...]' is ill-formed. Tuples with an ellipsis can only take the form 'tuple[SomeType, ...]'.
 
 interface TupleContainer {
-    "empty_tuples_args_1": [any, any];
-    "empty_tuples_args_2": any[];
-    "arbitrary_length_1": any[];
-    "arbitrary_length_2": any[];
-    "arbitrary_length_3": any[];
-    "arbitrary_length_4": any[];
-    "arbitrary_length_5": any[];
-    "arbitrary_length_6": any[];
+    empty_tuples_args_1: [any, any];
+    empty_tuples_args_2: any[];
+    arbitrary_length_1: any[];
+    arbitrary_length_2: any[];
+    arbitrary_length_3: any[];
+    arbitrary_length_4: any[];
+    arbitrary_length_5: any[];
+    arbitrary_length_6: any[];
 }
diff --git a/python/tests/__snapshots__/test_tuples_1/test_tuples_1.schema.d.ts b/python/tests/__snapshots__/test_tuples_1/test_tuples_1.schema.d.ts
@@ -1,14 +1,14 @@
 // Entry point is: 'TupleContainer'
 
 interface TupleContainer {
-    "empty_tuple": [];
-    "tuple_1": [number];
-    "tuple_2": [number, string];
-    "tuple_3": [number, string];
-    "arbitrary_length_1": number[];
-    "arbitrary_length_2": number[];
-    "arbitrary_length_3": number[];
-    "arbitrary_length_4": number[];
-    "arbitrary_length_5": number[] | [number];
-    "arbitrary_length_6": number[] | [number] | [number, number];
+    empty_tuple: [];
+    tuple_1: [number];
+    tuple_2: [number, string];
+    tuple_3: [number, string];
+    arbitrary_length_1: number[];
+    arbitrary_length_2: number[];
+    arbitrary_length_3: number[];
+    arbitrary_length_4: number[];
+    arbitrary_length_5: number[] | [number];
+    arbitrary_length_6: number[] | [number] | [number, number];
 }

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`// Entry point is: 'Derived'`
`2`	`2`
`3`	`3`	`interface Derived {`
`4`		`- "my_attr_1": string;`
`5`		`- "my_attr_2": number;`
	`4`	`+ my_attr_1: string;`
	`5`	`+ my_attr_2: number;`
`6`	`6`	`}`
Original file line number	Diff line number	Diff line change
`@@ -7,9 +7,9 @@ interface Derived extends C, C {`
`7`	`7`	`}`
`8`	`8`
`9`	`9`	`interface C {`
`10`		`- "my_attr_2": number;`
	`10`	`+ my_attr_2: number;`
`11`	`11`	`}`
`12`	`12`
`13`	`13`	`interface C {`
`14`		`- "my_attr_1": string;`
	`14`	`+ my_attr_1: string;`
`15`	`15`	`}`
Original file line number	Diff line number	Diff line change
`@@ -4,10 +4,10 @@ type FirstOrSecond<T> = First<T> \| Second<T>`
`4`	`4`
`5`	`5`	`interface Second<T> {`
`6`	`6`	`kind: "second";`
`7`		`- "second_attr": T;`
	`7`	`+ second_attr: T;`
`8`	`8`	`}`
`9`	`9`
`10`	`10`	`interface First<T> {`
`11`	`11`	`kind: "first";`
`12`		`- "first_attr": T;`
	`12`	`+ first_attr: T;`
`13`	`13`	`}`
Original file line number	Diff line number	Diff line change
`@@ -8,10 +8,10 @@ type FirstOrSecond<T> = First<T> \| Second<T>`
`8`	`8`
`9`	`9`	`interface Second<T> {`
`10`	`10`	`kind: "second";`
`11`		`- "second_attr": T;`
	`11`	`+ second_attr: T;`
`12`	`12`	`}`
`13`	`13`
`14`	`14`	`interface First<T> {`
`15`	`15`	`kind: "first";`
`16`		`- "first_attr": T;`
	`16`	`+ first_attr: T;`
`17`	`17`	`}`