Skip to content

model: fill in missing type annotations #650

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jorenham wants to merge 1 commit into
base: dev
Choose a base branch
from
+59 −39
Open

model: fill in missing type annotations #650

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
98 changes: 59 additions & 39 deletions deepdiff/model.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import logging
from collections.abc import Mapping
from copy import copy
from typing import Any, Dict, List, Optional, Set, Union, Literal, Type, TYPE_CHECKING
from typing import Any, Literal, TYPE_CHECKING
from deepdiff.helper import (
RemapDict, strings, notpresent, get_type, numpy_numbers, np, literal_eval_extended,
dict_, SetOrdered)
Expand All @@ -10,12 +10,12 @@
if TYPE_CHECKING:
from deepdiff.diff import DeepDiff

logger = logging.getLogger(__name__)
logger: logging.Logger = logging.getLogger(__name__)

FORCE_DEFAULT: Literal['fake'] = 'fake'
UP_DOWN: Dict[str, str] = {'up': 'down', 'down': 'up'}
UP_DOWN: dict[str, str] = {'up': 'down', 'down': 'up'}

REPORT_KEYS: Set[str] = {
REPORT_KEYS: set[str] = {
"type_changes",
"dictionary_item_added",
"dictionary_item_removed",
Expand Down Expand Up @@ -110,7 +110,9 @@ def __len__(self) -> int:
class TextResult(ResultDict):
ADD_QUOTES_TO_STRINGS: bool = True

def __init__(self, tree_results: Optional['TreeResult'] = None, verbose_level: int = 1) -> None:
verbose_level: int

def __init__(self, tree_results: 'TreeResult | None' = None, verbose_level: int = 1) -> None:
self.verbose_level = verbose_level
# TODO: centralize keys
self.update({
Expand All @@ -132,7 +134,7 @@ def __init__(self, tree_results: Optional['TreeResult'] = None, verbose_level: i
if tree_results:
self._from_tree_results(tree_results)

def __set_or_dict(self) -> Union[Dict[str, Any], SetOrdered]:
def __set_or_dict(self) -> dict[str, Any] | SetOrdered:
return {} if self.verbose_level >= 2 else SetOrdered()

def _from_tree_results(self, tree: 'TreeResult') -> None:
Expand All @@ -159,7 +161,7 @@ def _from_tree_results(self, tree: 'TreeResult') -> None:

def _from_tree_default(self, tree: 'TreeResult', report_type: str, ignore_if_in_iterable_opcodes: bool = False) -> None:
if report_type in tree:

for change in tree[report_type]: # report each change
# When we convert from diff to delta result, we care more about opcodes than iterable_item_added or removed
if (
Expand Down Expand Up @@ -301,7 +303,10 @@ def _from_tree_custom_results(self, tree):
class DeltaResult(TextResult):
ADD_QUOTES_TO_STRINGS: bool = False

def __init__(self, tree_results: Optional['TreeResult'] = None, ignore_order: Optional[bool] = None, always_include_values: bool = False, _iterable_opcodes: Optional[Dict[str, Any]] = None) -> None:
ignore_order: bool | None
always_include_values: bool

def __init__(self, tree_results: 'TreeResult | None' = None, ignore_order: bool | None = None, always_include_values: bool = False, _iterable_opcodes: dict[str, Any] | None = None) -> None:
self.ignore_order = ignore_order
self.always_include_values = always_include_values

Expand Down Expand Up @@ -524,15 +529,26 @@ class DiffLevel:

"""

t1: Any
t2: Any
down: 'DiffLevel | None'
up: 'DiffLevel | None'
report_type: str | None
additional: dict[str, Any]
t1_child_rel: 'ChildRelationship | None'
t2_child_rel: 'ChildRelationship | None'
_path: dict[str, Any]
verbose_level: int

def __init__(self,
t1: Any,
t2: Any,
down: Optional['DiffLevel'] = None,
up: Optional['DiffLevel'] = None,
report_type: Optional[str] = None,
child_rel1: Optional['ChildRelationship'] = None,
child_rel2: Optional['ChildRelationship'] = None,
additional: Optional[Dict[str, Any]] = None,
down: 'DiffLevel | None' = None,
up: 'DiffLevel | None' = None,
report_type: str | None = None,
child_rel1: 'ChildRelationship | None' = None,
child_rel2: 'ChildRelationship | None' = None,
additional: dict[str, Any] | None = None,
verbose_level: int = 1) -> None:
"""
:param child_rel1: Either:
Expand Down Expand Up @@ -618,10 +634,10 @@ def __iter__(self) -> Any:
yield self.t2

@property
def repetition(self) -> Dict[str, Any]:
def repetition(self) -> dict[str, Any]:
return self.additional['repetition']

def auto_generate_child_rel(self, klass: Type['ChildRelationship'], param: Any, param2: Optional[Any] = None) -> None:
def auto_generate_child_rel(self, klass: type['ChildRelationship'], param: Any, param2: Any | None = None) -> None:
"""
Auto-populate self.child_rel1 and self.child_rel2.
This requires self.down to be another valid DiffLevel object.
Expand Down Expand Up @@ -662,7 +678,7 @@ def all_down(self) -> 'DiffLevel':
return level

@staticmethod
def _format_result(root: str, result: Optional[str]) -> Optional[str]:
def _format_result(root: str, result: str | None) -> str | None:
return None if result is None else "{}{}".format(root, result)

def get_root_key(self, use_t2: bool = False) -> Any:
Expand All @@ -682,7 +698,7 @@ def get_root_key(self, use_t2: bool = False) -> Any:
return next_rel.param
return notpresent

def path(self, root: str = "root", force: Optional[str] = None, get_parent_too: bool = False, use_t2: bool = False, output_format: Literal['str', 'list'] = 'str', reporting_move: bool = False) -> Any:
def path(self, root: str = "root", force: str | None = None, get_parent_too: bool = False, use_t2: bool = False, output_format: Literal['str', 'list'] = 'str', reporting_move: bool = False) -> Any:
"""
A python syntax string describing how to descend to this level, assuming the top level object is called root.
Returns None if the path is not representable as a string.
Expand Down Expand Up @@ -781,10 +797,10 @@ def path(self, root: str = "root", force: Optional[str] = None, get_parent_too:
def create_deeper(self,
new_t1: Any,
new_t2: Any,
child_relationship_class: Type['ChildRelationship'],
child_relationship_param: Optional[Any] = None,
child_relationship_param2: Optional[Any] = None,
report_type: Optional[str] = None) -> 'DiffLevel':
child_relationship_class: type['ChildRelationship'],
child_relationship_param: Any | None = None,
child_relationship_param2: Any | None = None,
report_type: str | None = None) -> 'DiffLevel':
"""
Start a new comparison level and correctly link it to this one.
:rtype: DiffLevel
Expand All @@ -801,10 +817,10 @@ def create_deeper(self,
def branch_deeper(self,
new_t1: Any,
new_t2: Any,
child_relationship_class: Type['ChildRelationship'],
child_relationship_param: Optional[Any] = None,
child_relationship_param2: Optional[Any] = None,
report_type: Optional[str] = None) -> 'DiffLevel':
child_relationship_class: type['ChildRelationship'],
child_relationship_param: Any | None = None,
child_relationship_param2: Any | None = None,
report_type: str | None = None) -> 'DiffLevel':
"""
Branch this comparison: Do not touch this comparison line, but create a new one with exactly the same content,
just one level deeper.
Expand Down Expand Up @@ -858,20 +874,24 @@ class ChildRelationship:

# Format to a be used for representing param.
# E.g. for a dict, this turns a formatted param param "42" into "[42]".
param_repr_format: Optional[str] = None
param_repr_format: str | None = None

# This is a hook allowing subclasses to manipulate param strings.
# :param string: Input string
# :return: Manipulated string, as appropriate in this context.
quote_str: Optional[str] = None
quote_str: str | None = None

parent: Any
child: Any
param: Any | None

@staticmethod
def create(klass: Type['ChildRelationship'], parent: Any, child: Any, param: Optional[Any] = None) -> 'ChildRelationship':
def create(klass: type['ChildRelationship'], parent: Any, child: Any, param: Any | None = None) -> 'ChildRelationship':
if not issubclass(klass, ChildRelationship):
raise TypeError
return klass(parent, child, param)

def __init__(self, parent: Any, child: Any, param: Optional[Any] = None) -> None:
def __init__(self, parent: Any, child: Any, param: Any | None = None) -> None:
# The parent object of this relationship, e.g. a dict
self.parent = parent

Expand All @@ -890,7 +910,7 @@ def __repr__(self) -> str:
param = summarize(self.param, max_length=15)
return name.format(self.__class__.__name__, parent, child, param)

def get_param_repr(self, force: Optional[str] = None) -> Optional[str]:
def get_param_repr(self, force: str | None = None) -> str | None:
"""
Returns a formatted param python parsable string describing this relationship,
or None if the relationship is not representable as a string.
Expand All @@ -907,7 +927,7 @@ def get_param_repr(self, force: Optional[str] = None) -> Optional[str]:
"""
return self.stringify_param(force)

def stringify_param(self, force: Optional[str] = None) -> Optional[str]:
def stringify_param(self, force: str | None = None) -> str | None:
"""
Convert param to a string. Return None if there is no string representation.
This is called by get_param_repr()
Expand Down Expand Up @@ -954,13 +974,13 @@ def stringify_param(self, force: Optional[str] = None) -> Optional[str]:


class DictRelationship(ChildRelationship):
param_repr_format: Optional[str] = "[{}]"
quote_str: Optional[str] = "'{}'"
param_repr_format: str | None = "[{}]"
quote_str: str | None = "'{}'"


class NumpyArrayRelationship(ChildRelationship):
param_repr_format: Optional[str] = "[{}]"
quote_str: Optional[str] = None
param_repr_format: str | None = "[{}]"
quote_str: str | None = None


class SubscriptableIterableRelationship(DictRelationship):
Expand All @@ -978,9 +998,9 @@ class SetRelationship(InaccessibleRelationship):

class NonSubscriptableIterableRelationship(InaccessibleRelationship):

param_repr_format: Optional[str] = "[{}]"
param_repr_format: str | None = "[{}]"

def get_param_repr(self, force: Optional[str] = None) -> Optional[str]:
def get_param_repr(self, force: str | None = None) -> str | None:
if force == 'yes':
result = "(unrepresentable)"
elif force == 'fake' and self.param:
Expand All @@ -992,4 +1012,4 @@ def get_param_repr(self, force: Optional[str] = None) -> Optional[str]:


class AttributeRelationship(ChildRelationship):
param_repr_format: Optional[str] = ".{}"
param_repr_format: str | None = ".{}"