feat: __eq__ and __hash__ for paths and selectors

Author: jg-rp

jsonpath/path.py

@@ -53,6 +53,12 @@ def __str__(self) -> str:
             str(selector) for selector in self.selectors
         )
 
+    def __eq__(self, __value: object) -> bool:
+        return isinstance(__value, JSONPath) and self.selectors == __value.selectors
+
+    def __hash__(self) -> int:
+        return hash(self.selectors)
+
     def findall(
         self,
         data: Union[str, IOBase, Sequence[Any], Mapping[str, Any]],
@@ -236,6 +242,16 @@ def __str__(self) -> str:
             buf.append(str(path))
         return "".join(buf)
 
+    def __eq__(self, __value: object) -> bool:
+        return (
+            isinstance(__value, CompoundJSONPath)
+            and self.path == __value.path
+            and self.paths == __value.paths
+        )
+
+    def __hash__(self) -> int:
+        return hash((self.path, self.paths))
+
     def findall(
         self,
         data: Union[str, IOBase, Sequence[Any], Mapping[str, Any]],

jsonpath/selectors.py

@@ -65,6 +65,16 @@ def __init__(
     def __str__(self) -> str:
         return f"['{self.name}']"
 
+    def __eq__(self, __value: object) -> bool:
+        return (
+            isinstance(__value, PropertySelector)
+            and self.name == __value.name
+            and self.token == __value.token
+        )
+
+    def __hash__(self) -> int:
+        return hash((self.name, self.token))
+
     def resolve(self, matches: Iterable[JSONPathMatch]) -> Iterable[JSONPathMatch]:
         for match in matches:
             if not isinstance(match.obj, Mapping):
@@ -124,6 +134,16 @@ def __init__(
     def __str__(self) -> str:
         return f"[{self.index}]"
 
+    def __eq__(self, __value: object) -> bool:
+        return (
+            isinstance(__value, IndexSelector)
+            and self.index == __value.index
+            and self.token == __value.token
+        )
+
+    def __hash__(self) -> int:
+        return hash((self.index, self.token))
+
     def _normalized_index(self, obj: Sequence[object]) -> int:
         if self.index < 0 and len(obj) >= abs(self.index):
             return len(obj) + self.index
@@ -198,6 +218,12 @@ class KeysSelector(JSONPathSelector):
     def __str__(self) -> str:
         return f"[{self.env.keys_selector_token}]"
 
+    def __eq__(self, __value: object) -> bool:
+        return isinstance(__value, KeysSelector) and self.token == __value.token
+
+    def __hash__(self) -> int:
+        return hash(self.token)
+
     def _keys(self, match: JSONPathMatch) -> Iterable[JSONPathMatch]:
         if isinstance(match.obj, Mapping):
             for i, key in enumerate(match.obj.keys()):
@@ -248,6 +274,16 @@ def __str__(self) -> str:
         step = self.slice.step if self.slice.step is not None else "1"
         return f"[{start}:{stop}:{step}]"
 
+    def __eq__(self, __value: object) -> bool:
+        return (
+            isinstance(__value, SliceSelector)
+            and self.slice == __value.slice
+            and self.token == __value.token
+        )
+
+    def __hash__(self) -> int:
+        return hash((str(self), self.token))
+
     def _check_range(self, *indices: Optional[int]) -> None:
         for i in indices:
             if i is not None and (
@@ -311,6 +347,12 @@ class WildSelector(JSONPathSelector):
     def __str__(self) -> str:
         return "[*]"
 
+    def __eq__(self, __value: object) -> bool:
+        return isinstance(__value, WildSelector) and self.token == __value.token
+
+    def __hash__(self) -> int:
+        return hash(self.token)
+
     def resolve(self, matches: Iterable[JSONPathMatch]) -> Iterable[JSONPathMatch]:
         for match in matches:
             if isinstance(match.obj, str):
@@ -376,6 +418,15 @@ class RecursiveDescentSelector(JSONPathSelector):
     def __str__(self) -> str:
         return ".."
 
+    def __eq__(self, __value: object) -> bool:
+        return (
+            isinstance(__value, RecursiveDescentSelector)
+            and self.token == __value.token
+        )
+
+    def __hash__(self) -> int:
+        return hash(self.token)
+
     def _expand(self, match: JSONPathMatch) -> Iterable[JSONPathMatch]:
         if isinstance(match.obj, Mapping):
             for key, val in match.obj.items():
@@ -453,7 +504,7 @@ def __init__(
         ],
     ) -> None:
         super().__init__(env=env, token=token)
-        self.items = items
+        self.items = tuple(items)
 
     def __str__(self) -> str:
         buf: List[str] = []
@@ -473,6 +524,16 @@ def __str__(self) -> str:
                 buf.append(str(item.index))
         return f"[{', '.join(buf)}]"
 
+    def __eq__(self, __value: object) -> bool:
+        return (
+            isinstance(__value, ListSelector)
+            and self.items == __value.items
+            and self.token == __value.token
+        )
+
+    def __hash__(self) -> int:
+        return hash((self.items, self.token))
+
     def resolve(self, matches: Iterable[JSONPathMatch]) -> Iterable[JSONPathMatch]:
         _matches = list(matches)
         for item in self.items:
@@ -507,6 +568,16 @@ def __init__(
     def __str__(self) -> str:
         return f"[?({self.expression})]"
 
+    def __eq__(self, __value: object) -> bool:
+        return (
+            isinstance(__value, Filter)
+            and self.expression == __value.expression
+            and self.token == __value.token
+        )
+
+    def __hash__(self) -> int:
+        return hash((self.expression, self.token))
+
     def resolve(  # noqa: PLR0912
         self, matches: Iterable[JSONPathMatch]
     ) -> Iterable[JSONPathMatch]:

jsonpath/token.py

@@ -118,6 +118,9 @@ def __eq__(self, other: object) -> bool:
             and self.path == other.path
         )
 
+    def __hash__(self) -> int:
+        return hash((self.kind, self.value, self.index, self.path))
+
     def position(self) -> Tuple[int, int]:
         """Return the line and column number for the start of this token."""
         line_number = self.value.count("\n", 0, self.index) + 1