expressions

AlwaysFalse

Bases: BooleanExpression, Singleton

FALSE expression.

Source code in pyiceberg/expressions/__init__.py

class AlwaysFalse(BooleanExpression, Singleton):
    """FALSE expression."""

    def __invert__(self) -> AlwaysTrue:
        """Transform the Expression into its negated version."""
        return AlwaysTrue()

    def __str__(self) -> str:
        """Return the string representation of the AlwaysFalse class."""
        return "AlwaysFalse()"

    def __repr__(self) -> str:
        """Return the string representation of the AlwaysFalse class."""
        return "AlwaysFalse()"

__invert__()

Transform the Expression into its negated version.

Source code in pyiceberg/expressions/__init__.py

def __invert__(self) -> AlwaysTrue:
    """Transform the Expression into its negated version."""
    return AlwaysTrue()

__repr__()

Return the string representation of the AlwaysFalse class.

Source code in pyiceberg/expressions/__init__.py

def __repr__(self) -> str:
    """Return the string representation of the AlwaysFalse class."""
    return "AlwaysFalse()"

__str__()

Return the string representation of the AlwaysFalse class.

Source code in pyiceberg/expressions/__init__.py

def __str__(self) -> str:
    """Return the string representation of the AlwaysFalse class."""
    return "AlwaysFalse()"

AlwaysTrue

Bases: BooleanExpression, Singleton

TRUE expression.

Source code in pyiceberg/expressions/__init__.py

class AlwaysTrue(BooleanExpression, Singleton):
    """TRUE expression."""

    def __invert__(self) -> AlwaysFalse:
        """Transform the Expression into its negated version."""
        return AlwaysFalse()

    def __str__(self) -> str:
        """Return the string representation of the AlwaysTrue class."""
        return "AlwaysTrue()"

    def __repr__(self) -> str:
        """Return the string representation of the AlwaysTrue class."""
        return "AlwaysTrue()"

__invert__()

Transform the Expression into its negated version.

Source code in pyiceberg/expressions/__init__.py

def __invert__(self) -> AlwaysFalse:
    """Transform the Expression into its negated version."""
    return AlwaysFalse()

__repr__()

Return the string representation of the AlwaysTrue class.

Source code in pyiceberg/expressions/__init__.py

def __repr__(self) -> str:
    """Return the string representation of the AlwaysTrue class."""
    return "AlwaysTrue()"

__str__()

Return the string representation of the AlwaysTrue class.

Source code in pyiceberg/expressions/__init__.py

def __str__(self) -> str:
    """Return the string representation of the AlwaysTrue class."""
    return "AlwaysTrue()"

And

Bases: BooleanExpression

AND operation expression - logical conjunction.

Source code in pyiceberg/expressions/__init__.py

class And(BooleanExpression):
    """AND operation expression - logical conjunction."""

    left: BooleanExpression
    right: BooleanExpression

    def __new__(cls, left: BooleanExpression, right: BooleanExpression, *rest: BooleanExpression) -> BooleanExpression:  # type: ignore
        if rest:
            return reduce(And, (left, right, *rest))
        if left is AlwaysFalse() or right is AlwaysFalse():
            return AlwaysFalse()
        elif left is AlwaysTrue():
            return right
        elif right is AlwaysTrue():
            return left
        else:
            obj = super().__new__(cls)
            obj.left = left
            obj.right = right
            return obj

    def __eq__(self, other: Any) -> bool:
        """Return the equality of two instances of the And class."""
        return self.left == other.left and self.right == other.right if isinstance(other, And) else False

    def __str__(self) -> str:
        """Return the string representation of the And class."""
        return f"And(left={str(self.left)}, right={str(self.right)})"

    def __repr__(self) -> str:
        """Return the string representation of the And class."""
        return f"And(left={repr(self.left)}, right={repr(self.right)})"

    def __invert__(self) -> BooleanExpression:
        """Transform the Expression into its negated version."""
        # De Morgan's law: not (A and B) = (not A) or (not B)
        return Or(~self.left, ~self.right)

    def __getnewargs__(self) -> Tuple[BooleanExpression, BooleanExpression]:
        """Pickle the And class."""
        return (self.left, self.right)

__eq__(other)

Return the equality of two instances of the And class.

Source code in pyiceberg/expressions/__init__.py

def __eq__(self, other: Any) -> bool:
    """Return the equality of two instances of the And class."""
    return self.left == other.left and self.right == other.right if isinstance(other, And) else False

__getnewargs__()

Pickle the And class.

Source code in pyiceberg/expressions/__init__.py

def __getnewargs__(self) -> Tuple[BooleanExpression, BooleanExpression]:
    """Pickle the And class."""
    return (self.left, self.right)

__invert__()

Transform the Expression into its negated version.

Source code in pyiceberg/expressions/__init__.py

def __invert__(self) -> BooleanExpression:
    """Transform the Expression into its negated version."""
    # De Morgan's law: not (A and B) = (not A) or (not B)
    return Or(~self.left, ~self.right)

__repr__()

Return the string representation of the And class.

Source code in pyiceberg/expressions/__init__.py

def __repr__(self) -> str:
    """Return the string representation of the And class."""
    return f"And(left={repr(self.left)}, right={repr(self.right)})"

__str__()

Return the string representation of the And class.

Source code in pyiceberg/expressions/__init__.py

def __str__(self) -> str:
    """Return the string representation of the And class."""
    return f"And(left={str(self.left)}, right={str(self.right)})"

BooleanExpression

Bases: ABC

An expression that evaluates to a boolean.

Source code in pyiceberg/expressions/__init__.py

class BooleanExpression(ABC):
    """An expression that evaluates to a boolean."""

    @abstractmethod
    def __invert__(self) -> BooleanExpression:
        """Transform the Expression into its negated version."""

__invert__() abstractmethod

Transform the Expression into its negated version.

Source code in pyiceberg/expressions/__init__.py

@abstractmethod
def __invert__(self) -> BooleanExpression:
    """Transform the Expression into its negated version."""

Bound

Bases: ABC

Represents a bound value expression.

Source code in pyiceberg/expressions/__init__.py

class Bound(ABC):
    """Represents a bound value expression."""

BoundEqualTo

Bases: BoundLiteralPredicate[L]

Source code in pyiceberg/expressions/__init__.py

class BoundEqualTo(BoundLiteralPredicate[L]):
    def __invert__(self) -> BoundNotEqualTo[L]:
        """Transform the Expression into its negated version."""
        return BoundNotEqualTo[L](self.term, self.literal)

    @property
    def as_unbound(self) -> Type[EqualTo[L]]:
        return EqualTo

__invert__()

Transform the Expression into its negated version.

Source code in pyiceberg/expressions/__init__.py

def __invert__(self) -> BoundNotEqualTo[L]:
    """Transform the Expression into its negated version."""
    return BoundNotEqualTo[L](self.term, self.literal)

BoundGreaterThan

