comparison_ops.py

# Copyright 2025 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

from __future__ import annotations

import typing

import bigframes_vendored.sqlglot as sg
import bigframes_vendored.sqlglot.expressions as sge
import pandas as pd

from bigframes import dtypes
from bigframes import operations as ops
from bigframes.core.compile.sqlglot import sql
import bigframes.core.compile.sqlglot.expression_compiler as expression_compiler
from bigframes.core.compile.sqlglot.expressions.typed_expr import TypedExpr

register_unary_op = expression_compiler.expression_compiler.register_unary_op
register_binary_op = expression_compiler.expression_compiler.register_binary_op


@register_unary_op(ops.IsInOp, pass_op=True)
def _(expr: TypedExpr, op: ops.IsInOp) -> sge.Expression:
    values = []
    # bools are not comparable to non-bools in SQL, so we need to cast the expression to INT64 if the values contain non-bools.
    must_upcast_bools = dtypes.is_numeric(expr.dtype, include_bool=False) or any(
        dtypes.is_numeric(dtypes.bigframes_type(type(value)), include_bool=False)
        for value in op.values
        if not _is_null(value)
    )
    for value in op.values:
        if _is_null(value):
            continue
        dtype = dtypes.bigframes_type(type(value))
        if dtypes.can_compare(expr.dtype, dtype):
            if must_upcast_bools and dtype == dtypes.BOOL_DTYPE:
                value = int(value)
            values.append(sge.convert(value))

    sg_lexpr: sge.Expression = expr.expr
    if expr.dtype == dtypes.BOOL_DTYPE and must_upcast_bools:
        sg_lexpr = sge.cast(expr.expr, "INT64")

    if op.match_nulls:
        contains_nulls = any(_is_null(value) for value in op.values)
        if contains_nulls:
            if len(values) == 0:
                return sge.Is(this=sg_lexpr, expression=sge.Null())
            return sge.Is(this=sg_lexpr, expression=sge.Null()) | sge.In(
                this=sg_lexpr, expressions=values
            )

    if len(values) == 0:
        return sge.convert(False)

    return sge.func(
        "COALESCE", sge.In(this=sg_lexpr, expressions=values), sge.convert(False)
    )


@register_binary_op(ops.eq_op)
def _(left: TypedExpr, right: TypedExpr) -> sge.Expression:
    if sql.is_null_literal(left.expr):
        return sge.Is(this=right.expr, expression=sge.Null())
    if sql.is_null_literal(right.expr):
        return sge.Is(this=left.expr, expression=sge.Null())
    left_expr = _coerce_bool_to_int(left)
    right_expr = _coerce_bool_to_int(right)
    return sge.EQ(this=left_expr, expression=right_expr)


@register_binary_op(ops.eq_null_match_op)
def _(left: TypedExpr, right: TypedExpr) -> sge.Expression:
    left_expr = left.expr
    if right.dtype != dtypes.BOOL_DTYPE:
        left_expr = _coerce_bool_to_int(left)

    right_expr = right.expr
    if left.dtype != dtypes.BOOL_DTYPE:
        right_expr = _coerce_bool_to_int(right)

    sentinel = sge.convert("$NULL_SENTINEL$")
    left_coalesce = sge.Coalesce(
        this=sge.Cast(this=left_expr, to="STRING"), expressions=[sentinel]
    )
    right_coalesce = sge.Coalesce(
        this=sge.Cast(this=right_expr, to="STRING"), expressions=[sentinel]
    )
    return sge.EQ(this=left_coalesce, expression=right_coalesce)


@register_binary_op(ops.ge_op)
def _(left: TypedExpr, right: TypedExpr) -> sge.Expression:
    if left.expr == sge.null() or right.expr == sge.null():
        return sge.null()

    left_expr = _coerce_bool_to_int(left)
    right_expr = _coerce_bool_to_int(right)
    return sge.GTE(this=left_expr, expression=right_expr)


@register_binary_op(ops.gt_op)
def _(left: TypedExpr, right: TypedExpr) -> sge.Expression:
    if left.expr == sge.null() or right.expr == sge.null():
        return sge.null()

    left_expr = _coerce_bool_to_int(left)
    right_expr = _coerce_bool_to_int(right)
    return sge.GT(this=left_expr, expression=right_expr)


@register_binary_op(ops.lt_op)
def _(left: TypedExpr, right: TypedExpr) -> sge.Expression:
    if left.expr == sge.null() or right.expr == sge.null():
        return sge.null()

    left_expr = _coerce_bool_to_int(left)
    right_expr = _coerce_bool_to_int(right)
    return sge.LT(this=left_expr, expression=right_expr)


@register_binary_op(ops.le_op)
def _(left: TypedExpr, right: TypedExpr) -> sge.Expression:
    if left.expr == sge.null() or right.expr == sge.null():
        return sge.null()

    left_expr = _coerce_bool_to_int(left)
    right_expr = _coerce_bool_to_int(right)
    return sge.LTE(this=left_expr, expression=right_expr)


@register_binary_op(ops.maximum_op)
def _(left: TypedExpr, right: TypedExpr) -> sge.Expression:
    return sge.Greatest(expressions=[left.expr, right.expr])


@register_binary_op(ops.minimum_op)
def _(left: TypedExpr, right: TypedExpr) -> sge.Expression:
    return sge.Least(this=left.expr, expressions=right.expr)


@register_binary_op(ops.ne_op)
def _(left: TypedExpr, right: TypedExpr) -> sge.Expression:
    if sql.is_null_literal(left.expr):
        return sge.Is(
            this=sge.paren(right.expr, copy=False),
            expression=sg.not_(sge.Null(), copy=False),
        )
    if sql.is_null_literal(right.expr):
        return sge.Is(
            this=sge.paren(left.expr, copy=False),
            expression=sg.not_(sge.Null(), copy=False),
        )

    left_expr = _coerce_bool_to_int(left)
    right_expr = _coerce_bool_to_int(right)
    return sge.NEQ(this=left_expr, expression=right_expr)


# Helpers
def _is_null(value) -> bool:
    # float NaN/inf should be treated as distinct from 'true' null values
    return typing.cast(bool, pd.isna(value)) and not isinstance(value, float)


def _coerce_bool_to_int(typed_expr: TypedExpr) -> sge.Expression:
    """Coerce boolean expression to integer."""
    if typed_expr.dtype == dtypes.BOOL_DTYPE:
        return sge.Cast(this=typed_expr.expr, to="INT64")
    return typed_expr.expr