Merge pull request #256 from yukinarit/add-example

Add type coercing example

Author: yukinarit

bench/pyproject.toml

@@ -10,11 +10,11 @@ click = "*"
 pyserde = {path = "../"}
 
 [tool.poetry.dev-dependencies]
-dacite = "*"
-mashumaro = "^2.11.0"
-marshmallow = "~=3.2"
-attrs = "*"
-cattrs = "*"
-seaborn = "==0.9.0"
-matplotlib = "==3.1.1"
-numpy = "==1.17.2"
+# dacite = "*"
+# mashumaro = "^2.11.0"
+# marshmallow = "~=3.2"
+# attrs = "*"
+# cattrs = "*"
+# seaborn = "*"
+# matplotlib = "*"
+# numpy = "*"

docs/features/type-check.md

@@ -1,6 +1,6 @@
 # Type Checking
 
-This is one of the most awaited features. `pyserde` v0.9 adds the experimental type checkers. As this feature is still experimental, the type checking is not perfect. Also, [@tbsexton](https://github.com/tbsexton) is looking into more beautiful solution, the entire backend of type checker may be replaced by [beartype](https://github.com/beartype/beartype) in the future.
+This is one of the most awaited features. `pyserde` v0.9 adds the experimental type checkers. As this feature is still experimental, the type checking is not perfect. Also, [@tbsexton](https://github.com/tbsexton) is looking into [more beautiful solution](https://github.com/yukinarit/pyserde/issues/237#issuecomment-1191714102), the entire backend of type checker may be replaced by [beartype](https://github.com/beartype/beartype) in the future.
 
 ### `NoCheck`
 
@@ -48,3 +48,25 @@ foo = Foo(10)
 # SerdeError will be raised in this case because of the type mismatch.
 print(to_json(foo))
 ```
+
+> **NOTE:** Since pyserde is a serialization framework, it provides type checks or coercing only during (de)serialization. For example, pyserde doesn't complain even if incompatible value is assigned in the object below.
+>
+> ```python
+> @serde(type_check=Strict)
+> @dataclass
+> class Foo
+>     s: str
+>
+> f = Foo(100) # pyserde doesn't raise an error
+> ```
+>
+> If you want to detect runtime type errors, I recommend to use [beartype](https://github.com/beartype/beartype).
+> ```python
+> @beartype
+> @serde(type_check=Strict)
+> @dataclass
+> class Foo
+>     s: str
+>
+> f = Foo(100) # beartype raises an error
+> ```

docs/getting-started.md

@@ -35,7 +35,7 @@ class Foo:
 
 pyserde generates methods necessary for (de)serialization by `@serde` when a class is loaded into python interpreter. The code generation occurs only once and there is no overhead when you use the generated methods. Now your class is serializable and deserializable in the data formats supported by pyserde.
 
-> **Note:** If you need only either serialization or deserialization functionality, you can use `@serialize` or `@deserialize` instead of `@serde` decorator.
+> **NOTE:** If you need only either serialization or deserialization functionality, you can use `@serialize` or `@deserialize` instead of `@serde` decorator.
 >
 > e.g. If you don't need deserialization functionality, you can add `@serialize` decorator only. But, calling deserialize API e.g. `from_json` for `Foo` will raise an error.
 > ```python

examples/runner.py

@@ -18,6 +18,7 @@
 import simple
 import skip
 import tomlfile
+import type_check_coerce
 import type_check_strict
 import type_datetime
 import type_decimal
@@ -53,8 +54,9 @@ def run_all():
     run(generics)
     run(lazy_type_evaluation)
     run(literal)
-    run(user_exception)
     run(type_check_strict)
+    run(type_check_coerce)
+    run(user_exception)
     if PY310:
         import union_operator
 

examples/simple.py

@@ -1,10 +1,10 @@
 from dataclasses import dataclass
 
-from serde import Strict, serde
+from serde import serde
 from serde.json import from_json, to_json
 
 
-@serde(type_check=Strict)
+@serde
 @dataclass
 class Foo:
     i: int

examples/type_check_coerce.py

@@ -0,0 +1,32 @@
+from dataclasses import dataclass
+from typing import Dict, List, Optional
+
+from serde import Coerce, SerdeError, serde
+from serde.json import from_json, to_json
+
+
+@serde(type_check=Coerce)
+@dataclass
+class Bar:
+    e: int
+
+
+@serde(type_check=Coerce)
+@dataclass
+class Foo:
+    a: int
+    b: List[int]
+    c: List[Dict[str, int]]
+    d: Optional[Bar] = None
+
+
+def main():
+    f = Foo(a="1", b=[True], c=[{10: 1.0}])
+    print(f"Into Json: {to_json(f)}")
+
+    s = '{"a": "1", "b": [false], "c": [{"10": 1.0}], "d": {"e": "100"}}'
+    print(f"From Json: {from_json(Foo, s)}")
+
+
+if __name__ == '__main__':
+    main()

examples/type_check_strict.py

@@ -5,7 +5,7 @@
 from serde.json import from_json, to_json
 
 
-@serde
+@serde(type_check=Strict)
 @dataclass
 class Foo:
     a: int
@@ -16,14 +16,14 @@ class Foo:
 def main():
     f = Foo(a=1.0, b=[1.0], c=[{"k": 1.0}])
     try:
-        print(f"Into Json: {to_json(f, type_check=Strict)}")
-    except Exception as e:
+        print(f"Into Json: {to_json(f)}")
+    except SerdeError as e:
         print(e)
 
     s = '{"a": 1, "b": [1], "c": [{"k": 1.0}]}'
     try:
-        print(f"From Json: {from_json(Foo, s, type_check=Strict)}")
-    except Exception as e:
+        print(f"From Json: {from_json(Foo, s)}")
+    except SerdeError as e:
         print(e)