serializable 1.3.4__tar.gz → 1.4.0__tar.gz

{serializable-1.3.4/serializable.egg-info → serializable-1.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: serializable
-Version: 1.3.4
+Version: 1.4.0
 Summary: Base class with serialization helpers for user-defined Python objects
 Author-email: Alex Rubinsteyn <alex.rubinsteyn@unc.edu>
 License:                                  Apache License

{serializable-1.3.4 → serializable-1.4.0}/serializable/dataclass_serializable.py

@@ -82,8 +82,21 @@ class DataclassSerializable:
 
     @classmethod
     def from_json(cls: type[_T], json_string: str) -> _T:
-        """Reconstruct an object from a string produced by ``to_json``."""
-        return from_json(json_string)
+        """Reconstruct an instance of this class, or of a subclass, from a
+        string produced by ``to_json``. The class built is the one the JSON
+        names.
+
+        Raises ``ValueError`` if the JSON holds anything else, such as
+        another class or a plain dict. Use the module-level
+        ``serializable.from_json`` to load JSON whose type isn't known in
+        advance."""
+        obj = from_json(json_string)
+        if not isinstance(obj, cls):
+            raise ValueError(
+                f"{cls.__name__}.from_json: the JSON holds {type(obj).__name__}, "
+                f"not {cls.__name__}; use serializable.from_json to load any type"
+            )
+        return obj
 
     def __reduce__(self) -> tuple[Any, ...]:
         """Pickle via the same to_dict / from_dict path used for JSON so

{serializable-1.3.4 → serializable-1.4.0}/serializable/serializable.py

@@ -100,9 +100,20 @@ class Serializable:
     @classmethod
     def from_json(cls: type[_T], json_string: str) -> _T:
         """
-        Reconstruct an instance from a JSON string.
+        Reconstruct an instance of this class, or of a subclass, from a JSON
+        string written by to_json. The class built is the one the JSON names.
+
+        Raises ValueError if the JSON holds anything else, such as another
+        class or a plain dict. Use the module-level serializable.from_json to
+        load JSON whose type isn't known in advance.
         """
-        return from_json(json_string)
+        obj = from_json(json_string)
+        if not isinstance(obj, cls):
+            raise ValueError(
+                f"{cls.__name__}.from_json: the JSON holds {type(obj).__name__}, "
+                f"not {cls.__name__}; use serializable.from_json to load any type"
+            )
+        return obj
 
     def write_json_file(self, path: Union[str, os.PathLike[str]]) -> None:
         """
@@ -115,6 +126,8 @@ class Serializable:
     def read_json_file(cls: type[_T], path: Union[str, os.PathLike[str]]) -> _T:
         """
         Construct an instance of this class from the JSON file at `path`.
+
+        Raises ValueError, as from_json does, if the file holds another type.
         """
         with open(path) as f:
             json_string = f.read()

{serializable-1.3.4 → serializable-1.4.0}/serializable/version.py

@@ -1,4 +1,4 @@
-__version__ = "1.3.4"
+__version__ = "1.4.0"
 
 
 def print_version():

{serializable-1.3.4 → serializable-1.4.0/serializable.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: serializable
-Version: 1.3.4
+Version: 1.4.0
 Summary: Base class with serialization helpers for user-defined Python objects
 Author-email: Alex Rubinsteyn <alex.rubinsteyn@unc.edu>
 License:                                  Apache License

{serializable-1.3.4 → serializable-1.4.0}/tests/test_dataclass_serializable.py

@@ -182,3 +182,27 @@ def test_interop_with_legacy_serializable():
 def test_nested_dataclass_serializable_roundtrip():
     o = Outer(name="parent", inner=Inner(n=7))
     eq_(Outer.from_json(o.to_json()), o)
+
+
+@dataclass
+class LabeledPoint(Point):
+    label: str = ""
+
+
+def test_from_json_returns_subclass_named_in_json():
+    p = LabeledPoint(1.0, 2.0, label="a")
+    restored = Point.from_json(p.to_json())
+    eq_(type(restored), LabeledPoint)
+    eq_(restored, p)
+
+
+def test_from_json_rejects_other_class():
+    person_json = Person(name="Ada", age=36).to_json()
+    with pytest.raises(ValueError, match="holds Person, not Point"):
+        Point.from_json(person_json)
+    eq_(from_json(person_json), Person(name="Ada", age=36))
+
+
+def test_from_json_rejects_json_without_class():
+    with pytest.raises(ValueError, match="holds dict, not Point"):
+        Point.from_json('{"x": 1.0, "y": 2.0}')

{serializable-1.3.4 → serializable-1.4.0}/tests/test_object.py

@@ -12,9 +12,13 @@
 
 import pickle
 
+import pytest
+
 from serializable import (
     Serializable,
+    from_json,
     from_serializable_repr,
+    to_json,
     to_serializable_repr,
 )
 
@@ -30,6 +34,15 @@ class A(Serializable):
         return {"x": self.x, "y": self.y}
 
 
+class B(A):
+    pass
+
+
+class Other(Serializable):
+    def __init__(self, x):
+        self.x = x
+
+
 instance = A(1, 2)
 
 
@@ -50,3 +63,29 @@ def test_object_json_file(tmp_path):
     path = tmp_path / "instance.json"
     instance.write_json_file(path)
     eq_(instance, A.read_json_file(path))
+
+
+def test_from_json_returns_subclass_named_in_json():
+    derived = B(1, 2)
+    restored = A.from_json(derived.to_json())
+    eq_(type(restored), B)
+    eq_(restored, derived)
+
+
+def test_from_json_rejects_other_class():
+    other_json = Other(1).to_json()
+    with pytest.raises(ValueError, match="holds Other, not A"):
+        A.from_json(other_json)
+    eq_(from_json(other_json), Other(1))
+
+
+def test_from_json_rejects_json_without_class():
+    with pytest.raises(ValueError, match="holds dict, not A"):
+        A.from_json(to_json({"x": 1, "y": 2}))
+
+
+def test_read_json_file_rejects_other_class(tmp_path):
+    path = tmp_path / "other.json"
+    Other(1).write_json_file(path)
+    with pytest.raises(ValueError, match="holds Other, not A"):
+        A.read_json_file(path)