Data converter non-string keys (#833)

* Failing test for non-string dict keys

* Support non-string keys in JSONPlain data converter

Author: dandavison

Diff for: temporalio/converter.py

@@ -1471,22 +1471,39 @@ def value_to_type(
         )
         # Convert each key/value
         for key, value in value.items():
-            if key_type:
-                try:
-                    key = value_to_type(key_type, key, custom_converters)
-                except Exception as err:
-                    raise TypeError(f"Failed converting key {key} on {hint}") from err
-            # If there are per-key types, use it instead of single type
             this_value_type = value_type
             if per_key_types:
                 # TODO(cretz): Strict mode would fail an unknown key
                 this_value_type = per_key_types.get(key)
+
+            if key_type:
+                # This function is used only by JSONPlainPayloadConverter. When
+                # serializing to JSON, Python supports key types str, int, float, bool,
+                # and None, serializing all to string representations. We now attempt to
+                # use the provided type annotation to recover the original value with its
+                # original type.
+                try:
+                    if isinstance(key, str):
+                        if key_type is int or key_type is float:
+                            key = key_type(key)
+                        elif key_type is bool:
+                            key = {"true": True, "false": False}[key]
+                        elif key_type is type(None):
+                            key = {"null": None}[key]
+
+                    if not isinstance(key, key_type):
+                        key = value_to_type(key_type, key, custom_converters)
+                except Exception as err:
+                    raise TypeError(
+                        f"Failed converting key {repr(key)} to type {key_type} in mapping {hint}"
+                    ) from err
+
             if this_value_type:
                 try:
                     value = value_to_type(this_value_type, value, custom_converters)
                 except Exception as err:
                     raise TypeError(
-                        f"Failed converting value for key {key} on {hint}"
+                        f"Failed converting value for key {repr(key)} in mapping {hint}"
                     ) from err
             ret_dict[key] = value
         # If there are per-key types, it's a typed dict and we want to attempt

Diff for: tests/test_converter.py

@@ -373,8 +373,12 @@ def fail(hint: Any, value: Any) -> None:
     # just accepting any dict.
     ok(MyTypedDictNotTotal, {"foo": "bar"})
     ok(MyTypedDict, {"foo": "bar", "blah": "meh"})
-    # Note, dicts can't have int key in JSON
-    fail(Dict[int, str], {1: "2"})
+
+    # Non-string dict keys are supported
+    ok(Dict[int, str], {1: "1"})
+    ok(Dict[float, str], {1.0: "1"})
+    ok(Dict[bool, str], {True: "1"})
+    ok(Dict[None, str], {None: "1"})
 
     # Alias
     ok(MyDataClassAlias, MyDataClass("foo", 5, SerializableEnum.FOO))