Bases: BoundLiteralPredicate[L]

Source code in pyiceberg/expressions/__init__.py

class BoundGreaterThan(BoundLiteralPredicate[L]):
    def __invert__(self) -> BoundLessThanOrEqual[L]:
        """Transform the Expression into its negated version."""
        return BoundLessThanOrEqual(self.term, self.literal)

    @property
    def as_unbound(self) -> Type[GreaterThan[L]]:
        return GreaterThan[L]

__invert__()

Transform the Expression into its negated version.

Source code in pyiceberg/expressions/__init__.py

def __invert__(self) -> BoundLessThanOrEqual[L]:
    """Transform the Expression into its negated version."""
    return BoundLessThanOrEqual(self.term, self.literal)

BoundGreaterThanOrEqual

Bases: BoundLiteralPredicate[L]

Source code in pyiceberg/expressions/__init__.py

class BoundGreaterThanOrEqual(BoundLiteralPredicate[L]):
    def __invert__(self) -> BoundLessThan[L]:
        """Transform the Expression into its negated version."""
        return BoundLessThan[L](self.term, self.literal)

    @property
    def as_unbound(self) -> Type[GreaterThanOrEqual[L]]:
        return GreaterThanOrEqual[L]

__invert__()

Transform the Expression into its negated version.

Source code in pyiceberg/expressions/__init__.py

def __invert__(self) -> BoundLessThan[L]:
    """Transform the Expression into its negated version."""
    return BoundLessThan[L](self.term, self.literal)

BoundIn

Bases: BoundSetPredicate[L]

Source code in pyiceberg/expressions/__init__.py

class BoundIn(BoundSetPredicate[L]):
    def __new__(cls, term: BoundTerm[L], literals: Set[Literal[L]]) -> BooleanExpression:  # type: ignore  # pylint: disable=W0221
        count = len(literals)
        if count == 0:
            return AlwaysFalse()
        elif count == 1:
            return BoundEqualTo(term, next(iter(literals)))
        else:
            return super().__new__(cls)

    def __invert__(self) -> BoundNotIn[L]:
        """Transform the Expression into its negated version."""
        return BoundNotIn(self.term, self.literals)

    def __eq__(self, other: Any) -> bool:
        """Return the equality of two instances of the BoundIn class."""
        return self.term == other.term and self.literals == other.literals if isinstance(other, self.__class__) else False

    @property
    def as_unbound(self) -> Type[In[L]]:
        return In

__eq__(other)

Return the equality of two instances of the BoundIn class.

Source code in pyiceberg/expressions/__init__.py

def __eq__(self, other: Any) -> bool:
    """Return the equality of two instances of the BoundIn class."""
    return self.term == other.term and self.literals == other.literals if isinstance(other, self.__class__) else False

__invert__()

Transform the Expression into its negated version.

Source code in pyiceberg/expressions/__init__.py

def __invert__(self) -> BoundNotIn[L]:
    """Transform the Expression into its negated version."""
    return BoundNotIn(self.term, self.literals)

BoundIsNaN

Bases: BoundUnaryPredicate[L]

Source code in pyiceberg/expressions/__init__.py

class BoundIsNaN(BoundUnaryPredicate[L]):
    def __new__(cls, term: BoundTerm[L]) -> BooleanExpression:  # type: ignore  # pylint: disable=W0221
        bound_type = term.ref().field.field_type
        if isinstance(bound_type, (FloatType, DoubleType)):
            return super().__new__(cls)
        return AlwaysFalse()

    def __invert__(self) -> BoundNotNaN[L]:
        """Transform the Expression into its negated version."""
        return BoundNotNaN(self.term)

    @property
    def as_unbound(self) -> Type[IsNaN]:
        return IsNaN

__invert__()

Transform the Expression into its negated version.

Source code in pyiceberg/expressions/__init__.py

def __invert__(self) -> BoundNotNaN[L]:
    """Transform the Expression into its negated version."""
    return BoundNotNaN(self.term)

BoundIsNull

Bases: BoundUnaryPredicate[L]

Source code in pyiceberg/expressions/__init__.py

class BoundIsNull(BoundUnaryPredicate[L]):
    def __new__(cls, term: BoundTerm[L]) -> BooleanExpression:  # type: ignore  # pylint: disable=W0221
        if term.ref().field.required:
            return AlwaysFalse()
        return super().__new__(cls)

    def __invert__(self) -> BoundNotNull[L]:
        """Transform the Expression into its negated version."""
        return BoundNotNull(self.term)

    @property
    def as_unbound(self) -> Type[IsNull]:
        return IsNull

__invert__()

Transform the Expression into its negated version.

Source code in pyiceberg/expressions/__init__.py

def __invert__(self) -> BoundNotNull[L]:
    """Transform the Expression into its negated version."""
    return BoundNotNull(self.term)

BoundLessThan

Bases: BoundLiteralPredicate[L]

Source code in pyiceberg/expressions/__init__.py

class BoundLessThan(BoundLiteralPredicate[L]):
    def __invert__(self) -> BoundGreaterThanOrEqual[L]:
        """Transform the Expression into its negated version."""
        return BoundGreaterThanOrEqual[L](self.term, self.literal)

    @property
    def as_unbound(self) -> Type[LessThan[L]]:
        return LessThan[L]

__invert__()

Transform the Expression into its negated version.

Source code in pyiceberg/expressions/__init__.py

def __invert__(self) -> BoundGreaterThanOrEqual[L]:
    """Transform the Expression into its negated version."""
    return BoundGreaterThanOrEqual[L](self.term, self.literal)

BoundLessThanOrEqual

Bases: BoundLiteralPredicate[L]

Source code in pyiceberg/expressions/__init__.py

class BoundLessThanOrEqual(BoundLiteralPredicate[L]):
    def __invert__(self) -> BoundGreaterThan[L]:
        """Transform the Expression into its negated version."""
        return BoundGreaterThan[L](self.term, self.literal)

    @property
    def as_unbound(self) -> Type[LessThanOrEqual[L]]:
        return LessThanOrEqual[L]

__invert__()

Transform the Expression into its negated version.

Source code in pyiceberg/expressions/__init__.py

def __invert__(self) -> BoundGreaterThan[L]:
    """Transform the Expression into its negated version."""
    return BoundGreaterThan[L](self.term, self.literal)

BoundLiteralPredicate

Bases: BoundPredicate[L], ABC

Source code in pyiceberg/expressions/__init__.py

class BoundLiteralPredicate(BoundPredicate[L], ABC):
    literal: Literal[L]

    def __init__(self, term: BoundTerm[L], literal: Literal[L]):  # pylint: disable=W0621
        # Since we don't know the type of BoundPredicate[L], we have to ignore this one
        super().__init__(term)  # type: ignore
        self.literal = literal  # pylint: disable=W0621

    def __eq__(self, other: Any) -> bool:
        """Return the equality of two instances of the BoundLiteralPredicate class."""
        if isinstance(other, self.__class__):
            return self.term == other.term and self.literal == other.literal
        return False

    def __repr__(self) -> str:
        """Return the string representation of the BoundLiteralPredicate class."""
        return f"{str(self.__class__.__name__)}(term={repr(self.term)}, literal={repr(self.literal)})"

    @property
    @abstractmethod
    def as_unbound(self) -> Type[LiteralPredicate[L]]: ...

