samredai commented on a change in pull request #3399: URL: https://github.com/apache/iceberg/pull/3399#discussion_r740320039
########## File path: python/src/iceberg/expressions.py ########## @@ -0,0 +1,106 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + +from enum import Enum + +from iceberg.exceptions import OperationError + + +class Operation(Enum): + """Operations to be used as components in expressions + + Various operations can be negated or reversed. Negating an + operation is as simple as using the built-in subtraction operator: + + >>> print(-Operation.TRUE) + Operation.FALSE + >>> print(-Operation.IS_NULL) + Operation.NOT_NULL + + Reversing an operation can be done using the built-in reversed() method: + >>> print(reversed(Operation.LT)) + Operation.GT + >>> print(reversed(Operation.EQ)) + Operation.NOT_EQ + + Raises: + OperationError: This is raised when attempting to negate or reverse + an operation that cannot be negated or reversed. + """ + TRUE = "TRUE" Review comment: It looks like Enum comparisons are always done by identity ([docs](https://docs.python.org/3.11/howto/enum.html#comparisons)) and the values don't matter in that regard. I verified this by making an enum where the values were very long arrays and there was no impact to the performance of comparing the enums (comparing the long arrays directly takes ages). However I did find these alternatives in the docs that remove the requirement for hard-coding literals completely: ## Auto (option 1) ```py from enum import Enum, auto class Operation(Enum): TRUE = auto() # <- resolves to 1 FALSE = auto() # <- resolves to 2 ``` ## Auto as name (option 2) ```py from enum import Enum, auto class AutoName(Enum): def _generate_next_value_(name, start, count, last_values): return name class Operation(AutoName): TRUE = auto() # <- resolves to "TRUE" FALSE = auto() # <- resolves to "FALSE" ``` Option 1 looks very clean but for the few extra lines in option 2, the Enum has readable values that are actually meaningful. Thoughts on which one we should use (if either)? ########## File path: python/src/iceberg/expressions.py ########## @@ -0,0 +1,106 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + +from enum import Enum + +from iceberg.exceptions import OperationError + + +class Operation(Enum): + """Operations to be used as components in expressions + + Various operations can be negated or reversed. Negating an + operation is as simple as using the built-in subtraction operator: + + >>> print(-Operation.TRUE) + Operation.FALSE + >>> print(-Operation.IS_NULL) + Operation.NOT_NULL + + Reversing an operation can be done using the built-in reversed() method: + >>> print(reversed(Operation.LT)) + Operation.GT + >>> print(reversed(Operation.EQ)) + Operation.NOT_EQ + + Raises: + OperationError: This is raised when attempting to negate or reverse + an operation that cannot be negated or reversed. + """ + TRUE = "TRUE" Review comment: I don't think there's any functional reason we need them to be readable. There is the ultra edge case where a user is using the library in an interactive manner and has some variable `x` that equals `Operation.TRUE` for example and checks `x.value`. In that case an integer wouldn't be as informative as a string "TRUE" or "true". To your point though `str(x)` or `print(x)` returns "Operation.TRUE" which makes that moot. I'll update this to use `auto()` ########## File path: python/src/iceberg/exceptions.py ########## @@ -0,0 +1,19 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you 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. + +class OperationError(Exception): Review comment: fixed ########## File path: python/src/iceberg/expressions.py ########## @@ -0,0 +1,106 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + +from enum import Enum + +from iceberg.exceptions import OperationError + + +class Operation(Enum): + """Operations to be used as components in expressions + + Various operations can be negated or reversed. Negating an + operation is as simple as using the built-in subtraction operator: + + >>> print(-Operation.TRUE) + Operation.FALSE + >>> print(-Operation.IS_NULL) + Operation.NOT_NULL + + Reversing an operation can be done using the built-in reversed() method: + >>> print(reversed(Operation.LT)) + Operation.GT + >>> print(reversed(Operation.EQ)) + Operation.NOT_EQ + + Raises: + OperationError: This is raised when attempting to negate or reverse + an operation that cannot be negated or reversed. + """ + TRUE = "TRUE" Review comment: fixed, went with option 1 ########## File path: python/src/iceberg/expressions.py ########## @@ -0,0 +1,106 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + +from enum import Enum + +from iceberg.exceptions import OperationError + + +class Operation(Enum): + """Operations to be used as components in expressions + + Various operations can be negated or reversed. Negating an + operation is as simple as using the built-in subtraction operator: + + >>> print(-Operation.TRUE) + Operation.FALSE + >>> print(-Operation.IS_NULL) + Operation.NOT_NULL + + Reversing an operation can be done using the built-in reversed() method: + >>> print(reversed(Operation.LT)) + Operation.GT + >>> print(reversed(Operation.EQ)) + Operation.NOT_EQ + + Raises: + OperationError: This is raised when attempting to negate or reverse + an operation that cannot be negated or reversed. + """ + TRUE = "TRUE" + FALSE = "FALSE" + IS_NULL = "IS_NULL" + NOT_NULL = "NOT_NULL" + IS_NAN = "IS_NAN" + NOT_NAN = "NOT_NAN" + LT = "LT" + LT_EQ = "LT_EQ" + GT = "GT" + GT_EQ = "GT_EQ" + EQ = "EQ" + NOT_EQ = "NOT_EQ" + IN = "IN" + NOT_IN = "NOT_IN" + NOT = "NOT" + AND = "AND" + OR = "OR" + + def __str__(self): + return self.value + + def __repr__(self): + return f"Operation.{self.value}" Review comment: removed ########## File path: python/src/iceberg/expressions.py ########## @@ -0,0 +1,106 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + +from enum import Enum + +from iceberg.exceptions import OperationError + + +class Operation(Enum): + """Operations to be used as components in expressions + + Various operations can be negated or reversed. Negating an + operation is as simple as using the built-in subtraction operator: + + >>> print(-Operation.TRUE) + Operation.FALSE + >>> print(-Operation.IS_NULL) + Operation.NOT_NULL + + Reversing an operation can be done using the built-in reversed() method: + >>> print(reversed(Operation.LT)) + Operation.GT + >>> print(reversed(Operation.EQ)) + Operation.NOT_EQ + + Raises: + OperationError: This is raised when attempting to negate or reverse + an operation that cannot be negated or reversed. + """ + TRUE = "TRUE" + FALSE = "FALSE" + IS_NULL = "IS_NULL" + NOT_NULL = "NOT_NULL" + IS_NAN = "IS_NAN" + NOT_NAN = "NOT_NAN" + LT = "LT" + LT_EQ = "LT_EQ" + GT = "GT" + GT_EQ = "GT_EQ" + EQ = "EQ" + NOT_EQ = "NOT_EQ" + IN = "IN" + NOT_IN = "NOT_IN" + NOT = "NOT" + AND = "AND" + OR = "OR" + + def __str__(self): + return self.value + + def __repr__(self): + return f"Operation.{self.value}" + + def __neg__(self): + """Returns the operation used when this is negated.""" + + try: + return { + Operation.TRUE: Operation.FALSE, + Operation.FALSE: Operation.TRUE, + Operation.IS_NULL: Operation.NOT_NULL, + Operation.NOT_NULL: Operation.IS_NULL, + Operation.IS_NAN: Operation.NOT_NAN, + Operation.NOT_NAN: Operation.IS_NAN, + Operation.LT: Operation.GT_EQ, + Operation.LT_EQ: Operation.GT, + Operation.GT: Operation.LT_EQ, + Operation.GT_EQ: Operation.LT, + Operation.EQ: Operation.NOT_EQ, + Operation.NOT_EQ: Operation.EQ, + Operation.IN: Operation.NOT_IN, + Operation.NOT_IN: Operation.IN, + }[self] + except KeyError: + raise OperationError(f"No negation defined for operation {self}") + + def __reversed__(self): + """ Returns the equivalent operation when the left and right operands are exchanged.""" + + try: + return { + Operation.LT: Operation.GT, + Operation.LT_EQ: Operation.GT_EQ, + Operation.GT: Operation.LT, + Operation.GT_EQ: Operation.LT_EQ, + Operation.EQ: Operation.EQ, + Operation.NOT_EQ: Operation.NOT_EQ, + Operation.AND: Operation.AND, + Operation.OR: Operation.OR, + }[self] Review comment: Creating it at the class level worked but looked odd because the maps appeared to be just other enums. What I did instead is defined the map right below the class definition so they're created once at import time. -- 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]
