query.py

"""Query Extension."""

import warnings
from enum import auto
from types import DynamicClassAttribute
from typing import Any, Callable

from stac_pydantic.utils import AutoValueEnum

# TODO: These are defined in the spec but aren't currently implemented by the operator syntax
UNSUPPORTED_OPERATORS = {"startsWith", "endsWith", "contains", "in"}

_OPERATIONS = {
    "eq": lambda x, y: x == y,
    "ne": lambda x, y: x != y,  # deprecated
    "neq": lambda x, y: x != y,
    "lt": lambda x, y: x < y,
    "le": lambda x, y: x <= y,  # deprecated
    "lte": lambda x, y: x <= y,
    "gt": lambda x, y: x > y,
    "ge": lambda x, y: x >= y,  # deprecated
    "gte": lambda x, y: x >= y,
    "startsWith": lambda x, y: x.startsWith(y),
    "endsWith": lambda x, y: x.endsWith(y),
    "contains": lambda x, y: y in x,
}


class Operator(str, AutoValueEnum):
    """
    https://github.com/radiantearth/stac-api-spec/tree/master/extensions/query#query-api-extension
    """

    eq = auto()
    ne = auto()  # deprecated
    neq = auto()
    lt = auto()
    le = auto()  # deprecated
    lte = auto()
    gt = auto()
    ge = auto()  # deprecated
    gte = auto()
    startsWith = auto()
    endsWith = auto()
    contains = auto()

    @DynamicClassAttribute
    def operator(self) -> Callable[[Any, Any], bool]:
        """Return python operator"""
        if self._value_ in ["ne", "ge", "le"]:
            newvalue = self._value_.replace("e", "te")
            warnings.warn(
                f"`{self._value_}` is deprecated, please use `{newvalue}`",
                DeprecationWarning,
                stacklevel=3,
            )

        return _OPERATIONS[self._value_]