Define type of JSON-like data

Author: jg-rp

jsonpath_rfc9535/environment.py

@@ -37,6 +37,18 @@
     from .tokens import Token
 
 
+JSONLikeData = Union[
+    List[Any],
+    Dict[str, Any],
+    str,
+    int,
+    float,
+    None,
+    bool,
+]
+"""JSON-like data, as you would get from `json.load()`."""
+
+
 class JSONPathEnvironment:
     """JSONPath configuration.
 
@@ -89,7 +101,7 @@ def compile(self, path: str) -> JSONPath:  # noqa: A003
     def finditer(
         self,
         path: str,
-        data: Union[List[Any], Dict[str, Any], str],
+        data: JSONLikeData,
     ) -> Iterable[JSONPathNode]:
         """Generate `JSONPathNode` instances for each match of _path_ in _data_.
 
@@ -110,7 +122,7 @@ def finditer(
     def findall(
         self,
         path: str,
-        data: Union[List[Any], Dict[str, Any], str],
+        data: JSONLikeData,
     ) -> List[object]:
         """Find all values in _data_ matching JSONPath query _path_.
 
@@ -131,7 +143,7 @@ def findall(
     def query(
         self,
         path: str,
-        data: Union[List[Any], Dict[str, Any], str],
+        data: JSONLikeData,
     ) -> JSONPathNodeList:
         """Apply the JSONPath query _path_ to JSON-like _data_.
 

jsonpath_rfc9535/expressions.py

@@ -6,13 +6,10 @@
 from abc import ABC
 from abc import abstractmethod
 from typing import TYPE_CHECKING
-from typing import Any
-from typing import Dict
 from typing import Generic
 from typing import List
 from typing import Sequence
 from typing import TypeVar
-from typing import Union
 
 from jsonpath_rfc9535.function_extensions.filter_function import ExpressionType
 from jsonpath_rfc9535.function_extensions.filter_function import FilterFunction
@@ -21,6 +18,7 @@
 from .node import JSONPathNodeList
 
 if TYPE_CHECKING:
+    from .environment import JSONLikeData
     from .environment import JSONPathEnvironment
     from .path import JSONPath
     from .tokens import Token
@@ -349,7 +347,7 @@ def __init__(
         *,
         env: JSONPathEnvironment,
         current: object,
-        root: Union[List[Any], Dict[str, Any], str],
+        root: JSONLikeData,
     ) -> None:
         self.env = env
         self.current = current

jsonpath_rfc9535/node.py

@@ -1,11 +1,15 @@
 """JSONPath node and node list definitions."""
 
-from typing import Any
-from typing import Dict
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
 from typing import List
 from typing import Tuple
 from typing import Union
 
+if TYPE_CHECKING:
+    from .environment import JSONLikeData
+
 
 class JSONPathNode:
     """A JSON-like value and its location in a JSON document.
@@ -26,11 +30,11 @@ def __init__(
         *,
         value: object,
         parts: Tuple[Union[int, str], ...],
-        root: Union[List[Any], Dict[str, Any], str],
+        root: JSONLikeData,
     ) -> None:
         self.value: object = value
         self.parts: Tuple[Union[int, str], ...] = parts
-        self.root: Union[List[Any], Dict[str, Any], str] = root
+        self.root = root
 
     def path(self) -> str:
         """Return the normalized path to this node."""
@@ -53,14 +57,14 @@ def values(self) -> List[object]:
         return [node.value for node in self]
 
     def values_or_singular(self) -> object:
-        """Return the values from this node list."""
+        """Return values from this node list, or a single value if there's one node."""
         if len(self) == 1:
             return self[0].value
         return [node.value for node in self]
 
     def empty(self) -> bool:
         """Return `True` if this node list is empty."""
-        return not bool(self)
+        return not self
 
     def __str__(self) -> str:
         return f"NodeList{super().__str__()}"

jsonpath_rfc9535/path.py

@@ -3,12 +3,9 @@
 from __future__ import annotations
 
 from typing import TYPE_CHECKING
-from typing import Any
-from typing import Dict
 from typing import Iterable
 from typing import List
 from typing import Tuple
-from typing import Union
 
 from .node import JSONPathNode
 from .node import JSONPathNodeList
@@ -17,6 +14,7 @@
 from .selectors import PropertySelector
 
 if TYPE_CHECKING:
+    from .environment import JSONLikeData
     from .environment import JSONPathEnvironment
     from .segments import JSONPathSegment
 
@@ -53,7 +51,7 @@ def __hash__(self) -> int:
 
     def finditer(
         self,
-        data: Union[List[Any], Dict[str, Any], str],
+        data: JSONLikeData,
     ) -> Iterable[JSONPathNode]:
         """Generate `JSONPathNode` instances for each match of this path in _data_.
 
@@ -83,7 +81,7 @@ def finditer(
 
     def findall(
         self,
-        data: Union[List[Any], Dict[str, Any], str],
+        data: JSONLikeData,
     ) -> List[object]:
         """Find all values in _data_ matching this JSONPath.
 
@@ -102,7 +100,7 @@ def findall(
 
     def query(
         self,
-        data: Union[List[Any], Dict[str, Any], str],
+        data: JSONLikeData,
     ) -> JSONPathNodeList:
         """Apply this JSONPath query to JSON-like _data_ and return a node list.