__eq__(other)

Return the equality of two instances of the BoundLiteralPredicate class.

Source code in pyiceberg/expressions/__init__.py

def __eq__(self, other: Any) -> bool:
    """Return the equality of two instances of the BoundLiteralPredicate class."""
    if isinstance(other, self.__class__):
        return self.term == other.term and self.literal == other.literal
    return False

__repr__()

Return the string representation of the BoundLiteralPredicate class.

Source code in pyiceberg/expressions/__init__.py

def __repr__(self) -> str:
    """Return the string representation of the BoundLiteralPredicate class."""
    return f"{str(self.__class__.__name__)}(term={repr(self.term)}, literal={repr(self.literal)})"

BoundNotEqualTo

Bases: BoundLiteralPredicate[L]

Source code in pyiceberg/expressions/__init__.py

class BoundNotEqualTo(BoundLiteralPredicate[L]):
    def __invert__(self) -> BoundEqualTo[L]:
        """Transform the Expression into its negated version."""
        return BoundEqualTo[L](self.term, self.literal)

    @property
    def as_unbound(self) -> Type[NotEqualTo[L]]:
        return NotEqualTo

__invert__()

Transform the Expression into its negated version.

Source code in pyiceberg/expressions/__init__.py

def __invert__(self) -> BoundEqualTo[L]:
    """Transform the Expression into its negated version."""
    return BoundEqualTo[L](self.term, self.literal)

BoundNotIn

Bases: BoundSetPredicate[L]

Source code in pyiceberg/expressions/__init__.py

class BoundNotIn(BoundSetPredicate[L]):
    def __new__(  # type: ignore  # pylint: disable=W0221
        cls,
        term: BoundTerm[L],
        literals: Set[Literal[L]],
    ) -> BooleanExpression:
        count = len(literals)
        if count == 0:
            return AlwaysTrue()
        elif count == 1:
            return BoundNotEqualTo(term, next(iter(literals)))
        else:
            return super().__new__(cls)

    def __invert__(self) -> BoundIn[L]:
        """Transform the Expression into its negated version."""
        return BoundIn(self.term, self.literals)

    @property
    def as_unbound(self) -> Type[NotIn[L]]:
        return NotIn

__invert__()

Transform the Expression into its negated version.

Source code in pyiceberg/expressions/__init__.py

def __invert__(self) -> BoundIn[L]:
    """Transform the Expression into its negated version."""
    return BoundIn(self.term, self.literals)

BoundNotNaN

Bases: BoundUnaryPredicate[L]

Source code in pyiceberg/expressions/__init__.py

class BoundNotNaN(BoundUnaryPredicate[L]):
    def __new__(cls, term: BoundTerm[L]) -> BooleanExpression:  # type: ignore  # pylint: disable=W0221
        bound_type = term.ref().field.field_type
        if isinstance(bound_type, (FloatType, DoubleType)):
            return super().__new__(cls)
        return AlwaysTrue()

    def __invert__(self) -> BoundIsNaN[L]:
        """Transform the Expression into its negated version."""
        return BoundIsNaN(self.term)

    @property
    def as_unbound(self) -> Type[NotNaN]:
        return NotNaN

__invert__()

Transform the Expression into its negated version.

Source code in pyiceberg/expressions/__init__.py

def __invert__(self) -> BoundIsNaN[L]:
    """Transform the Expression into its negated version."""
    return BoundIsNaN(self.term)

BoundNotNull

Bases: BoundUnaryPredicate[L]

Source code in pyiceberg/expressions/__init__.py

class BoundNotNull(BoundUnaryPredicate[L]):
    def __new__(cls, term: BoundTerm[L]):  # type: ignore  # pylint: disable=W0221
        if term.ref().field.required:
            return AlwaysTrue()
        return super().__new__(cls)

    def __invert__(self) -> BoundIsNull[L]:
        """Transform the Expression into its negated version."""
        return BoundIsNull(self.term)

    @property
    def as_unbound(self) -> Type[NotNull]:
        return NotNull

__invert__()

Transform the Expression into its negated version.

Source code in pyiceberg/expressions/__init__.py

def __invert__(self) -> BoundIsNull[L]:
    """Transform the Expression into its negated version."""
    return BoundIsNull(self.term)

BoundNotStartsWith

Bases: BoundLiteralPredicate[L]

Source code in pyiceberg/expressions/__init__.py

class BoundNotStartsWith(BoundLiteralPredicate[L]):
    def __invert__(self) -> BoundStartsWith[L]:
        """Transform the Expression into its negated version."""
        return BoundStartsWith[L](self.term, self.literal)

    @property
    def as_unbound(self) -> Type[NotStartsWith[L]]:
        return NotStartsWith[L]

__invert__()

Transform the Expression into its negated version.

Source code in pyiceberg/expressions/__init__.py

def __invert__(self) -> BoundStartsWith[L]:
    """Transform the Expression into its negated version."""
    return BoundStartsWith[L](self.term, self.literal)

BoundPredicate

Bases: Generic[L], Bound, BooleanExpression, ABC

Source code in pyiceberg/expressions/__init__.py

class BoundPredicate(Generic[L], Bound, BooleanExpression, ABC):
    term: BoundTerm[L]

    def __init__(self, term: BoundTerm[L]):
        self.term = term

    def __eq__(self, other: Any) -> bool:
        """Return the equality of two instances of the BoundPredicate class."""
        if isinstance(other, self.__class__):
            return self.term == other.term
        return False

    @property
    @abstractmethod
    def as_unbound(self) -> Type[UnboundPredicate[Any]]: ...

__eq__(other)

Return the equality of two instances of the BoundPredicate class.

Source code in pyiceberg/expressions/__init__.py

def __eq__(self, other: Any) -> bool:
    """Return the equality of two instances of the BoundPredicate class."""
    if isinstance(other, self.__class__):
        return self.term == other.term
    return False

BoundReference

Bases: BoundTerm[L]

A reference bound to a field in a schema.

Parameters:

Name	Type	Description	Default
field	NestedField	A referenced field in an Iceberg schema.	required
accessor	Accessor	An Accessor object to access the value at the field's position.	required

Source code in pyiceberg/expressions/__init__.py

