better types

Author: seperman

deepdiff/base.py

@@ -1,11 +1,21 @@
+from typing import Protocol, Any
 from deepdiff.helper import strings, numbers, SetOrdered
 
 
 DEFAULT_SIGNIFICANT_DIGITS_WHEN_IGNORE_NUMERIC_TYPES = 12
 TYPE_STABILIZATION_MSG = 'Unable to stabilize the Numpy array {} due to {}. Please set ignore_order=False.'
 
 
-class Base:
+class BaseProtocol(Protocol):
+    t1: Any
+    t2: Any
+    cutoff_distance_for_pairs: float
+    use_log_scale: bool
+    log_scale_similarity_threshold: float
+    view: str
+
+
+class Base(BaseProtocol):
     numbers = numbers
     strings = strings
 

deepdiff/distance.py

@@ -1,5 +1,6 @@
 import math
 import datetime
+from deepdiff.base import BaseProtocol
 from deepdiff.deephash import DeepHash
 from deepdiff.helper import (
     DELTA_VIEW, numbers, strings, add_to_frozen_set, not_found, only_numbers, np, np_float64, time_to_seconds,
@@ -11,7 +12,9 @@
 DISTANCE_CALCS_NEEDS_CACHE = "Distance calculation can not happen once the cache is purged. Try with _cache='keep'"
 
 
-class DistanceMixin:
+
+
+class DistanceMixin(BaseProtocol):
 
     def _get_rough_distance(self):
         """

deepdiff/serialization.py

@@ -202,7 +202,7 @@ def to_json(self, default_mapping: Optional[dict]=None, force_use_builtin_json=F
             **kwargs,
         )
 
-    def to_dict(self, view_override=None):
+    def to_dict(self, view_override: Optional[str]=None) -> dict:
         """
         convert the result to a python dictionary. You can override the view type by passing view_override.
 
@@ -216,7 +216,12 @@ def to_dict(self, view_override=None):
         view = view_override if view_override else self.view  # type: ignore
         return dict(self._get_view_results(view))  # type: ignore
 
-    def _to_delta_dict(self, directed=True, report_repetition_required=True, always_include_values=False):
+    def _to_delta_dict(
+        self,
+        directed: bool = True,
+        report_repetition_required: bool = True,
+        always_include_values: bool = False,
+    ) -> dict:
         """
         Dump to a dictionary suitable for delta usage.
         Unlike to_dict, this is not dependent on the original view that the user chose to create the diff.