Merge pull request #325 from yukinarit/fix-typing

Add type annotations to from_dict, from_tuple and from_msgpack

Author: yukinarit

examples/msg_pack.py

@@ -0,0 +1,24 @@
+from dataclasses import dataclass
+
+from serde import serde
+from serde.msgpack import from_msgpack, to_msgpack
+
+
+@serde
+@dataclass
+class Foo:
+    i: int
+    s: str
+    f: float
+    b: bool
+
+
+def main():
+    f = Foo(i=10, s='foo', f=100.0, b=True)
+    p = to_msgpack(f)
+    print(f"Into MsgPack: {p}")
+    print(f"From MsgPack: {from_msgpack(Foo, p)}")
+
+
+if __name__ == '__main__':
+    main()

examples/runner.py

@@ -18,6 +18,7 @@
 import jsonfile
 import lazy_type_evaluation
 import literal
+import msg_pack
 import newtype
 import pep681
 import plain_dataclass
@@ -80,6 +81,7 @@ def run_all():
     run(class_var)
     run(plain_dataclass)
     run(plain_dataclass_class_attribute)
+    run(msg_pack)
     if PY310:
         import union_operator
 

serde/de.py

@@ -9,7 +9,7 @@
 import functools
 import typing
 from dataclasses import dataclass, is_dataclass
-from typing import Any, Callable, Dict, Iterator, List, Optional, TypeVar
+from typing import Any, Callable, Dict, List, Optional, TypeVar
 
 import jinja2
 from typing_extensions import Type, dataclass_transform
@@ -18,6 +18,7 @@
     Literal,
     SerdeError,
     SerdeSkip,
+    T,
     UserError,
     find_generic_arg,
     get_args,
@@ -367,7 +368,7 @@ def deserialize(cls, data, **opts):
         raise NotImplementedError
 
 
-def from_obj(c: Type, o: Any, named: bool, reuse_instances: bool):
+def from_obj(c: Type[T], o: Any, named: bool, reuse_instances: bool) -> T:
     """
     Deserialize from an object into an instance of the type specified as arg `c`.
     `c` can be either primitive type, `List`, `Tuple`, `Dict` or `deserialize` class.
@@ -462,7 +463,7 @@ def deserializable_to_obj(cls):
         raise SerdeError(e)
 
 
-def from_dict(cls, o, reuse_instances: bool = ...):
+def from_dict(cls: Type[T], o, reuse_instances: bool = ...) -> T:
     """
     Deserialize dictionary into object.
 
@@ -485,7 +486,7 @@ def from_dict(cls, o, reuse_instances: bool = ...):
     return from_obj(cls, o, named=True, reuse_instances=reuse_instances)
 
 
-def from_tuple(cls, o, reuse_instances: bool = ...):
+def from_tuple(cls: Type[T], o: Any, reuse_instances: bool = ...) -> T:
     """
     Deserialize tuple into object.
 

serde/msgpack.py

@@ -75,7 +75,7 @@ def from_msgpack(
     named: bool = True,
     ext_dict: Dict[int, Type] = None,
     **opts,
-) -> Type[T]:
+) -> T:
     """
     Deserialize from MsgPack into the object.