class BoundReference(BoundTerm[L]):
    """A reference bound to a field in a schema.

    Args:
        field (NestedField): A referenced field in an Iceberg schema.
        accessor (Accessor): An Accessor object to access the value at the field's position.
    """

    field: NestedField
    accessor: Accessor

    def __init__(self, field: NestedField, accessor: Accessor):
        self.field = field
        self.accessor = accessor

    def eval(self, struct: StructProtocol) -> L:
        """Return the value at the referenced field's position in an object that abides by the StructProtocol.

        Args:
            struct (StructProtocol): A row object that abides by the StructProtocol and returns values given a position.
        Returns:
            Any: The value at the referenced field's position in `struct`.
        """
        return self.accessor.get(struct)

    def __eq__(self, other: Any) -> bool:
        """Return the equality of two instances of the BoundReference class."""
        return self.field == other.field if isinstance(other, BoundReference) else False

    def __repr__(self) -> str:
        """Return the string representation of the BoundReference class."""
        return f"BoundReference(field={repr(self.field)}, accessor={repr(self.accessor)})"

    def ref(self) -> BoundReference[L]:
        return self

__eq__(other)

Return the equality of two instances of the BoundReference class.

Source code in pyiceberg/expressions/__init__.py

def __eq__(self, other: Any) -> bool:
    """Return the equality of two instances of the BoundReference class."""
    return self.field == other.field if isinstance(other, BoundReference) else False

__repr__()

Return the string representation of the BoundReference class.

Source code in pyiceberg/expressions/__init__.py

def __repr__(self) -> str:
    """Return the string representation of the BoundReference class."""
    return f"BoundReference(field={repr(self.field)}, accessor={repr(self.accessor)})"

eval(struct)

Return the value at the referenced field's position in an object that abides by the StructProtocol.

Parameters:

Name	Type	Description	Default
struct	StructProtocol	A row object that abides by the StructProtocol and returns values given a position.	required

Returns: Any: The value at the referenced field's position in struct.

Source code in pyiceberg/expressions/__init__.py

def eval(self, struct: StructProtocol) -> L:
    """Return the value at the referenced field's position in an object that abides by the StructProtocol.

    Args:
        struct (StructProtocol): A row object that abides by the StructProtocol and returns values given a position.
    Returns:
        Any: The value at the referenced field's position in `struct`.
    """
    return self.accessor.get(struct)

BoundSetPredicate

Bases: BoundPredicate[L], ABC

Source code in pyiceberg/expressions/__init__.py

class BoundSetPredicate(BoundPredicate[L], ABC):
    literals: Set[Literal[L]]

    def __init__(self, term: BoundTerm[L], literals: Set[Literal[L]]):
        # Since we don't know the type of BoundPredicate[L], we have to ignore this one
        super().__init__(term)  # type: ignore
        self.literals = _to_literal_set(literals)  # pylint: disable=W0621

    @cached_property
    def value_set(self) -> Set[L]:
        return {lit.value for lit in self.literals}

    def __str__(self) -> str:
        """Return the string representation of the BoundSetPredicate class."""
        # Sort to make it deterministic
        return f"{str(self.__class__.__name__)}({str(self.term)}, {{{', '.join(sorted([str(literal) for literal in self.literals]))}}})"

    def __repr__(self) -> str:
        """Return the string representation of the BoundSetPredicate class."""
        # Sort to make it deterministic
        return f"{str(self.__class__.__name__)}({repr(self.term)}, {{{', '.join(sorted([repr(literal) for literal in self.literals]))}}})"

    def __eq__(self, other: Any) -> bool:
        """Return the equality of two instances of the BoundSetPredicate class."""
        return self.term == other.term and self.literals == other.literals if isinstance(other, self.__class__) else False

    def __getnewargs__(self) -> Tuple[BoundTerm[L], Set[Literal[L]]]:
        """Pickle the BoundSetPredicate class."""
        return (self.term, self.literals)

    @property
    @abstractmethod
    def as_unbound(self) -> Type[SetPredicate[L]]: ...

__eq__(other)

Return the equality of two instances of the BoundSetPredicate class.

Source code in pyiceberg/expressions/__init__.py

def __eq__(self, other: Any) -> bool:
    """Return the equality of two instances of the BoundSetPredicate class."""
    return self.term == other.term and self.literals == other.literals if isinstance(other, self.__class__) else False

__getnewargs__()

Pickle the BoundSetPredicate class.

Source code in pyiceberg/expressions/__init__.py

def __getnewargs__(self) -> Tuple[BoundTerm[L], Set[Literal[L]]]:
    """Pickle the BoundSetPredicate class."""
    return (self.term, self.literals)

__repr__()

Return the string representation of the BoundSetPredicate class.

Source code in pyiceberg/expressions/__init__.py

def __repr__(self) -> str:
    """Return the string representation of the BoundSetPredicate class."""
    # Sort to make it deterministic
    return f"{str(self.__class__.__name__)}({repr(self.term)}, {{{', '.join(sorted([repr(literal) for literal in self.literals]))}}})"

__str__()

Return the string representation of the BoundSetPredicate class.

Source code in pyiceberg/expressions/__init__.py

def __str__(self) -> str:
    """Return the string representation of the BoundSetPredicate class."""
    # Sort to make it deterministic
    return f"{str(self.__class__.__name__)}({str(self.term)}, {{{', '.join(sorted([str(literal) for literal in self.literals]))}}})"

BoundStartsWith

Bases: BoundLiteralPredicate[L]

Source code in pyiceberg/expressions/__init__.py

class BoundStartsWith(BoundLiteralPredicate[L]):
    def __invert__(self) -> BoundNotStartsWith[L]:
        """Transform the Expression into its negated version."""
        return BoundNotStartsWith[L](self.term, self.literal)

    @property
    def as_unbound(self) -> Type[StartsWith[L]]:
        return StartsWith[L]

__invert__()

Transform the Expression into its negated version.

Source code in pyiceberg/expressions/__init__.py

def __invert__(self) -> BoundNotStartsWith[L]:
    """Transform the Expression into its negated version."""
    return BoundNotStartsWith[L](self.term, self.literal)

BoundTerm

Bases: Term[L], Bound, ABC

Represents a bound term.

Source code in pyiceberg/expressions/__init__.py

class BoundTerm(Term[L], Bound, ABC):
    """Represents a bound term."""

    @abstractmethod
    def ref(self) -> BoundReference[L]:
        """Return the bound reference."""

    @abstractmethod
    def eval(self, struct: StructProtocol) -> L:  # pylint: disable=W0613
        """Return the value at the referenced field's position in an object that abides by the StructProtocol."""

eval(struct) abstractmethod

Return the value at the referenced field's position in an object that abides by the StructProtocol.

Source code in pyiceberg/expressions/__init__.py

@abstractmethod
def eval(self, struct: StructProtocol) -> L:  # pylint: disable=W0613
    """Return the value at the referenced field's position in an object that abides by the StructProtocol."""

ref() abstractmethod

Return the bound reference.

Source code in pyiceberg/expressions/__init__.py

@abstractmethod
def ref(self) -> BoundReference[L]:
    """Return the bound reference."""

BoundUnaryPredicate

Bases: BoundPredicate[L], ABC

Source code in pyiceberg/expressions/__init__.py

