1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764
|
"""Filter expression nodes."""
from __future__ import annotations
import copy
import re
from abc import ABC
from abc import abstractmethod
from typing import TYPE_CHECKING
from typing import Any
from typing import Callable
from typing import Generic
from typing import Iterable
from typing import List
from typing import Mapping
from typing import Pattern
from typing import Sequence
from typing import TypeVar
from jsonpath.function_extensions.filter_function import ExpressionType
from .exceptions import JSONPathTypeError
from .function_extensions import FilterFunction
from .match import NodeList
from .selectors import Filter as FilterSelector
from .serialize import canonical_string
if TYPE_CHECKING:
from .path import JSONPath
from .selectors import FilterContext
class BaseExpression(ABC):
"""Base class for all filter expression nodes."""
__slots__ = ("volatile",)
FORCE_CACHE = False
def __init__(self) -> None:
self.volatile: bool = any(child.volatile for child in self.children())
@abstractmethod
def evaluate(self, context: FilterContext) -> object:
"""Resolve the filter expression in the given _context_.
Arguments:
context: Contextual information the expression might choose
use during evaluation.
Returns:
The result of evaluating the expression.
"""
@abstractmethod
async def evaluate_async(self, context: FilterContext) -> object:
"""An async version of `evaluate`."""
@abstractmethod
def children(self) -> List[BaseExpression]:
"""Return a list of direct child expressions."""
@abstractmethod
def set_children(self, children: List[BaseExpression]) -> None: # noqa: ARG002
"""Update this expression's child expressions.
_children_ is assumed to have the same number of items as is returned
by _self.children_, and in the same order.
"""
class Nil(BaseExpression):
"""The constant `nil`.
Also aliased as `null` and `None`, sometimes.
"""
__slots__ = ()
def __eq__(self, other: object) -> bool:
return other is None or isinstance(other, Nil)
def __repr__(self) -> str: # pragma: no cover
return "NIL()"
def __str__(self) -> str: # pragma: no cover
return "nil"
def evaluate(self, _: FilterContext) -> None:
return None
async def evaluate_async(self, _: FilterContext) -> None:
return None
def children(self) -> List[BaseExpression]:
return []
def set_children(self, children: List[BaseExpression]) -> None: # noqa: ARG002
return
NIL = Nil()
class _Undefined:
__slots__ = ()
def __eq__(self, other: object) -> bool:
return (
other is UNDEFINED_LITERAL
or other is UNDEFINED
or (isinstance(other, NodeList) and other.empty())
)
def __str__(self) -> str:
return "<UNDEFINED>"
def __repr__(self) -> str:
return "<UNDEFINED>"
# This is equivalent to the spec's special `Nothing` value.
UNDEFINED = _Undefined()
class Undefined(BaseExpression):
"""The constant `undefined`."""
__slots__ = ()
def __eq__(self, other: object) -> bool:
return (
isinstance(other, Undefined)
or other is UNDEFINED
or (isinstance(other, NodeList) and len(other) == 0)
)
def __str__(self) -> str:
return "undefined"
def evaluate(self, _: FilterContext) -> object:
return UNDEFINED
async def evaluate_async(self, _: FilterContext) -> object:
return UNDEFINED
def children(self) -> List[BaseExpression]:
return []
def set_children(self, children: List[BaseExpression]) -> None: # noqa: ARG002
return
UNDEFINED_LITERAL = Undefined()
LITERAL_EXPRESSION_T = TypeVar("LITERAL_EXPRESSION_T")
class FilterExpressionLiteral(BaseExpression, Generic[LITERAL_EXPRESSION_T]):
"""Base class for filter expression literals."""
__slots__ = ("value",)
def __init__(self, *, value: LITERAL_EXPRESSION_T) -> None:
self.value = value
super().__init__()
def __str__(self) -> str:
return repr(self.value).lower()
def __eq__(self, other: object) -> bool:
return self.value == other
def __hash__(self) -> int:
return hash(self.value)
def evaluate(self, _: FilterContext) -> LITERAL_EXPRESSION_T:
return self.value
async def evaluate_async(self, _: FilterContext) -> LITERAL_EXPRESSION_T:
return self.value
def children(self) -> List[BaseExpression]:
return []
def set_children(self, children: List[BaseExpression]) -> None: # noqa: ARG002
return
class BooleanLiteral(FilterExpressionLiteral[bool]):
"""A Boolean `True` or `False`."""
__slots__ = ()
TRUE = BooleanLiteral(value=True)
FALSE = BooleanLiteral(value=False)
class StringLiteral(FilterExpressionLiteral[str]):
"""A string literal."""
__slots__ = ()
def __str__(self) -> str:
return canonical_string(self.value)
class IntegerLiteral(FilterExpressionLiteral[int]):
"""An integer literal."""
__slots__ = ()
class FloatLiteral(FilterExpressionLiteral[float]):
"""A float literal."""
__slots__ = ()
class RegexLiteral(FilterExpressionLiteral[Pattern[str]]):
"""A regex literal."""
__slots__ = ()
RE_FLAG_MAP = {
re.A: "a",
re.I: "i",
re.M: "m",
re.S: "s",
}
RE_UNESCAPE = re.compile(r"\\(.)")
def __str__(self) -> str:
flags: List[str] = []
for flag, ch in self.RE_FLAG_MAP.items():
if self.value.flags & flag:
flags.append(ch)
return f"/{self.value.pattern}/{''.join(flags)}"
class ListLiteral(BaseExpression):
"""A list literal."""
__slots__ = ("items",)
def __init__(self, items: List[BaseExpression]) -> None:
self.items = items
super().__init__()
def __str__(self) -> str:
items = ", ".join(str(item) for item in self.items)
return f"[{items}]"
def __eq__(self, other: object) -> bool:
return isinstance(other, ListLiteral) and self.items == other.items
def evaluate(self, context: FilterContext) -> object:
return [item.evaluate(context) for item in self.items]
async def evaluate_async(self, context: FilterContext) -> object:
return [await item.evaluate_async(context) for item in self.items]
def children(self) -> List[BaseExpression]:
return self.items
def set_children(self, children: List[BaseExpression]) -> None: # noqa: ARG002
self.items = children
class PrefixExpression(BaseExpression):
"""An expression composed of a prefix operator and another expression."""
__slots__ = ("operator", "right")
def __init__(self, operator: str, right: BaseExpression):
self.operator = operator
self.right = right
super().__init__()
def __str__(self) -> str:
return f"{self.operator}{self.right}"
def __eq__(self, other: object) -> bool:
return (
isinstance(other, PrefixExpression)
and self.operator == other.operator
and self.right == other.right
)
def _evaluate(self, context: FilterContext, right: object) -> object:
if self.operator == "!":
return not context.env.is_truthy(right)
raise JSONPathTypeError(f"unknown operator {self.operator} {self.right}")
def evaluate(self, context: FilterContext) -> object:
return self._evaluate(context, self.right.evaluate(context))
async def evaluate_async(self, context: FilterContext) -> object:
return self._evaluate(context, await self.right.evaluate_async(context))
def children(self) -> List[BaseExpression]:
return [self.right]
def set_children(self, children: List[BaseExpression]) -> None:
assert len(children) == 1
self.right = children[0]
class InfixExpression(BaseExpression):
"""A pair of expressions and a comparison or logical operator."""
__slots__ = ("left", "operator", "right", "logical")
def __init__(
self,
left: BaseExpression,
operator: str,
right: BaseExpression,
):
self.left = left
self.operator = operator
self.right = right
self.logical = operator in ("&&", "||")
super().__init__()
def __str__(self) -> str:
if self.logical:
return f"({self.left} {self.operator} {self.right})"
return f"{self.left} {self.operator} {self.right}"
def __eq__(self, other: object) -> bool:
return (
isinstance(other, InfixExpression)
and self.left == other.left
and self.operator == other.operator
and self.right == other.right
)
def evaluate(self, context: FilterContext) -> bool:
left = self.left.evaluate(context)
if not self.logical and isinstance(left, NodeList) and len(left) == 1:
left = left[0].obj
right = self.right.evaluate(context)
if not self.logical and isinstance(right, NodeList) and len(right) == 1:
right = right[0].obj
return context.env.compare(left, self.operator, right)
async def evaluate_async(self, context: FilterContext) -> bool:
left = await self.left.evaluate_async(context)
if not self.logical and isinstance(left, NodeList) and len(left) == 1:
left = left[0].obj
right = await self.right.evaluate_async(context)
if not self.logical and isinstance(right, NodeList) and len(right) == 1:
right = right[0].obj
return context.env.compare(left, self.operator, right)
def children(self) -> List[BaseExpression]:
return [self.left, self.right]
def set_children(self, children: List[BaseExpression]) -> None:
assert len(children) == 2 # noqa: PLR2004
self.left = children[0]
self.right = children[1]
PRECEDENCE_LOWEST = 1
PRECEDENCE_LOGICAL_OR = 3
PRECEDENCE_LOGICAL_AND = 4
PRECEDENCE_PREFIX = 7
class FilterExpression(BaseExpression):
"""An expression that evaluates to `True` or `False`."""
__slots__ = ("expression",)
def __init__(self, expression: BaseExpression):
self.expression = expression
super().__init__()
def cache_tree(self) -> FilterExpression:
"""Return a copy of _self.expression_ augmented with caching nodes."""
def _cache_tree(expr: BaseExpression) -> BaseExpression:
children = expr.children()
if expr.volatile:
_expr = copy.copy(expr)
elif not expr.FORCE_CACHE and len(children) == 0:
_expr = expr
else:
_expr = CachingFilterExpression(copy.copy(expr))
_expr.set_children([_cache_tree(child) for child in children])
return _expr
return FilterExpression(_cache_tree(copy.copy(self.expression)))
def cacheable_nodes(self) -> bool:
"""Return `True` if there are any cacheable nodes in this expression tree."""
return any(
isinstance(node, CachingFilterExpression)
for node in walk(self.cache_tree())
)
def __str__(self) -> str:
return self._canonical_string(self.expression, PRECEDENCE_LOWEST)
def __eq__(self, other: object) -> bool:
return (
isinstance(other, FilterExpression) and self.expression == other.expression
)
def _canonical_string(
self, expression: BaseExpression, parent_precedence: int
) -> str:
if isinstance(expression, InfixExpression):
if expression.operator == "&&":
left = self._canonical_string(expression.left, PRECEDENCE_LOGICAL_AND)
right = self._canonical_string(expression.right, PRECEDENCE_LOGICAL_AND)
expr = f"{left} && {right}"
return (
f"({expr})" if parent_precedence >= PRECEDENCE_LOGICAL_AND else expr
)
if expression.operator == "||":
left = self._canonical_string(expression.left, PRECEDENCE_LOGICAL_OR)
right = self._canonical_string(expression.right, PRECEDENCE_LOGICAL_OR)
expr = f"{left} || {right}"
return (
f"({expr})" if parent_precedence >= PRECEDENCE_LOGICAL_OR else expr
)
if isinstance(expression, PrefixExpression):
operand = self._canonical_string(expression.right, PRECEDENCE_PREFIX)
expr = f"!{operand}"
return f"({expr})" if parent_precedence > PRECEDENCE_PREFIX else expr
return str(expression)
def evaluate(self, context: FilterContext) -> bool:
return context.env.is_truthy(self.expression.evaluate(context))
async def evaluate_async(self, context: FilterContext) -> bool:
return context.env.is_truthy(await self.expression.evaluate_async(context))
def children(self) -> List[BaseExpression]:
return [self.expression]
def set_children(self, children: List[BaseExpression]) -> None:
assert len(children) == 1
self.expression = children[0]
class CachingFilterExpression(BaseExpression):
"""A FilterExpression wrapper that caches the result."""
__slots__ = (
"_cached",
"_expr",
)
_UNSET = object()
def __init__(self, expression: BaseExpression):
self.volatile = False
self._expr = expression
self._cached: object = self._UNSET
def evaluate(self, context: FilterContext) -> object:
if self._cached is self._UNSET:
self._cached = self._expr.evaluate(context)
return self._cached
async def evaluate_async(self, context: FilterContext) -> object:
if self._cached is self._UNSET:
self._cached = await self._expr.evaluate_async(context)
return self._cached
def children(self) -> List[BaseExpression]:
return self._expr.children()
def set_children(self, children: List[BaseExpression]) -> None:
self._expr.set_children(children)
class FilterQuery(BaseExpression, ABC):
"""Base expression for all _sub paths_ found in filter expressions."""
__slots__ = ("path",)
def __init__(self, path: JSONPath) -> None:
self.path = path
super().__init__()
def __eq__(self, other: object) -> bool:
return isinstance(other, FilterQuery) and str(self) == str(other)
def children(self) -> List[BaseExpression]:
_children: List[BaseExpression] = []
for segment in self.path.segments:
for selector in segment.selectors:
if isinstance(selector, FilterSelector):
_children.append(selector.expression)
return _children
def set_children(self, children: List[BaseExpression]) -> None: # noqa: ARG002
# self.path has its own cache
return
class RelativeFilterQuery(FilterQuery):
"""A JSONPath starting at the current node."""
__slots__ = ()
def __init__(self, path: JSONPath) -> None:
super().__init__(path)
self.volatile = True
def __str__(self) -> str:
return "@" + str(self.path)[1:]
def evaluate(self, context: FilterContext) -> object:
if isinstance(context.current, str) or not isinstance(
context.current, (Sequence, Mapping)
):
if self.path.empty():
return context.current
return NodeList()
return NodeList(
self.path.finditer(
context.current,
filter_context=context.extra_context,
)
)
async def evaluate_async(self, context: FilterContext) -> object:
if isinstance(context.current, str) or not isinstance(
context.current, (Sequence, Mapping)
):
if self.path.empty():
return context.current
return NodeList()
return NodeList(
[
match
async for match in await self.path.finditer_async(
context.current,
filter_context=context.extra_context,
)
]
)
class RootFilterQuery(FilterQuery):
"""A JSONPath starting at the root node."""
__slots__ = ()
FORCE_CACHE = True
def __init__(self, path: JSONPath) -> None:
super().__init__(path)
self.volatile = False
def __str__(self) -> str:
return str(self.path)
def evaluate(self, context: FilterContext) -> object:
return NodeList(
self.path.finditer(
context.root,
filter_context=context.extra_context,
)
)
async def evaluate_async(self, context: FilterContext) -> object:
return NodeList(
[
match
async for match in await self.path.finditer_async(
context.root,
filter_context=context.extra_context,
)
]
)
class FilterContextPath(FilterQuery):
"""A JSONPath starting at the root of any extra context data."""
__slots__ = ()
FORCE_CACHE = True
def __init__(self, path: JSONPath) -> None:
super().__init__(path)
self.volatile = False
def __str__(self) -> str:
path_repr = str(self.path)
return "_" + path_repr[1:]
def evaluate(self, context: FilterContext) -> object:
return NodeList(
self.path.finditer(
context.extra_context,
filter_context=context.extra_context,
)
)
async def evaluate_async(self, context: FilterContext) -> object:
return NodeList(
[
match
async for match in await self.path.finditer_async(
context.extra_context,
filter_context=context.extra_context,
)
]
)
class FunctionExtension(BaseExpression):
"""A filter function."""
__slots__ = ("name", "args")
def __init__(self, name: str, args: Sequence[BaseExpression]) -> None:
self.name = name
self.args = args
super().__init__()
def __str__(self) -> str:
args = [str(arg) for arg in self.args]
return f"{self.name}({', '.join(args)})"
def __eq__(self, other: object) -> bool:
return (
isinstance(other, FunctionExtension)
and other.name == self.name
and other.args == self.args
)
def evaluate(self, context: FilterContext) -> object:
try:
func = context.env.function_extensions[self.name]
except KeyError:
# This can only happen if the environment's function register has been
# changed since the query was parsed.
return UNDEFINED
args = [arg.evaluate(context) for arg in self.args]
return func(*self._unpack_node_lists(func, args))
async def evaluate_async(self, context: FilterContext) -> object:
try:
func = context.env.function_extensions[self.name]
except KeyError:
# This can only happen if the environment's function register has been
# changed since the query was parsed.
return UNDEFINED
args = [await arg.evaluate_async(context) for arg in self.args]
return func(*self._unpack_node_lists(func, args))
def _unpack_node_lists(
self, func: Callable[..., Any], args: List[object]
) -> List[object]:
if isinstance(func, FilterFunction):
_args: List[object] = []
for idx, arg in enumerate(args):
if func.arg_types[idx] != ExpressionType.NODES and isinstance(
arg, NodeList
):
if len(arg) == 0:
# If the query results in an empty nodelist, the
# argument is the special result Nothing.
_args.append(UNDEFINED)
elif len(arg) == 1:
# If the query results in a nodelist consisting of a
# single node, the argument is the value of the node
_args.append(arg[0].obj)
else:
# This should not be possible as a non-singular query
# would have been rejected when checking function
# well-typedness.
_args.append(arg)
else:
_args.append(arg)
return _args
# Legacy way to indicate that a filter function wants node lists as arguments.
if getattr(func, "with_node_lists", False):
return args
return [
obj.values_or_singular() if isinstance(obj, NodeList) else obj
for obj in args
]
def children(self) -> List[BaseExpression]:
return list(self.args)
def set_children(self, children: List[BaseExpression]) -> None:
assert len(children) == len(self.args)
self.args = children
class CurrentKey(BaseExpression):
"""The key/property or index associated with the current object."""
__slots__ = ()
def __init__(self) -> None:
super().__init__()
self.volatile = True
def __str__(self) -> str:
return "#"
def __eq__(self, other: object) -> bool:
return isinstance(other, CurrentKey)
def evaluate(self, context: FilterContext) -> object:
if context.current_key is None:
return UNDEFINED
return context.current_key
async def evaluate_async(self, context: FilterContext) -> object:
return self.evaluate(context)
def children(self) -> List[BaseExpression]:
return []
def set_children(self, children: List[BaseExpression]) -> None: # noqa: ARG002
return
CURRENT_KEY = CurrentKey()
def walk(expr: BaseExpression) -> Iterable[BaseExpression]:
"""Walk the filter expression tree starting at _expr_."""
yield expr
for child in expr.children():
yield from walk(child)
VALUE_TYPE_EXPRESSIONS = (
Nil,
Undefined,
FilterExpressionLiteral,
ListLiteral,
CurrentKey,
)
|