Skip to content

expressions

AlwaysFalse

Bases: BooleanExpression, Singleton

FALSE expression.

Source code in pyiceberg/expressions/__init__.py 
326
327
328
329
330
331
332
333
334
335
336
337
338
339
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 
329
330
331
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 
337
338
339
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 
333
334
335
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 
310
311
312
313
314
315
316
317
318
319
320
321
322
323
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 
313
314
315
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 
321
322
323
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 
317
318
319
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 
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
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 
216
217
218
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 
233
234
235
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 
228
229
230
231
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 
224
225
226
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 
220
221
222
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 
60
61
62
63
64
65
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 
63
64
65
@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 
72
73
class Bound(ABC):
    """Represents a bound value expression."""

BoundEqualTo

Bases: BoundLiteralPredicate[L]

Source code in pyiceberg/expressions/__init__.py 
729
730
731
732
733
734
735
736
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 
730
731
732
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 
759
760
761
762
763
764
765
766
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 
760
761
762
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 
749
750
751
752
753
754
755
756
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 
750
751
752
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 
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
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 
591
592
593
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 
587
588
589
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 
455
456
457
458
459
460
461
462
463
464
465
466
467
468
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 
462
463
464
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 
405
406
407
408
409
410
411
412
413
414
415
416
417
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 
411
412
413
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 
769
770
771
772
773
774
775
776
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 
770
771
772
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 
779
780
781
782
783
784
785
786
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 
780
781
782
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 
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
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 
714
715
716
717
718
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 
720
721
722
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 
739
740
741
742
743
744
745
746
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 
740
741
742
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 
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
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 
614
615
616
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 
471
472
473
474
475
476
477
478
479
480
481
482
483
484
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 
478
479
480
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 
420
421
422
423
424
425
426
427
428
429
430
431
432
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 
426
427
428
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 
799
800
801
802
803
804
805
806
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 
800
801
802
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 
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
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 
348
349
350
351
352
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 
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
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

    def __hash__(self) -> int:
        """Return hash value of the BoundReference class."""
        return hash(str(self))

__eq__(other)

Return the equality of two instances of the BoundReference class.

Source code in pyiceberg/expressions/__init__.py 
127
128
129
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

__hash__()

Return hash value of the BoundReference class.

Source code in pyiceberg/expressions/__init__.py 
138
139
140
def __hash__(self) -> int:
    """Return hash value of the BoundReference class."""
    return hash(str(self))

__repr__()

Return the string representation of the BoundReference class.

Source code in pyiceberg/expressions/__init__.py 
131
132
133
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 
117
118
119
120
121
122
123
124
125
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 
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
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 
564
565
566
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 
568
569
570
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 
559
560
561
562
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 
554
555
556
557
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 
789
790
791
792
793
794
795
796
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 
790
791
792
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 
90
91
92
93
94
95
96
97
98
99
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 
97
98
99
@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 
93
94
95
@abstractmethod
def ref(self) -> BoundReference[L]:
    """Return the bound reference."""

BoundUnaryPredicate

Bases: BoundPredicate[L], ABC

Source code in pyiceberg/expressions/__init__.py 
391
392
393
394
395
396
397
398
399
400
401
402
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 
400
401
402
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 
392
393
394
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 
809
810
811
812
813
814
815
816
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 
810
811
812
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 
849
850
851
852
853
854
855
856
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 
850
851
852
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 
839
840
841
842
843
844
845
846
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 
840
841
842
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 
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
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 
636
637
638
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 
487
488
489
490
491
492
493
494
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 
488
489
490
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 
435
436
437
438
439
440
441
442
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 
436
437
438
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 
829
830
831
832
833
834
835
836
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 
830
831
832
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 
859
860
861
862
863
864
865
866
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 
860
861
862
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 
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
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 
691
692
693
694
695
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 
697
698
699
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 
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
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 
297
298
299
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 
305
306
307
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 
301
302
303
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 
293
294
295
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 
819
820
821
822
823
824
825
826
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 
820
821
822
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 
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
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 
658
659
660
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 
497
498
499
500
501
502
503
504
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 
498
499
500
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 
445
446
447
448
449
450
451
452
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 
446
447
448
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 
879
880
881
882
883
884
885
886
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 
880
881
882
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 
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
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 
259
260
261
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 
272
273
274
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 
267
268
269
270
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 
263
264
265
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 
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
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 
169
170
171
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 
165
166
167
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 
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
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 
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
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 
528
529
530
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 
532
533
534
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 
523
524
525
526
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 
518
519
520
521
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 
869
870
871
872
873
874
875
876
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 
870
871
872
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 
68
69
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 
377
378
379
380
381
382
383
384
385
386
387
388
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 
382
383
384
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 
79
80
81
82
83
84
85
86
87
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 
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
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 
365
366
367
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 
143
144
145
146
147
class UnboundTerm(Term[Any], Unbound[BoundTerm[L]], ABC):
    """Represents an unbound term."""

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