Skip to content

literals

AboveMax

Bases: Literal[L]

Source code in pyiceberg/expressions/literals.py 
152
153
154
155
156
157
158
159
class AboveMax(Literal[L]):
    def __repr__(self) -> str:
        """Return the string representation of the AboveMax class."""
        return f"{self.__class__.__name__}()"

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

__repr__()

Return the string representation of the AboveMax class.

Source code in pyiceberg/expressions/literals.py 
153
154
155
def __repr__(self) -> str:
    """Return the string representation of the AboveMax class."""
    return f"{self.__class__.__name__}()"

__str__()

Return the string representation of the AboveMax class.

Source code in pyiceberg/expressions/literals.py 
157
158
159
def __str__(self) -> str:
    """Return the string representation of the AboveMax class."""
    return self.__class__.__name__

BelowMin

Bases: Literal[L]

Source code in pyiceberg/expressions/literals.py 
162
163
164
165
166
167
168
169
class BelowMin(Literal[L]):
    def __repr__(self) -> str:
        """Return the string representation of the BelowMin class."""
        return f"{self.__class__.__name__}()"

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

__repr__()

Return the string representation of the BelowMin class.

Source code in pyiceberg/expressions/literals.py 
163
164
165
def __repr__(self) -> str:
    """Return the string representation of the BelowMin class."""
    return f"{self.__class__.__name__}()"

__str__()

Return the string representation of the BelowMin class.

Source code in pyiceberg/expressions/literals.py 
167
168
169
def __str__(self) -> str:
    """Return the string representation of the BelowMin class."""
    return self.__class__.__name__

FloatLiteral

Bases: Literal[float]

Source code in pyiceberg/expressions/literals.py 
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
class FloatLiteral(Literal[float]):
    def __init__(self, value: float) -> None:
        super().__init__(value, float)
        self._value32 = struct.unpack("<f", struct.pack("<f", value))[0]

    def __eq__(self, other: Any) -> bool:
        """Return the equality of two instances of the FloatLiteral class."""
        return self._value32 == other

    def __lt__(self, other: Any) -> bool:
        """Return if one instance of the FloatLiteral class is less than another instance."""
        return self._value32 < other

    def __gt__(self, other: Any) -> bool:
        """Return if one instance of the FloatLiteral class is greater than another instance."""
        return self._value32 > other

    def __le__(self, other: Any) -> bool:
        """Return if one instance of the FloatLiteral class is less than or equal to another instance."""
        return self._value32 <= other

    def __ge__(self, other: Any) -> bool:
        """Return if one instance of the FloatLiteral class is greater than or equal to another instance."""
        return self._value32 >= other

    def __hash__(self) -> int:
        """Return a hashed representation of the FloatLiteral class."""
        return hash(self._value32)

    @singledispatchmethod
    def to(self, type_var: IcebergType) -> Literal:  # type: ignore
        raise TypeError(f"Cannot convert FloatLiteral into {type_var}")

    @to.register(FloatType)
    def _(self, _: FloatType) -> Literal[float]:
        return self

    @to.register(DoubleType)
    def _(self, _: DoubleType) -> Literal[float]:
        return DoubleLiteral(self.value)

    @to.register(DecimalType)
    def _(self, type_var: DecimalType) -> Literal[Decimal]:
        return DecimalLiteral(Decimal(self.value).quantize(Decimal((0, (1,), -type_var.scale)), rounding=ROUND_HALF_UP))

__eq__(other)

Return the equality of two instances of the FloatLiteral class.

Source code in pyiceberg/expressions/literals.py 
330
331
332
def __eq__(self, other: Any) -> bool:
    """Return the equality of two instances of the FloatLiteral class."""
    return self._value32 == other

__ge__(other)

Return if one instance of the FloatLiteral class is greater than or equal to another instance.

Source code in pyiceberg/expressions/literals.py 
346
347
348
def __ge__(self, other: Any) -> bool:
    """Return if one instance of the FloatLiteral class is greater than or equal to another instance."""
    return self._value32 >= other

__gt__(other)

Return if one instance of the FloatLiteral class is greater than another instance.

Source code in pyiceberg/expressions/literals.py 
338
339
340
def __gt__(self, other: Any) -> bool:
    """Return if one instance of the FloatLiteral class is greater than another instance."""
    return self._value32 > other

__hash__()

Return a hashed representation of the FloatLiteral class.

Source code in pyiceberg/expressions/literals.py 
350
351
352
def __hash__(self) -> int:
    """Return a hashed representation of the FloatLiteral class."""
    return hash(self._value32)

__le__(other)

Return if one instance of the FloatLiteral class is less than or equal to another instance.