class BoundUnaryPredicate(BoundPredicate[L], ABC):
    def __repr__(self) -> str:
        """Return the string representation of the BoundUnaryPredicate class."""
        return f"{str(self.__class__.__name__)}(term={repr(self.term)})"

    @property
    @abstractmethod
    def as_unbound(self) -> Type[UnaryPredicate]: ...

    def __getnewargs__(self) -> Tuple[BoundTerm[L]]:
        """Pickle the BoundUnaryPredicate class."""
        return (self.term,)

__getnewargs__()

Pickle the BoundUnaryPredicate class.

Source code in pyiceberg/expressions/__init__.py

def __getnewargs__(self) -> Tuple[BoundTerm[L]]:
    """Pickle the BoundUnaryPredicate class."""
    return (self.term,)

__repr__()

Return the string representation of the BoundUnaryPredicate class.

Source code in pyiceberg/expressions/__init__.py

def __repr__(self) -> str:
    """Return the string representation of the BoundUnaryPredicate class."""
    return f"{str(self.__class__.__name__)}(term={repr(self.term)})"

EqualTo

Bases: LiteralPredicate[L]

Source code in pyiceberg/expressions/__init__.py

class EqualTo(LiteralPredicate[L]):
    def __invert__(self) -> NotEqualTo[L]:
        """Transform the Expression into its negated version."""
        return NotEqualTo[L](self.term, self.literal)

    @property
    def as_bound(self) -> Type[BoundEqualTo[L]]:
        return BoundEqualTo[L]

__invert__()

Transform the Expression into its negated version.

Source code in pyiceberg/expressions/__init__.py

def __invert__(self) -> NotEqualTo[L]:
    """Transform the Expression into its negated version."""
    return NotEqualTo[L](self.term, self.literal)

GreaterThan

Bases: LiteralPredicate[L]

Source code in pyiceberg/expressions/__init__.py

class GreaterThan(LiteralPredicate[L]):
    def __invert__(self) -> LessThanOrEqual[L]:
        """Transform the Expression into its negated version."""
        return LessThanOrEqual[L](self.term, self.literal)

    @property
    def as_bound(self) -> Type[BoundGreaterThan[L]]:
        return BoundGreaterThan[L]

__invert__()

Transform the Expression into its negated version.

Source code in pyiceberg/expressions/__init__.py

def __invert__(self) -> LessThanOrEqual[L]:
    """Transform the Expression into its negated version."""
    return LessThanOrEqual[L](self.term, self.literal)

GreaterThanOrEqual

Bases: LiteralPredicate[L]

Source code in pyiceberg/expressions/__init__.py

class GreaterThanOrEqual(LiteralPredicate[L]):
    def __invert__(self) -> LessThan[L]:
        """Transform the Expression into its negated version."""
        return LessThan[L](self.term, self.literal)

    @property
    def as_bound(self) -> Type[BoundGreaterThanOrEqual[L]]:
        return BoundGreaterThanOrEqual[L]

__invert__()

Transform the Expression into its negated version.

Source code in pyiceberg/expressions/__init__.py

def __invert__(self) -> LessThan[L]:
    """Transform the Expression into its negated version."""
    return LessThan[L](self.term, self.literal)

In

Bases: SetPredicate[L]

Source code in pyiceberg/expressions/__init__.py

class In(SetPredicate[L]):
    def __new__(  # type: ignore  # pylint: disable=W0221
        cls, term: Union[str, UnboundTerm[Any]], literals: Union[Iterable[L], Iterable[Literal[L]]]
    ) -> BooleanExpression:
        literals_set: Set[Literal[L]] = _to_literal_set(literals)
        count = len(literals_set)
        if count == 0:
            return AlwaysFalse()
        elif count == 1:
            return EqualTo(term, next(iter(literals)))  # type: ignore
        else:
            return super().__new__(cls)

    def __invert__(self) -> NotIn[L]:
        """Transform the Expression into its negated version."""
        return NotIn[L](self.term, self.literals)

    @property
    def as_bound(self) -> Type[BoundIn[L]]:
        return BoundIn[L]

__invert__()

Transform the Expression into its negated version.

Source code in pyiceberg/expressions/__init__.py

def __invert__(self) -> NotIn[L]:
    """Transform the Expression into its negated version."""
    return NotIn[L](self.term, self.literals)

IsNaN

Bases: UnaryPredicate

Source code in pyiceberg/expressions/__init__.py

class IsNaN(UnaryPredicate):
    def __invert__(self) -> NotNaN:
        """Transform the Expression into its negated version."""
        return NotNaN(self.term)

    @property
    def as_bound(self) -> Type[BoundIsNaN[L]]:
        return BoundIsNaN[L]

__invert__()

Transform the Expression into its negated version.

Source code in pyiceberg/expressions/__init__.py

def __invert__(self) -> NotNaN:
    """Transform the Expression into its negated version."""
    return NotNaN(self.term)

IsNull

Bases: UnaryPredicate

Source code in pyiceberg/expressions/__init__.py

class IsNull(UnaryPredicate):
    def __invert__(self) -> NotNull:
        """Transform the Expression into its negated version."""
        return NotNull(self.term)

    @property
    def as_bound(self) -> Type[BoundIsNull[L]]:
        return BoundIsNull[L]

__invert__()

Transform the Expression into its negated version.

Source code in pyiceberg/expressions/__init__.py

def __invert__(self) -> NotNull:
    """Transform the Expression into its negated version."""
    return NotNull(self.term)

LessThan

Bases: LiteralPredicate[L]

Source code in pyiceberg/expressions/__init__.py

class LessThan(LiteralPredicate[L]):
    def __invert__(self) -> GreaterThanOrEqual[L]:
        """Transform the Expression into its negated version."""
        return GreaterThanOrEqual[L](self.term, self.literal)

    @property
    def as_bound(self) -> Type[BoundLessThan[L]]:
        return BoundLessThan[L]

__invert__()

Transform the Expression into its negated version.

Source code in pyiceberg/expressions/__init__.py

def __invert__(self) -> GreaterThanOrEqual[L]:
    """Transform the Expression into its negated version."""
    return GreaterThanOrEqual[L](self.term, self.literal)

LessThanOrEqual

Bases: LiteralPredicate[L]

Source code in pyiceberg/expressions/__init__.py

class LessThanOrEqual(LiteralPredicate[L]):
    def __invert__(self) -> GreaterThan[L]:
        """Transform the Expression into its negated version."""
        return GreaterThan[L](self.term, self.literal)

    @property
    def as_bound(self) -> Type[BoundLessThanOrEqual[L]]:
        return BoundLessThanOrEqual[L]

__invert__()

Transform the Expression into its negated version.

Source code in pyiceberg/expressions/__init__.py

def __invert__(self) -> GreaterThan[L]:
    """Transform the Expression into its negated version."""
    return GreaterThan[L](self.term, self.literal)

LiteralPredicate

