adding better type hints for json_dumps

Author: seperman

deepdiff/diff.py

@@ -12,7 +12,7 @@
 from enum import Enum
 from copy import deepcopy
 from math import isclose as is_close
-from typing import List, Dict, Callable, Union, Any, Pattern, Tuple, Optional
+from typing import List, Dict, Callable, Union, Any, Pattern, Tuple, Optional, Set, FrozenSet
 from collections.abc import Mapping, Iterable, Sequence
 from collections import defaultdict
 from inspect import getmembers
@@ -131,7 +131,7 @@ def __init__(self,
                  encodings: Optional[List[str]]=None,
                  exclude_obj_callback: Optional[Callable]=None,
                  exclude_obj_callback_strict: Optional[Callable]=None,
-                 exclude_paths: Union[str, List[str], None]=None,
+                 exclude_paths: Union[str, List[str], Set[str], FrozenSet[str], None]=None,
                  exclude_regex_paths: Union[str, List[str], Pattern[str], List[Pattern[str]], None]=None,
                  exclude_types: Optional[List[Any]]=None,
                  get_deep_distance: bool=False,

deepdiff/helper.py

@@ -785,6 +785,7 @@ class FlatDataAction(EnumBase):
     attribute_added = 'attribute_added'
     unordered_iterable_item_added = 'unordered_iterable_item_added'
     unordered_iterable_item_removed = 'unordered_iterable_item_removed'
+    initiated = "initiated"
 
 
 OPCODE_TAG_TO_FLAT_DATA_ACTION = {
@@ -797,7 +798,7 @@ class FlatDataAction(EnumBase):
 FLAT_DATA_ACTION_TO_OPCODE_TAG = {v: i for i, v in OPCODE_TAG_TO_FLAT_DATA_ACTION.items()}
 
 
-UnkownValueCode = 'unknown___'
+UnkownValueCode: str = 'unknown___'
 
 
 class FlatDeltaRow(NamedTuple):

deepdiff/serialization.py

@@ -14,7 +14,10 @@
 from copy import deepcopy, copy
 from functools import partial
 from collections.abc import Mapping
-from typing import Callable, Optional, Union
+from typing import (
+    Callable, Optional, Union,
+    overload, Literal, Any,
+)
 from deepdiff.helper import (
     strings,
     get_type,
@@ -337,8 +340,8 @@ def find_class(self, module, name):
         # Forbid everything else.
         raise ForbiddenModule(FORBIDDEN_MODULE_MSG.format(module_dot_class)) from None
 
-    def persistent_load(self, persistent_id):
-        if persistent_id == "<<NoneType>>":
+    def persistent_load(self, pid):
+        if pid == "<<NoneType>>":
             return type(None)
 
 
@@ -642,9 +645,40 @@ def object_hook(self, obj):  # type: ignore
         return obj
 
 
+
+@overload
+def json_dumps(
+    item: Any,
+    **kwargs,
+) -> str:
+    ...
+
+
+@overload
+def json_dumps(
+    item: Any,
+    default_mapping:Optional[dict],
+    force_use_builtin_json: bool,
+    return_bytes:Literal[True],
+    **kwargs,
+) -> bytes:
+    ...
+
+
+@overload
+def json_dumps(
+    item: Any,
+    default_mapping:Optional[dict],
+    force_use_builtin_json: bool,
+    return_bytes:Literal[False],
+    **kwargs,
+) -> str:
+    ...
+
+
 def json_dumps(
-    item,
-    default_mapping=None,
+    item: Any,
+    default_mapping:Optional[dict]=None,
     force_use_builtin_json: bool = False,
     return_bytes: bool = False,
     **kwargs,