Source code in pyiceberg/expressions/literals.py 
342
343
344
def __le__(self, other: Any) -> bool:
    """Return if one instance of the FloatLiteral class is less than or equal to another instance."""
    return self._value32 <= other

__lt__(other)

Return if one instance of the FloatLiteral class is less than another instance.

Source code in pyiceberg/expressions/literals.py 
334
335
336
def __lt__(self, other: Any) -> bool:
    """Return if one instance of the FloatLiteral class is less than another instance."""
    return self._value32 < other

Literal

Bases: Generic[L], ABC

Literal which has a value and can be converted between types.

Source code in pyiceberg/expressions/literals.py 
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
class Literal(Generic[L], ABC):
    """Literal which has a value and can be converted between types."""

    _value: L

    def __init__(self, value: L, value_type: Type[L]):
        if value is None or not isinstance(value, value_type):
            raise TypeError(f"Invalid literal value: {value!r} (not a {value_type})")
        if isinstance(value, float) and isnan(value):
            raise ValueError("Cannot create expression literal from NaN.")
        self._value = value

    @property
    def value(self) -> L:
        return self._value

    @singledispatchmethod
    @abstractmethod
    def to(self, type_var: IcebergType) -> Literal[L]: ...  # pragma: no cover

    def __repr__(self) -> str:
        """Return the string representation of the Literal class."""
        return f"{type(self).__name__}({self.value!r})"

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

    def __hash__(self) -> int:
        """Return a hashed representation of the Literal class."""
        return hash(self.value)

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

    def __ne__(self, other: Any) -> bool:
        """Return the inequality of two instances of the Literal class."""
        return not self.__eq__(other)

    def __lt__(self, other: Any) -> bool:
        """Return if one instance of the Literal class is less than another instance."""
        return self.value < other.value

    def __gt__(self, other: Any) -> bool:
        """Return if one instance of the Literal class is greater than another instance."""
        return self.value > other.value

    def __le__(self, other: Any) -> bool:
        """Return if one instance of the Literal class is less than or equal to another instance."""
        return self.value <= other.value

    def __ge__(self, other: Any) -> bool:
        """Return if one instance of the Literal class is greater than or equal to another instance."""
        return self.value >= other.value

__eq__(other)

Return the equality of two instances of the Literal class.

Source code in pyiceberg/expressions/literals.py 
95
96
97
98
99
def __eq__(self, other: Any) -> bool:
    """Return the equality of two instances of the Literal class."""
    if not isinstance(other, Literal):
        return False
    return self.value == other.value

__ge__(other)

Return if one instance of the Literal class is greater than or equal to another instance.

Source code in pyiceberg/expressions/literals.py 
117
118
119
def __ge__(self, other: Any) -> bool:
    """Return if one instance of the Literal class is greater than or equal to another instance."""
    return self.value >= other.value

__gt__(other)

Return if one instance of the Literal class is greater than another instance.

Source code in pyiceberg/expressions/literals.py 
109
110
111
def __gt__(self, other: Any) -> bool:
    """Return if one instance of the Literal class is greater than another instance."""
    return self.value > other.value

__hash__()

Return a hashed representation of the Literal class.

Source code in pyiceberg/expressions/literals.py 
91
92
93
def __hash__(self) -> int:
    """Return a hashed representation of the Literal class."""
    return hash(self.value)

__le__(other)

Return if one instance of the Literal class is less than or equal to another instance.

Source code in pyiceberg/expressions/literals.py 
113
114
115
def __le__(self, other: Any) -> bool:
    """Return if one instance of the Literal class is less than or equal to another instance."""
    return self.value <= other.value

__lt__(other)

Return if one instance of the Literal class is less than another instance.

Source code in pyiceberg/expressions/literals.py 
105
106
107
def __lt__(self, other: Any) -> bool:
    """Return if one instance of the Literal class is less than another instance."""
    return self.value < other.value

__ne__(other)

Return the inequality of two instances of the Literal class.

Source code in pyiceberg/expressions/literals.py 
101
102
103
def __ne__(self, other: Any) -> bool:
    """Return the inequality of two instances of the Literal class."""
    return not self.__eq__(other)

__repr__()

Return the string representation of the Literal class.

Source code in pyiceberg/expressions/literals.py 
83
84
85
def __repr__(self) -> str:
    """Return the string representation of the Literal class."""
    return f"{type(self).__name__}({self.value!r})"

__str__()

Return the string representation of the Literal class.

Source code in pyiceberg/expressions/literals.py 
87
88
89
def __str__(self) -> str:
    """Return the string representation of the Literal class."""
    return str(self.value)

StringLiteral

Bases: Literal[str]