Bases: UnboundPredicate[L], ABC

Source code in pyiceberg/expressions/__init__.py

class LiteralPredicate(UnboundPredicate[L], ABC):
    literal: Literal[L]

    def __init__(self, term: Union[str, UnboundTerm[Any]], literal: Union[L, Literal[L]]):  # pylint: disable=W0621
        super().__init__(term)
        self.literal = _to_literal(literal)  # pylint: disable=W0621

    def bind(self, schema: Schema, case_sensitive: bool = True) -> BoundLiteralPredicate[L]:
        bound_term = self.term.bind(schema, case_sensitive)
        lit = self.literal.to(bound_term.ref().field.field_type)

        if isinstance(lit, AboveMax):
            if isinstance(self, (LessThan, LessThanOrEqual, NotEqualTo)):
                return AlwaysTrue()  # type: ignore
            elif isinstance(self, (GreaterThan, GreaterThanOrEqual, EqualTo)):
                return AlwaysFalse()  # type: ignore
        elif isinstance(lit, BelowMin):
            if isinstance(self, (GreaterThan, GreaterThanOrEqual, NotEqualTo)):
                return AlwaysTrue()  # type: ignore
            elif isinstance(self, (LessThan, LessThanOrEqual, EqualTo)):
                return AlwaysFalse()  # type: ignore

        return self.as_bound(bound_term, lit)

    def __eq__(self, other: Any) -> bool:
        """Return the equality of two instances of the LiteralPredicate class."""
        if isinstance(other, self.__class__):
            return self.term == other.term and self.literal == other.literal
        return False

    def __repr__(self) -> str:
        """Return the string representation of the LiteralPredicate class."""
        return f"{str(self.__class__.__name__)}(term={repr(self.term)}, literal={repr(self.literal)})"

    @property
    @abstractmethod
    def as_bound(self) -> Type[BoundLiteralPredicate[L]]: ...

__eq__(other)

Return the equality of two instances of the LiteralPredicate class.

Source code in pyiceberg/expressions/__init__.py

def __eq__(self, other: Any) -> bool:
    """Return the equality of two instances of the LiteralPredicate class."""
    if isinstance(other, self.__class__):
        return self.term == other.term and self.literal == other.literal
    return False

__repr__()

Return the string representation of the LiteralPredicate class.

Source code in pyiceberg/expressions/__init__.py

def __repr__(self) -> str:
    """Return the string representation of the LiteralPredicate class."""
    return f"{str(self.__class__.__name__)}(term={repr(self.term)}, literal={repr(self.literal)})"

Not

Bases: BooleanExpression

NOT operation expression - logical negation.

Source code in pyiceberg/expressions/__init__.py

class Not(BooleanExpression):
    """NOT operation expression - logical negation."""

    child: BooleanExpression

    def __new__(cls, child: BooleanExpression) -> BooleanExpression:  # type: ignore
        if child is AlwaysTrue():
            return AlwaysFalse()
        elif child is AlwaysFalse():
            return AlwaysTrue()
        elif isinstance(child, Not):
            return child.child
        obj = super().__new__(cls)
        obj.child = child
        return obj

    def __repr__(self) -> str:
        """Return the string representation of the Not class."""
        return f"Not(child={repr(self.child)})"

    def __eq__(self, other: Any) -> bool:
        """Return the equality of two instances of the Not class."""
        return self.child == other.child if isinstance(other, Not) else False

    def __invert__(self) -> BooleanExpression:
        """Transform the Expression into its negated version."""
        return self.child

    def __getnewargs__(self) -> Tuple[BooleanExpression]:
        """Pickle the Not class."""
        return (self.child,)

__eq__(other)

Return the equality of two instances of the Not class.

Source code in pyiceberg/expressions/__init__.py

def __eq__(self, other: Any) -> bool:
    """Return the equality of two instances of the Not class."""
    return self.child == other.child if isinstance(other, Not) else False

__getnewargs__()

Pickle the Not class.

Source code in pyiceberg/expressions/__init__.py

def __getnewargs__(self) -> Tuple[BooleanExpression]:
    """Pickle the Not class."""
    return (self.child,)

__invert__()

Transform the Expression into its negated version.

Source code in pyiceberg/expressions/__init__.py

def __invert__(self) -> BooleanExpression:
    """Transform the Expression into its negated version."""
    return self.child

__repr__()

Return the string representation of the Not class.

Source code in pyiceberg/expressions/__init__.py

def __repr__(self) -> str:
    """Return the string representation of the Not class."""
    return f"Not(child={repr(self.child)})"

NotEqualTo

Bases: LiteralPredicate[L]

Source code in pyiceberg/expressions/__init__.py

class NotEqualTo(LiteralPredicate[L]):
    def __invert__(self) -> EqualTo[L]:
        """Transform the Expression into its negated version."""
        return EqualTo[L](self.term, self.literal)

    @property
    def as_bound(self) -> Type[BoundNotEqualTo[L]]:
        return BoundNotEqualTo[L]

__invert__()

Transform the Expression into its negated version.

Source code in pyiceberg/expressions/__init__.py

def __invert__(self) -> EqualTo[L]:
    """Transform the Expression into its negated version."""
    return EqualTo[L](self.term, self.literal)

NotIn

Bases: SetPredicate[L], ABC

Source code in pyiceberg/expressions/__init__.py

class NotIn(SetPredicate[L], ABC):
    def __new__(  # type: ignore  # pylint: disable=W0221
        cls, term: Union[str, UnboundTerm[Any]], literals: Union[Iterable[L], Iterable[Literal[L]]]
    ) -> BooleanExpression:
        literals_set: Set[Literal[L]] = _to_literal_set(literals)
        count = len(literals_set)
        if count == 0:
            return AlwaysTrue()
        elif count == 1:
            return NotEqualTo(term, next(iter(literals_set)))
        else:
            return super().__new__(cls)

    def __invert__(self) -> In[L]:
        """Transform the Expression into its negated version."""
        return In[L](self.term, self.literals)

    @property
    def as_bound(self) -> Type[BoundNotIn[L]]:
        return BoundNotIn[L]

__invert__()

Transform the Expression into its negated version.

Source code in pyiceberg/expressions/__init__.py

def __invert__(self) -> In[L]:
    """Transform the Expression into its negated version."""
    return In[L](self.term, self.literals)

NotNaN

Bases: UnaryPredicate

Source code in pyiceberg/expressions/__init__.py

class NotNaN(UnaryPredicate):
    def __invert__(self) -> IsNaN:
        """Transform the Expression into its negated version."""
        return IsNaN(self.term)

    @property
    def as_bound(self) -> Type[BoundNotNaN[L]]:
        return BoundNotNaN[L]

__invert__()

Transform the Expression into its negated version.

Source code in pyiceberg/expressions/__init__.py

def __invert__(self) -> IsNaN:
    """Transform the Expression into its negated version."""
    return IsNaN(self.term)

NotNull

Bases: UnaryPredicate

