Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix nested custom dataclasses #24

Merged
merged 5 commits into from
Nov 30, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .bumpversion.toml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[tool.bumpversion]
current_version = "v0.4.0"
current_version = "v0.4.1"
commit = true
commit_args = "--no-verify"
tag = true
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# totypes - Custom types for topology optimization
`v0.4.0`
`v0.4.1`

## Overview

Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[project]

name = "totypes"
version = "v0.4.0"
version = "v0.4.1"
description = "Custom datatypes useful in a topology optimization context"
keywords = ["topology", "optimization", "jax", "inverse design"]
readme = "README.md"
Expand Down
2 changes: 1 addition & 1 deletion src/totypes/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Copyright (c) 2023 The INVRS-IO authors.
"""

__version__ = "v0.4.0"
__version__ = "v0.4.1"
__author__ = "Martin F. Schubert <[email protected]>"

__all__ = ["json_utils", "symmetry", "types"]
Expand Down
2 changes: 1 addition & 1 deletion src/totypes/json_utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -214,7 +214,7 @@ def _convert_array(arr: Union[onp.ndarray, jnp.ndarray]) -> Tuple[str, Dict[str,
def _asdict(x: Any) -> Dict[str, Any]:
"""Converts dataclasses or namedtuples to dictionaries."""
if dataclasses.is_dataclass(x):
return dataclasses.asdict(x)
return {field.name: getattr(x, field.name) for field in dataclasses.fields(x)}
try:
return x._asdict() # type: ignore[no-any-return]
except AttributeError as exc:
Expand Down
44 changes: 43 additions & 1 deletion tests/test_json_utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -222,6 +222,49 @@ class CustomObject(NamedTuple):
self.assertEqual(restored.y, obj.y)
self.assertEqual(restored.z, obj.z)

def test_serialize_with_custom_namedtuple_having_internal_custom_type(self):
class CustomObject(NamedTuple):
x: types.Density2DArray
y: types.BoundedArray
z: str

json_utils.register_custom_type(CustomObject)

obj = CustomObject(
x=types.Density2DArray(array=onp.zeros((5, 5))),
y=types.BoundedArray(onp.ones((3,)), 0, 2),
z="test",
)

serialized = json_utils.json_from_pytree(obj)
restored = json_utils.pytree_from_json(serialized)
self.assertIsInstance(restored, CustomObject)
self.assertIsInstance(restored.x, types.Density2DArray)
self.assertIsInstance(restored.y, types.BoundedArray)
self.assertIsInstance(restored.z, str)

def test_serialize_with_custom_dataclass_having_internal_custom_type(self):
@dataclasses.dataclass
class CustomObject:
x: types.Density2DArray
y: types.BoundedArray
z: str

json_utils.register_custom_type(CustomObject)

obj = CustomObject(
x=types.Density2DArray(array=onp.zeros((5, 5))),
y=types.BoundedArray(onp.ones((3,)), 0, 2),
z="test",
)

serialized = json_utils.json_from_pytree(obj)
restored = json_utils.pytree_from_json(serialized)
self.assertIsInstance(restored, CustomObject)
self.assertIsInstance(restored.x, types.Density2DArray)
self.assertIsInstance(restored.y, types.BoundedArray)
self.assertIsInstance(restored.z, str)

def test_serialize_with_registered_custom_dataclass(self):
@dataclasses.dataclass
class CustomObject:
Expand Down Expand Up @@ -270,7 +313,6 @@ class MyClass123:
["MyClass123" in key for key in json_utils._CUSTOM_TYPE_REGISTRY.keys()]
)
)
print(type(MyClass123()))
with self.assertRaisesRegex(
ValueError, "`custom_type` must be a type, but got"
):
Expand Down