Source code in pyiceberg/expressions/literals.py 
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
class StringLiteral(Literal[str]):
    def __init__(self, value: str) -> None:
        super().__init__(value, str)

    @singledispatchmethod
    def to(self, type_var: IcebergType) -> Literal:  # type: ignore
        raise TypeError(f"Cannot convert StringLiteral into {type_var}")

    @to.register(StringType)
    def _(self, _: StringType) -> Literal[str]:
        return self

    @to.register(IntegerType)
    def _(self, type_var: IntegerType) -> Literal[int]:
        try:
            number = int(float(self.value))

            if IntegerType.max < number:
                return IntAboveMax()
            elif IntegerType.min > number:
                return IntBelowMin()
            return LongLiteral(number)
        except ValueError as e:
            raise ValueError(f"Could not convert {self.value} into a {type_var}") from e

    @to.register(LongType)
    def _(self, type_var: LongType) -> Literal[int]:
        try:
            long_value = int(float(self.value))
            if LongType.max < long_value:
                return LongAboveMax()
            elif LongType.min > long_value:
                return LongBelowMin()
            else:
                return LongLiteral(long_value)
        except (TypeError, ValueError) as e:
            raise ValueError(f"Could not convert {self.value} into a {type_var}") from e

    @to.register(DateType)
    def _(self, type_var: DateType) -> Literal[int]:
        try:
            return DateLiteral(date_str_to_days(self.value))
        except (TypeError, ValueError) as e:
            raise ValueError(f"Could not convert {self.value} into a {type_var}") from e

    @to.register(TimeType)
    def _(self, type_var: TimeType) -> Literal[int]:
        try:
            return TimeLiteral(time_str_to_micros(self.value))
        except (TypeError, ValueError) as e:
            raise ValueError(f"Could not convert {self.value} into a {type_var}") from e

    @to.register(TimestampType)
    def _(self, _: TimestampType) -> Literal[int]:
        return TimestampLiteral(timestamp_to_micros(self.value))

    @to.register(TimestamptzType)
    def _(self, _: TimestamptzType) -> Literal[int]:
        return TimestampLiteral(timestamptz_to_micros(self.value))

    @to.register(UUIDType)
    def _(self, _: UUIDType) -> Literal[bytes]:
        return UUIDLiteral(UUID(self.value).bytes)

    @to.register(DecimalType)
    def _(self, type_var: DecimalType) -> Literal[Decimal]:
        dec = Decimal(self.value)
        scale = abs(int(dec.as_tuple().exponent))
        if type_var.scale == scale:
            return DecimalLiteral(dec)
        else:
            raise ValueError(f"Could not convert {self.value} into a {type_var}, scales differ {type_var.scale} <> {scale}")

    @to.register(BooleanType)
    def _(self, type_var: BooleanType) -> Literal[bool]:
        value_upper = self.value.upper()
        if value_upper in ["TRUE", "FALSE"]:
            return BooleanLiteral(value_upper == "TRUE")
        else:
            raise ValueError(f"Could not convert {self.value} into a {type_var}")

    def __repr__(self) -> str:
        """Return the string representation of the StringLiteral class."""
        return f"literal({repr(self.value)})"

__repr__()

Return the string representation of the StringLiteral class.

Source code in pyiceberg/expressions/literals.py 
595
596
597
def __repr__(self) -> str:
    """Return the string representation of the StringLiteral class."""
    return f"literal({repr(self.value)})"

literal(value)

Construct an Iceberg Literal based on Python primitive data type.

Parameters:

Name Type Description Default
value Python primitive type

the value to be associated with literal.

 required
Example

from pyiceberg.expressions.literals import literal.

literal(123) LongLiteral(123)

Source code in pyiceberg/expressions/literals.py 
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
def literal(value: L) -> Literal[L]:
    """
    Construct an Iceberg Literal based on Python primitive data type.

    Args:
        value (Python primitive type): the value to be associated with literal.

    Example:
        from pyiceberg.expressions.literals import literal.
        >>> literal(123)
        LongLiteral(123)
    """
    if isinstance(value, float):
        return DoubleLiteral(value)  # type: ignore
    elif isinstance(value, bool):
        return BooleanLiteral(value)
    elif isinstance(value, int):
        return LongLiteral(value)
    elif isinstance(value, str):
        return StringLiteral(value)
    elif isinstance(value, UUID):
        return UUIDLiteral(value.bytes)  # type: ignore
    elif isinstance(value, bytes):
        return BinaryLiteral(value)
    elif isinstance(value, Decimal):
        return DecimalLiteral(value)
    else:
        raise TypeError(f"Invalid literal value: {repr(value)}")