Source code in pyiceberg/expressions/__init__.py

class NotNull(UnaryPredicate):
    def __invert__(self) -> IsNull:
        """Transform the Expression into its negated version."""
        return IsNull(self.term)

    @property
    def as_bound(self) -> Type[BoundNotNull[L]]:
        return BoundNotNull[L]

__invert__()

Transform the Expression into its negated version.

Source code in pyiceberg/expressions/__init__.py

def __invert__(self) -> IsNull:
    """Transform the Expression into its negated version."""
    return IsNull(self.term)

NotStartsWith

Bases: LiteralPredicate[L]

Source code in pyiceberg/expressions/__init__.py

class NotStartsWith(LiteralPredicate[L]):
    def __invert__(self) -> StartsWith[L]:
        """Transform the Expression into its negated version."""
        return StartsWith[L](self.term, self.literal)

    @property
    def as_bound(self) -> Type[BoundNotStartsWith[L]]:
        return BoundNotStartsWith[L]

__invert__()

Transform the Expression into its negated version.

Source code in pyiceberg/expressions/__init__.py

def __invert__(self) -> StartsWith[L]:
    """Transform the Expression into its negated version."""
    return StartsWith[L](self.term, self.literal)

Or

Bases: BooleanExpression

OR operation expression - logical disjunction.

Source code in pyiceberg/expressions/__init__.py

class Or(BooleanExpression):
    """OR operation expression - logical disjunction."""

    left: BooleanExpression
    right: BooleanExpression

    def __new__(cls, left: BooleanExpression, right: BooleanExpression, *rest: BooleanExpression) -> BooleanExpression:  # type: ignore
        if rest:
            return reduce(Or, (left, right, *rest))
        if left is AlwaysTrue() or right is AlwaysTrue():
            return AlwaysTrue()
        elif left is AlwaysFalse():
            return right
        elif right is AlwaysFalse():
            return left
        else:
            obj = super().__new__(cls)
            obj.left = left
            obj.right = right
            return obj

    def __eq__(self, other: Any) -> bool:
        """Return the equality of two instances of the Or class."""
        return self.left == other.left and self.right == other.right if isinstance(other, Or) else False

    def __repr__(self) -> str:
        """Return the string representation of the Or class."""
        return f"Or(left={repr(self.left)}, right={repr(self.right)})"

    def __invert__(self) -> BooleanExpression:
        """Transform the Expression into its negated version."""
        # De Morgan's law: not (A or B) = (not A) and (not B)
        return And(~self.left, ~self.right)

    def __getnewargs__(self) -> Tuple[BooleanExpression, BooleanExpression]:
        """Pickle the Or class."""
        return (self.left, self.right)

__eq__(other)

Return the equality of two instances of the Or class.

Source code in pyiceberg/expressions/__init__.py

def __eq__(self, other: Any) -> bool:
    """Return the equality of two instances of the Or class."""
    return self.left == other.left and self.right == other.right if isinstance(other, Or) else False

__getnewargs__()

Pickle the Or class.

Source code in pyiceberg/expressions/__init__.py

def __getnewargs__(self) -> Tuple[BooleanExpression, BooleanExpression]:
    """Pickle the Or class."""
    return (self.left, self.right)

__invert__()

Transform the Expression into its negated version.

Source code in pyiceberg/expressions/__init__.py

def __invert__(self) -> BooleanExpression:
    """Transform the Expression into its negated version."""
    # De Morgan's law: not (A or B) = (not A) and (not B)
    return And(~self.left, ~self.right)

__repr__()

Return the string representation of the Or class.

Source code in pyiceberg/expressions/__init__.py

def __repr__(self) -> str:
    """Return the string representation of the Or class."""
    return f"Or(left={repr(self.left)}, right={repr(self.right)})"

Reference

Bases: UnboundTerm[Any]

A reference not yet bound to a field in a schema.

Parameters:

Name	Type	Description	Default
name	str	The name of the field.	required

Note

An unbound reference is sometimes referred to as a "named" reference.

Source code in pyiceberg/expressions/__init__.py

class Reference(UnboundTerm[Any]):
    """A reference not yet bound to a field in a schema.

    Args:
        name (str): The name of the field.

    Note:
        An unbound reference is sometimes referred to as a "named" reference.
    """

    name: str

    def __init__(self, name: str) -> None:
        self.name = name

    def __repr__(self) -> str:
        """Return the string representation of the Reference class."""
        return f"Reference(name={repr(self.name)})"

    def __eq__(self, other: Any) -> bool:
        """Return the equality of two instances of the Reference class."""
        return self.name == other.name if isinstance(other, Reference) else False

    def bind(self, schema: Schema, case_sensitive: bool = True) -> BoundReference[L]:
        """Bind the reference to an Iceberg schema.

        Args:
            schema (Schema): An Iceberg schema.
            case_sensitive (bool): Whether to consider case when binding the reference to the field.

        Raises:
            ValueError: If an empty name is provided.

        Returns:
            BoundReference: A reference bound to the specific field in the Iceberg schema.
        """
        field = schema.find_field(name_or_id=self.name, case_sensitive=case_sensitive)
        accessor = schema.accessor_for_field(field.field_id)
        return self.as_bound(field=field, accessor=accessor)  # type: ignore

    @property
    def as_bound(self) -> Type[BoundReference[L]]:
        return BoundReference[L]

__eq__(other)

Return the equality of two instances of the Reference class.

Source code in pyiceberg/expressions/__init__.py

def __eq__(self, other: Any) -> bool:
    """Return the equality of two instances of the Reference class."""
    return self.name == other.name if isinstance(other, Reference) else False

__repr__()

Return the string representation of the Reference class.

Source code in pyiceberg/expressions/__init__.py

def __repr__(self) -> str:
    """Return the string representation of the Reference class."""
    return f"Reference(name={repr(self.name)})"

bind(schema, case_sensitive=True)

Bind the reference to an Iceberg schema.

Parameters:

Name	Type	Description	Default
schema	Schema	An Iceberg schema.	required
case_sensitive	bool	Whether to consider case when binding the reference to the field.	True

Raises:

Type	Description
ValueError	If an empty name is provided.

Returns:

Name	Type	Description
BoundReference	BoundReference[L]	A reference bound to the specific field in the Iceberg schema.

Source code in pyiceberg/expressions/__init__.py

def bind(self, schema: Schema, case_sensitive: bool = True) -> BoundReference[L]:
    """Bind the reference to an Iceberg schema.

    Args:
        schema (Schema): An Iceberg schema.
        case_sensitive (bool): Whether to consider case when binding the reference to the field.

    Raises:
        ValueError: If an empty name is provided.

    Returns:
        BoundReference: A reference bound to the specific field in the Iceberg schema.
    """
    field = schema.find_field(name_or_id=self.name, case_sensitive=case_sensitive)
    accessor = schema.accessor_for_field(field.field_id)
    return self.as_bound(field=field, accessor=accessor)  # type: ignore

