feat(json): serialize None as null, close #622

BREAKING CHANGE: The JSONSnapshotExtension now serializes Python's None as "null" rather than "None".
syrupy-project · Dec 30, 2022 · c330680 · c330680 · github-actions · Dec 30, 2022
1 parent f9c6aba
commit c330680
Show file tree

Hide file tree

Showing 6 changed files with 6 additions and 4 deletions.
diff --git a/src/syrupy/extensions/json/__init__.py b/src/syrupy/extensions/json/__init__.py
@@ -64,7 +64,7 @@ def _filter(
         elif matcher:
             data = matcher(data=data, path=path)
 
-        if isinstance(data, (int, float, str)):
+        if isinstance(data, (int, float, str)) or data is None:
             return data
 
         filtered_dct: Dict[Any, Any]

diff --git a/...tensions/json/__snapshots__/test_json_filters/test_exclude_in_json_with_empty_values.json b/...tensions/json/__snapshots__/test_json_filters/test_exclude_in_json_with_empty_values.json
@@ -1,5 +1,5 @@
 {
   "empty_dict": {},
   "empty_list": [],
-  "none": "None"
+  "none": null
 }
diff --git a/tests/syrupy/extensions/json/__snapshots__/test_json_filters/test_serializer[content2].json b/tests/syrupy/extensions/json/__snapshots__/test_json_filters/test_serializer[content2].json
@@ -7,6 +7,6 @@
   "datetime": "2021-01-31T23:59:00.000000",
   "float": 4.2,
   "int": -1,
-  "null": "None",
+  "null": null,
   "str": "foo"
 }
diff --git a/tests/syrupy/extensions/json/__snapshots__/test_json_serializer/test_dict[actual2].json b/tests/syrupy/extensions/json/__snapshots__/test_json_serializer/test_dict[actual2].json
@@ -1,4 +1,5 @@
 {
   "a": "Some ttext.",
+  "key": null,
   "multi\nline\nkey": "Some morre text."
 }
diff --git a/tests/syrupy/extensions/json/__snapshots__/test_json_serializer/test_empty_snapshot.json b/tests/syrupy/extensions/json/__snapshots__/test_json_serializer/test_empty_snapshot.json
@@ -1 +1 @@
-"None"
+null
diff --git a/tests/syrupy/extensions/json/test_json_serializer.py b/tests/syrupy/extensions/json/test_json_serializer.py
@@ -124,6 +124,7 @@ def test_set(snapshot_json, actual):
             "multi\nline\nkey": "Some morre text.",
             frozenset({"1", "2"}): ["1", 2],
             ExampleTuple(a=1, b=2, c=3, d=4): {"e": False},
+            "key": None,
         },
         {},
         {"key": ["line1\nline2"]},
Benchmark suite	Current: `c330680`	Previous: `02abef5`	Ratio
`benchmarks/test_1000x.py::test_1000x_reads`	`0.7565940890112609` iter/sec (`stddev: 0.05404360420624151`)	`0.8381195242511715` iter/sec (`stddev: 0.04240394140227035`)	`1.11`
`benchmarks/test_1000x.py::test_1000x_writes`	`0.7551367850943955` iter/sec (`stddev: 0.06249030230473292`)	`0.8626650008455868` iter/sec (`stddev: 0.05153168408309042`)	`1.14`
`benchmarks/test_standard.py::test_standard`	`0.720072681359854` iter/sec (`stddev: 0.06677892596066112`)	`0.7465173870618954` iter/sec (`stddev: 0.1502009356924296`)	`1.04`