samredai commented on a change in pull request #4262: URL: https://github.com/apache/iceberg/pull/4262#discussion_r838084979
########## File path: python/src/iceberg/expression/literals.py ########## @@ -0,0 +1,502 @@ +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + +import datetime +import struct +import sys +import uuid +from abc import ABC, abstractmethod +from decimal import ROUND_HALF_UP, Decimal +from functools import singledispatch +from typing import Generic, Optional, TypeVar, Union + +if sys.version_info >= (3, 8): + from functools import singledispatchmethod # pragma: no cover +else: + from singledispatch import singledispatchmethod # pragma: no cover + +import pytz + +from iceberg.types import ( + BinaryType, + BooleanType, + DateType, + DecimalType, + DoubleType, + FixedType, + FloatType, + IntegerType, + LongType, + Singleton, + StringType, + TimestampType, + TimestamptzType, + TimeType, + UUIDType, +) + +EPOCH = datetime.datetime.utcfromtimestamp(0) +T = TypeVar("T") + + +class Literal(Generic[T], ABC): + """Literal which has a value and can be converted between types""" + + def __init__(self, value: T): + if value is None: + raise TypeError(f"Invalid literal value: {value}") + self._value = value + + @property + def value(self) -> T: + return self._value + + @abstractmethod + def to(self, type_var): + ... # pragma: no cover + + def __repr__(self): + return f"{type(self).__name__}({self.value})" + + def __str__(self): + return str(self.value) + + def __eq__(self, other): + return self.value == other.value + + def __ne__(self, other): + return not self.__eq__(other) + + def __lt__(self, other): + return self.value < other.value + + def __gt__(self, other): + return self.value > other.value + + def __le__(self, other): + return self.value <= other.value + + def __ge__(self, other): + return self.value >= other.value + + +@singledispatch +def literal(value) -> Literal: + """ + A generic Literal factory to construct an iceberg Literal based on python primitive data type + using dynamic overloading + + Args: + value(python primitive type): the value to be associated with literal + + Example: + from iceberg.expressions.literals import literal + >>> literal(123) + IntegerLiteral(123) + """ + raise TypeError(f"Unimplemented Type Literal for value: {str(value)}") + + [email protected](bool) +def _(value: bool) -> Literal[bool]: + return BooleanLiteral(value) + + [email protected](int) +def _(value: int) -> Literal[int]: + """ + Upgrade to long if python int is outside the JAVA_MIN_INT and JAVA_MAX_INT + """ + if value < IntegerType.min or value > IntegerType.max: + return LongLiteral(value) + return IntegerLiteral(value) + + [email protected](float) +def _(value: float) -> Literal[float]: + """ + Upgrade to double if python float is outside the JAVA_MIN_FLOAT and JAVA_MAX_FLOAT + """ + if value < FloatType.min or value > FloatType.max: + return DoubleLiteral(value) + return FloatLiteral(value) + + [email protected](str) +def _(value: str) -> Literal[str]: + return StringLiteral(value) + + [email protected](uuid.UUID) +def _(value: uuid.UUID) -> Literal[uuid.UUID]: + return UUIDLiteral(value) + + [email protected](bytes) +def _(value: bytes) -> Literal[bytes]: + return FixedLiteral(value) + + [email protected](bytearray) +def _(value: bytearray) -> Literal[bytes]: + return BinaryLiteral(value) + + [email protected](Decimal) +def _(value: Decimal) -> Literal[Decimal]: + return DecimalLiteral(value) + + +class AboveMax(Literal[None], Singleton): + def __init__(self): + pass + + def value(self): + raise ValueError("AboveMax has no value") + + def to(self, type_var): + raise TypeError("Cannot change the type of AboveMax") + + def __repr__(self): + return "AboveMax()" + + def __str__(self): + return "AboveMax" + + +class BelowMin(Literal[None], Singleton): + def __init__(self): + pass + + def value(self): + raise ValueError("BelowMin has no value") + + def to(self, type_var): + raise TypeError("Cannot change the type of BelowMin") + + def __repr__(self): + return "BelowMin()" + + def __str__(self): + return "BelowMin" + + +class BooleanLiteral(Literal[bool]): + def __init__(self, value): + self._value = value + + @singledispatchmethod + def to(self, type_var): + return None + + @to.register(BooleanType) + def _(self, type_var): + return self + + +class IntegerLiteral(Literal[int]): + def __init__(self, value): + self._value = value + + @singledispatchmethod + def to(self, type_var): + return None + + @to.register(IntegerType) + def _(self, type_var: IntegerType) -> "IntegerLiteral": + return self + + @to.register(LongType) + def _(self, type_var: LongType) -> "LongLiteral": + return LongLiteral(self.value) + + @to.register(FloatType) + def _(self, type_var: FloatType) -> "FloatLiteral": + return FloatLiteral(float(self.value)) + + @to.register(DoubleType) + def _(self, type_var: DoubleType) -> "DoubleLiteral": + return DoubleLiteral(self.value) + + @to.register(DateType) + def _(self, type_var: DateType) -> "DateLiteral": + return DateLiteral(self.value) + + @to.register(DecimalType) + def _(self, type_var: DecimalType) -> "DecimalLiteral": + if type_var.scale == 0: + return DecimalLiteral(Decimal(self.value)) + else: + return DecimalLiteral( + Decimal(self.value).quantize( + Decimal("." + "".join(["0" for _ in range(1, type_var.scale)]) + "1"), rounding=ROUND_HALF_UP + ) + ) + + +class LongLiteral(Literal[int]): + @singledispatchmethod + def to(self, type_var): + return None + + @to.register(LongType) + def _(self, type_var: LongType) -> "LongLiteral": + return self + + @to.register(IntegerType) + def _(self, type_var: IntegerType) -> Union[AboveMax, BelowMin, IntegerLiteral]: + if IntegerType.max < self.value: + return AboveMax() + elif IntegerType.min > self.value: + return BelowMin() + return IntegerLiteral(self.value) + + @to.register(FloatType) + def _(self, type_var: FloatType) -> "FloatLiteral": + return FloatLiteral(self.value) Review comment: Oh I see, I would have expected mypy to catch this when the tests ran since it should be able to deduce that the `T` in `value: T` is an int. It's possible that this might be a gap in mypy where it's not factoring in that LongLiteral inherits from `Literal[int]`. Typically though mypy will raise an error during tests along the lines of `Argument 1 to "__init__" has incompatible type "int"; expected "float"`. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