SetPredicate

Bases: UnboundPredicate[L], ABC

Source code in pyiceberg/expressions/__init__.py

class SetPredicate(UnboundPredicate[L], ABC):
    literals: Set[Literal[L]]

    def __init__(self, term: Union[str, UnboundTerm[Any]], literals: Union[Iterable[L], Iterable[Literal[L]]]):
        super().__init__(term)
        self.literals = _to_literal_set(literals)

    def bind(self, schema: Schema, case_sensitive: bool = True) -> BoundSetPredicate[L]:
        bound_term = self.term.bind(schema, case_sensitive)
        return self.as_bound(bound_term, {lit.to(bound_term.ref().field.field_type) for lit in self.literals})

    def __str__(self) -> str:
        """Return the string representation of the SetPredicate class."""
        # Sort to make it deterministic
        return f"{str(self.__class__.__name__)}({str(self.term)}, {{{', '.join(sorted([str(literal) for literal in self.literals]))}}})"

    def __repr__(self) -> str:
        """Return the string representation of the SetPredicate class."""
        # Sort to make it deterministic
        return f"{str(self.__class__.__name__)}({repr(self.term)}, {{{', '.join(sorted([repr(literal) for literal in self.literals]))}}})"

    def __eq__(self, other: Any) -> bool:
        """Return the equality of two instances of the SetPredicate class."""
        return self.term == other.term and self.literals == other.literals if isinstance(other, self.__class__) else False

    def __getnewargs__(self) -> Tuple[UnboundTerm[L], Set[Literal[L]]]:
        """Pickle the SetPredicate class."""
        return (self.term, self.literals)

    @property
    @abstractmethod
    def as_bound(self) -> Type[BoundSetPredicate[L]]:
        return BoundSetPredicate[L]

__eq__(other)

Return the equality of two instances of the SetPredicate class.

Source code in pyiceberg/expressions/__init__.py

def __eq__(self, other: Any) -> bool:
    """Return the equality of two instances of the SetPredicate class."""
    return self.term == other.term and self.literals == other.literals if isinstance(other, self.__class__) else False

__getnewargs__()

Pickle the SetPredicate class.

Source code in pyiceberg/expressions/__init__.py

def __getnewargs__(self) -> Tuple[UnboundTerm[L], Set[Literal[L]]]:
    """Pickle the SetPredicate class."""
    return (self.term, self.literals)

__repr__()

Return the string representation of the SetPredicate class.

Source code in pyiceberg/expressions/__init__.py

def __repr__(self) -> str:
    """Return the string representation of the SetPredicate class."""
    # Sort to make it deterministic
    return f"{str(self.__class__.__name__)}({repr(self.term)}, {{{', '.join(sorted([repr(literal) for literal in self.literals]))}}})"

__str__()

Return the string representation of the SetPredicate class.

Source code in pyiceberg/expressions/__init__.py

def __str__(self) -> str:
    """Return the string representation of the SetPredicate class."""
    # Sort to make it deterministic
    return f"{str(self.__class__.__name__)}({str(self.term)}, {{{', '.join(sorted([str(literal) for literal in self.literals]))}}})"

StartsWith

Bases: LiteralPredicate[L]

Source code in pyiceberg/expressions/__init__.py

class StartsWith(LiteralPredicate[L]):
    def __invert__(self) -> NotStartsWith[L]:
        """Transform the Expression into its negated version."""
        return NotStartsWith[L](self.term, self.literal)

    @property
    def as_bound(self) -> Type[BoundStartsWith[L]]:
        return BoundStartsWith[L]

__invert__()

Transform the Expression into its negated version.

Source code in pyiceberg/expressions/__init__.py

def __invert__(self) -> NotStartsWith[L]:
    """Transform the Expression into its negated version."""
    return NotStartsWith[L](self.term, self.literal)

Term

Bases: Generic[L], ABC

A simple expression that evaluates to a value.

Source code in pyiceberg/expressions/__init__.py

class Term(Generic[L], ABC):
    """A simple expression that evaluates to a value."""

UnaryPredicate

Bases: UnboundPredicate[Any], ABC

Source code in pyiceberg/expressions/__init__.py

class UnaryPredicate(UnboundPredicate[Any], ABC):
    def bind(self, schema: Schema, case_sensitive: bool = True) -> BoundUnaryPredicate[Any]:
        bound_term = self.term.bind(schema, case_sensitive)
        return self.as_bound(bound_term)

    def __repr__(self) -> str:
        """Return the string representation of the UnaryPredicate class."""
        return f"{str(self.__class__.__name__)}(term={repr(self.term)})"

    @property
    @abstractmethod
    def as_bound(self) -> Type[BoundUnaryPredicate[Any]]: ...

__repr__()

Return the string representation of the UnaryPredicate class.

Source code in pyiceberg/expressions/__init__.py

def __repr__(self) -> str:
    """Return the string representation of the UnaryPredicate class."""
    return f"{str(self.__class__.__name__)}(term={repr(self.term)})"

Unbound

Bases: Generic[B], ABC

Represents an unbound value expression.

Source code in pyiceberg/expressions/__init__.py

class Unbound(Generic[B], ABC):
    """Represents an unbound value expression."""

    @abstractmethod
    def bind(self, schema: Schema, case_sensitive: bool = True) -> B: ...

    @property
    @abstractmethod
    def as_bound(self) -> Type[Bound]: ...

UnboundPredicate

Bases: Generic[L], Unbound[BooleanExpression], BooleanExpression, ABC

Source code in pyiceberg/expressions/__init__.py

class UnboundPredicate(Generic[L], Unbound[BooleanExpression], BooleanExpression, ABC):
    term: UnboundTerm[Any]

    def __init__(self, term: Union[str, UnboundTerm[Any]]):
        self.term = _to_unbound_term(term)

    def __eq__(self, other: Any) -> bool:
        """Return the equality of two instances of the UnboundPredicate class."""
        return self.term == other.term if isinstance(other, self.__class__) else False

    @abstractmethod
    def bind(self, schema: Schema, case_sensitive: bool = True) -> BooleanExpression: ...

    @property
    @abstractmethod
    def as_bound(self) -> Type[BoundPredicate[L]]: ...

__eq__(other)

Return the equality of two instances of the UnboundPredicate class.

Source code in pyiceberg/expressions/__init__.py

def __eq__(self, other: Any) -> bool:
    """Return the equality of two instances of the UnboundPredicate class."""
    return self.term == other.term if isinstance(other, self.__class__) else False

UnboundTerm

Bases: Term[Any], Unbound[BoundTerm[L]], ABC

Represents an unbound term.

Source code in pyiceberg/expressions/__init__.py

class UnboundTerm(Term[Any], Unbound[BoundTerm[L]], ABC):
    """Represents an unbound term."""

    @abstractmethod
    def bind(self, schema: Schema, case_sensitive: bool = True) -> BoundTerm[L]: ...