You are viewing a plain text version of this content. The canonical link for it is here.
Posted to reviews@spark.apache.org by GitBox <gi...@apache.org> on 2022/11/30 01:18:47 UTC
[GitHub] [spark] amaliujia opened a new pull request, #38844: [SPARK-41328][CONNECT][PYTHON] Add logical and string API to Column
amaliujia opened a new pull request, #38844:
URL: https://github.com/apache/spark/pull/38844
<!--
Thanks for sending a pull request! Here are some tips for you:
1. If this is your first time, please read our contributor guidelines: https://spark.apache.org/contributing.html
2. Ensure you have added or run the appropriate tests for your PR: https://spark.apache.org/developer-tools.html
3. If the PR is unfinished, add '[WIP]' in your PR title, e.g., '[WIP][SPARK-XXXX] Your PR title ...'.
4. Be sure to keep the PR description updated to reflect all changes.
5. Please write your PR title to summarize what this PR proposes.
6. If possible, provide a concise example to reproduce the issue for a faster review.
7. If you want to add a new configuration, please read the guideline first for naming configurations in
'core/src/main/scala/org/apache/spark/internal/config/ConfigEntry.scala'.
8. If you want to add or modify an error type or message, please read the guideline first in
'core/src/main/resources/error/README.md'.
-->
### What changes were proposed in this pull request?
<!--
Please clarify what changes you are proposing. The purpose of this section is to outline the changes and how this PR fixes the issue.
If possible, please consider writing useful notes for better and faster reviews in your PR. See the examples below.
1. If you refactor some codes with changing classes, showing the class hierarchy will help reviewers.
2. If you fix some SQL features, you can provide some references of other DBMSes.
3. If there is design documentation, please add the link.
4. If there is a discussion in the mailing list, please add the link.
-->
1. Upgrade `_typing.py` to use `Column`.
2. Add logical operators (and, or, etc.) and strings (like, substr, etc.) to `Column`.
### Why are the changes needed?
<!--
Please clarify why the changes are needed. For instance,
1. If you propose a new API, clarify the use case for a new API.
3. If you fix a bug, you can clarify why it is a bug.
-->
Improve API coverage
### Does this PR introduce _any_ user-facing change?
<!--
Note that it means *any* user-facing change including all aspects such as the documentation fix.
If yes, please clarify the previous behavior and the change this PR proposes - provide the console output, description and/or an example to show the behavior difference if possible.
If possible, please also clarify if this is a user-facing change compared to the released Spark versions or within the unreleased branches such as master.
If no, write 'No'.
-->
NO
### How was this patch tested?
<!--
If tests were added, say they were added here. Please make sure to add some test cases that check the changes thoroughly including negative and positive cases if possible.
If it was tested in a way different from regular unit tests, please clarify how you tested step by step, ideally copy and paste-able, so that other reviewers can test and check, and descendants can verify in the future.
If tests were not added, please describe why they were not added and/or why it was difficult to add.
If benchmark tests were added, please run the benchmarks in GitHub Actions for the consistent environment, and the instructions could accord to: https://spark.apache.org/developer-tools.html#github-workflow-benchmarks.
-->
UT
--
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: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] HyukjinKwon closed pull request #38844: [SPARK-41328][CONNECT][PYTHON] Add logical and string API to Column
Posted by GitBox <gi...@apache.org>.
HyukjinKwon closed pull request #38844: [SPARK-41328][CONNECT][PYTHON] Add logical and string API to Column
URL: https://github.com/apache/spark/pull/38844
--
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: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] HyukjinKwon commented on a diff in pull request #38844: [SPARK-41328][CONNECT][PYTHON] Add logical and string API to Column
Posted by GitBox <gi...@apache.org>.
HyukjinKwon commented on code in PR #38844:
URL: https://github.com/apache/spark/pull/38844#discussion_r1035467772
##########
python/pyspark/sql/connect/column.py:
##########
@@ -352,17 +365,332 @@ def __init__(self, expr: Expression) -> None:
__rpow__ = _bin_op("pow", reverse=True)
__ge__ = _bin_op(">=")
__le__ = _bin_op("<=")
- # __eq__ = _bin_op("==") # ignore [assignment]
+
+ _eqNullSafe_doc = """
+ Equality test that is safe for null values.
+
+ .. versionadded:: 2.3.0
Review Comment:
In fact, we should remove all `versionadded:: 3.4.0` in these pleaces, and just add one `versionadded:: 3.4.0` into the top level of the package. We can just remove them for now.
--
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: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] amaliujia commented on a diff in pull request #38844: [SPARK-41328][CONNECT][PYTHON] Add logical and string API to Column
Posted by GitBox <gi...@apache.org>.
amaliujia commented on code in PR #38844:
URL: https://github.com/apache/spark/pull/38844#discussion_r1035490664
##########
python/pyspark/sql/connect/column.py:
##########
@@ -352,17 +365,326 @@ def __init__(self, expr: Expression) -> None:
__rpow__ = _bin_op("pow", reverse=True)
__ge__ = _bin_op(">=")
__le__ = _bin_op("<=")
- # __eq__ = _bin_op("==") # ignore [assignment]
+
+ _eqNullSafe_doc = """
+ Equality test that is safe for null values.
+
+ Parameters
+ ----------
+ other
+ a value or :class:`Column`
+
+ Examples
+ --------
+ >>> from pyspark.sql import Row
+ >>> df1 = spark.createDataFrame([
+ ... Row(id=1, value='foo'),
+ ... Row(id=2, value=None)
+ ... ])
+ >>> df1.select(
+ ... df1['value'] == 'foo',
+ ... df1['value'].eqNullSafe('foo'),
+ ... df1['value'].eqNullSafe(None)
+ ... ).show()
+ +-------------+---------------+----------------+
+ |(value = foo)|(value <=> foo)|(value <=> NULL)|
+ +-------------+---------------+----------------+
+ | true| true| false|
+ | null| false| true|
+ +-------------+---------------+----------------+
+ >>> df2 = spark.createDataFrame([
+ ... Row(value = 'bar'),
+ ... Row(value = None)
+ ... ])
+ >>> df1.join(df2, df1["value"] == df2["value"]).count()
+ 0
+ >>> df1.join(df2, df1["value"].eqNullSafe(df2["value"])).count()
+ 1
+ >>> df2 = spark.createDataFrame([
+ ... Row(id=1, value=float('NaN')),
+ ... Row(id=2, value=42.0),
+ ... Row(id=3, value=None)
+ ... ])
+ >>> df2.select(
+ ... df2['value'].eqNullSafe(None),
+ ... df2['value'].eqNullSafe(float('NaN')),
+ ... df2['value'].eqNullSafe(42.0)
+ ... ).show()
+ +----------------+---------------+----------------+
+ |(value <=> NULL)|(value <=> NaN)|(value <=> 42.0)|
+ +----------------+---------------+----------------+
+ | false| true| false|
+ | false| false| true|
+ | true| false| false|
+ +----------------+---------------+----------------+
+ Notes
+ -----
+ Unlike Pandas, PySpark doesn't consider NaN values to be NULL. See the
+ `NaN Semantics <https://spark.apache.org/docs/latest/sql-ref-datatypes.html#nan-semantics>`_
+ for details.
+ """
+ eqNullSafe = _bin_op("eqNullSafe", _eqNullSafe_doc)
+
+ __neg__ = _func_op("negate")
+
+ # `and`, `or`, `not` cannot be overloaded in Python,
+ # so use bitwise operators as boolean operators
+ __and__ = _bin_op("and")
+ __or__ = _bin_op("or")
+ __invert__ = _func_op("not")
+ __rand__ = _bin_op("and")
+ __ror__ = _bin_op("or")
+
+ # bitwise operators
+ _bitwiseOR_doc = """
+ Compute bitwise OR of this expression with another expression.
+
+ Parameters
+ ----------
+ other
+ a value or :class:`Column` to calculate bitwise or(|) with
+ this :class:`Column`.
+
+ Examples
+ --------
+ >>> from pyspark.sql import Row
+ >>> df = spark.createDataFrame([Row(a=170, b=75)])
+ >>> df.select(df.a.bitwiseOR(df.b)).collect()
+ [Row((a | b)=235)]
+ """
+ _bitwiseAND_doc = """
+ Compute bitwise AND of this expression with another expression.
+
+ Parameters
+ ----------
+ other
+ a value or :class:`Column` to calculate bitwise and(&) with
+ this :class:`Column`.
+
+ Examples
+ --------
+ >>> from pyspark.sql import Row
+ >>> df = spark.createDataFrame([Row(a=170, b=75)])
+ >>> df.select(df.a.bitwiseAND(df.b)).collect()
+ [Row((a & b)=10)]
+ """
+ _bitwiseXOR_doc = """
+ Compute bitwise XOR of this expression with another expression.
+
+ Parameters
+ ----------
+ other
+ a value or :class:`Column` to calculate bitwise xor(^) with
+ this :class:`Column`.
+
+ Examples
+ --------
+ >>> from pyspark.sql import Row
+ >>> df = spark.createDataFrame([Row(a=170, b=75)])
+ >>> df.select(df.a.bitwiseXOR(df.b)).collect()
+ [Row((a ^ b)=225)]
+ """
+
+ bitwiseOR = _bin_op("bitwiseOR", _bitwiseOR_doc)
+ bitwiseAND = _bin_op("bitwiseAND", _bitwiseAND_doc)
+ bitwiseXOR = _bin_op("bitwiseXOR", _bitwiseXOR_doc)
+
+ # string methods
+ def contains(self, other: Union[PrimitiveType, "Column"]) -> "Column":
+ """
+ Contains the other element. Returns a boolean :class:`Column` based on a string match.
+
+ Parameters
+ ----------
+ other
+ string in line. A value as a literal or a :class:`Column`.
+
+ Examples
+ --------
+ >>> df = spark.createDataFrame(
+ ... [(2, "Alice"), (5, "Bob")], ["age", "name"])
+ >>> df.filter(df.name.contains('o')).collect()
+ [Row(age=5, name='Bob')]
+ """
+ return _bin_op("contains")(self, other)
+
+ def startswith(self, other: Union[PrimitiveType, "Column"]) -> "Column":
+ """
+ String starts with. Returns a boolean :class:`Column` based on a string match.
+
+ Parameters
+ ----------
+ other : :class:`Column` or str
+ string at start of line (do not use a regex `^`)
+
+ Examples
+ --------
+ >>> df = spark.createDataFrame(
+ ... [(2, "Alice"), (5, "Bob")], ["age", "name"])
+ >>> df.filter(df.name.startswith('Al')).collect()
+ [Row(age=2, name='Alice')]
+ >>> df.filter(df.name.startswith('^Al')).collect()
+ []
+ """
+ return _bin_op("startsWith")(self, other)
+
+ def endswith(self, other: Union[PrimitiveType, "Column"]) -> "Column":
+ """
+ String ends with. Returns a boolean :class:`Column` based on a string match.
+
+ Parameters
+ ----------
+ other : :class:`Column` or str
+ string at end of line (do not use a regex `$`)
+
+ Examples
+ --------
+ >>> df = spark.createDataFrame(
+ ... [(2, "Alice"), (5, "Bob")], ["age", "name"])
+ >>> df.filter(df.name.endswith('ice')).collect()
+ [Row(age=2, name='Alice')]
+ >>> df.filter(df.name.endswith('ice$')).collect()
+ []
+ """
+ return _bin_op("endsWith")(self, other)
+
+ def like(self: "Column", other: str) -> "Column":
+ """
+ SQL like expression. Returns a boolean :class:`Column` based on a SQL LIKE match.
+
+ Parameters
+ ----------
+ other : str
+ a SQL LIKE pattern
+ See Also
+ --------
+ pyspark.sql.Column.rlike
+ Returns
+ -------
+ :class:`Column`
+ Column of booleans showing whether each element
+ in the Column is matched by SQL LIKE pattern.
+
+ Examples
+ --------
+ >>> df = spark.createDataFrame(
+ ... [(2, "Alice"), (5, "Bob")], ["age", "name"])
+ >>> df.filter(df.name.like('Al%')).collect()
+ [Row(age=2, name='Alice')]
+ """
+ return _bin_op("like")(self, other)
+
+ def rlike(self: "Column", other: str) -> "Column":
+ """
+ SQL RLIKE expression (LIKE with Regex). Returns a boolean :class:`Column` based on a regex
+ match.
+
+ Parameters
+ ----------
+ other : str
+ an extended regex expression
+ Returns
+ -------
+ :class:`Column`
+ Column of booleans showing whether each element
+ in the Column is matched by extended regex expression.
+
+ Examples
+ --------
+ >>> df = spark.createDataFrame(
+ ... [(2, "Alice"), (5, "Bob")], ["age", "name"])
+ >>> df.filter(df.name.rlike('ice$')).collect()
+ [Row(age=2, name='Alice')]
+ """
+ return _bin_op("like")(self, other)
+
+ def ilike(self: "Column", other: str) -> "Column":
+ """
+ SQL ILIKE expression (case insensitive LIKE). Returns a boolean :class:`Column`
+ based on a case insensitive match.
+
+ Parameters
+ ----------
+ other : str
+ a SQL LIKE pattern
+ See Also
+ --------
+ pyspark.sql.Column.rlike
+ Returns
+ -------
+ :class:`Column`
+ Column of booleans showing whether each element
+ in the Column is matched by SQL LIKE pattern.
+
+ Examples
+ --------
+ >>> df = spark.createDataFrame(
+ ... [(2, "Alice"), (5, "Bob")], ["age", "name"])
+ >>> df.filter(df.name.ilike('%Ice')).collect()
+ [Row(age=2, name='Alice')]
+ """
+ return _bin_op("ilike")(self, other)
+
+ @overload
+ def substr(self, startPos: int, length: int) -> "Column":
+ ...
+
+ @overload
+ def substr(self, startPos: "Column", length: "Column") -> "Column":
+ ...
+
+ def substr(self, startPos: Union[int, "Column"], length: Union[int, "Column"]) -> "Column":
+ """
+ Return a :class:`Column` which is a substring of the column.
+
+ Parameters
+ ----------
+ startPos : :class:`Column` or int
+ start position
+ length : :class:`Column` or int
+ length of the substring
+ Returns
+ -------
+ :class:`Column`
+ Column representing whether each element of Column is substr of origin Column.
+
+ Examples
+ --------
+ >>> df = spark.createDataFrame(
+ ... [(2, "Alice"), (5, "Bob")], ["age", "name"])
+ >>> df.select(df.name.substr(1, 3).alias("col")).collect()
+ [Row(col='Ali'), Row(col='Bob')]
+ """
+ if type(startPos) != type(length):
+ raise TypeError(
+ "startPos and length must be the same type. "
+ "Got {startPos_t} and {length_t}, respectively.".format(
+ startPos_t=type(startPos),
+ length_t=type(length),
+ )
+ )
+ from pyspark.sql.connect.function_builder import functions as F
+
+ if isinstance(length, int):
+ length_exp = self._lit(length)
+ elif isinstance(length, Column):
+ length_exp = length
+ else:
+ raise TypeError("Unsupported type for substr().")
+
+ if isinstance(startPos, int):
+ start_exp = self._lit(startPos)
+ else:
+ start_exp = startPos
+
+ return F.substr(self, start_exp, length_exp)
def __eq__(self, other: Any) -> "Column": # type: ignore[override]
"""Returns a binary expression with the current column as the left
side and the other expression as the right side.
"""
- from pyspark.sql.connect._typing import PrimitiveType
Review Comment:
I am pretty sure it does not solve the root problem...
If you check column.py, _typing.py and functions.py, you could see that _typing.py and functions.py uses `Column`, then whenever `column.py` wants to include anything from that two classes, it become circular import
--
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: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] HyukjinKwon commented on a diff in pull request #38844: [SPARK-41328][CONNECT][PYTHON] Add logical and string API to Column
Posted by GitBox <gi...@apache.org>.
HyukjinKwon commented on code in PR #38844:
URL: https://github.com/apache/spark/pull/38844#discussion_r1035441576
##########
python/pyspark/sql/connect/column.py:
##########
@@ -352,17 +365,307 @@ def __init__(self, expr: Expression) -> None:
__rpow__ = _bin_op("pow", reverse=True)
__ge__ = _bin_op(">=")
__le__ = _bin_op("<=")
- # __eq__ = _bin_op("==") # ignore [assignment]
+
+ _eqNullSafe_doc = """
+ Equality test that is safe for null values.
+ .. versionadded:: 2.3.0
+ Parameters
Review Comment:
```suggestion
Equality test that is safe for null values.
.. versionadded:: 3.4.0
Parameters
```
##########
python/pyspark/sql/connect/column.py:
##########
@@ -352,17 +365,307 @@ def __init__(self, expr: Expression) -> None:
__rpow__ = _bin_op("pow", reverse=True)
__ge__ = _bin_op(">=")
__le__ = _bin_op("<=")
- # __eq__ = _bin_op("==") # ignore [assignment]
+
+ _eqNullSafe_doc = """
+ Equality test that is safe for null values.
+ .. versionadded:: 2.3.0
+ Parameters
+ ----------
+ other
+ a value or :class:`Column`
Review Comment:
```suggestion
a value or :class:`Column`
```
Otherwise, the documentation format is broken
--
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: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] HyukjinKwon commented on a diff in pull request #38844: [SPARK-41328][CONNECT][PYTHON] Add logical and string API to Column
Posted by GitBox <gi...@apache.org>.
HyukjinKwon commented on code in PR #38844:
URL: https://github.com/apache/spark/pull/38844#discussion_r1035467371
##########
python/pyspark/sql/connect/column.py:
##########
@@ -352,17 +365,332 @@ def __init__(self, expr: Expression) -> None:
__rpow__ = _bin_op("pow", reverse=True)
__ge__ = _bin_op(">=")
__le__ = _bin_op("<=")
- # __eq__ = _bin_op("==") # ignore [assignment]
+
+ _eqNullSafe_doc = """
+ Equality test that is safe for null values.
+
+ .. versionadded:: 2.3.0
Review Comment:
```suggestion
.. versionadded:: 3.4.0
```
--
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: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] HyukjinKwon commented on a diff in pull request #38844: [SPARK-41328][CONNECT][PYTHON] Add logical and string API to Column
Posted by GitBox <gi...@apache.org>.
HyukjinKwon commented on code in PR #38844:
URL: https://github.com/apache/spark/pull/38844#discussion_r1035468735
##########
python/pyspark/sql/connect/column.py:
##########
@@ -29,6 +29,17 @@
from pyspark.sql.connect.client import SparkConnectClient
import pyspark.sql.connect.proto as proto
+# TODO: solve the circular import between _typing and this class if we want to
Review Comment:
Should ideally have a JIRA for each todo.
BTW, we can avoid the circular import by adding this import under `if TYPE_CHECKING`, and use the hint with strings. e.g.) `Union["PrimitiveType", "Column"])`
--
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: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] zhengruifeng commented on a diff in pull request #38844: [SPARK-41328][CONNECT][PYTHON] Add logical and string API to Column
Posted by GitBox <gi...@apache.org>.
zhengruifeng commented on code in PR #38844:
URL: https://github.com/apache/spark/pull/38844#discussion_r1035509866
##########
python/pyspark/sql/connect/column.py:
##########
@@ -352,17 +365,326 @@ def __init__(self, expr: Expression) -> None:
__rpow__ = _bin_op("pow", reverse=True)
__ge__ = _bin_op(">=")
__le__ = _bin_op("<=")
- # __eq__ = _bin_op("==") # ignore [assignment]
+
+ _eqNullSafe_doc = """
+ Equality test that is safe for null values.
+
+ Parameters
+ ----------
+ other
+ a value or :class:`Column`
+
+ Examples
+ --------
+ >>> from pyspark.sql import Row
+ >>> df1 = spark.createDataFrame([
+ ... Row(id=1, value='foo'),
+ ... Row(id=2, value=None)
+ ... ])
+ >>> df1.select(
+ ... df1['value'] == 'foo',
+ ... df1['value'].eqNullSafe('foo'),
+ ... df1['value'].eqNullSafe(None)
+ ... ).show()
+ +-------------+---------------+----------------+
+ |(value = foo)|(value <=> foo)|(value <=> NULL)|
+ +-------------+---------------+----------------+
+ | true| true| false|
+ | null| false| true|
+ +-------------+---------------+----------------+
+ >>> df2 = spark.createDataFrame([
+ ... Row(value = 'bar'),
+ ... Row(value = None)
+ ... ])
+ >>> df1.join(df2, df1["value"] == df2["value"]).count()
+ 0
+ >>> df1.join(df2, df1["value"].eqNullSafe(df2["value"])).count()
+ 1
+ >>> df2 = spark.createDataFrame([
+ ... Row(id=1, value=float('NaN')),
+ ... Row(id=2, value=42.0),
+ ... Row(id=3, value=None)
+ ... ])
+ >>> df2.select(
+ ... df2['value'].eqNullSafe(None),
+ ... df2['value'].eqNullSafe(float('NaN')),
+ ... df2['value'].eqNullSafe(42.0)
+ ... ).show()
+ +----------------+---------------+----------------+
+ |(value <=> NULL)|(value <=> NaN)|(value <=> 42.0)|
+ +----------------+---------------+----------------+
+ | false| true| false|
+ | false| false| true|
+ | true| false| false|
+ +----------------+---------------+----------------+
+ Notes
+ -----
+ Unlike Pandas, PySpark doesn't consider NaN values to be NULL. See the
+ `NaN Semantics <https://spark.apache.org/docs/latest/sql-ref-datatypes.html#nan-semantics>`_
+ for details.
+ """
+ eqNullSafe = _bin_op("eqNullSafe", _eqNullSafe_doc)
+
+ __neg__ = _func_op("negate")
+
+ # `and`, `or`, `not` cannot be overloaded in Python,
+ # so use bitwise operators as boolean operators
+ __and__ = _bin_op("and")
+ __or__ = _bin_op("or")
+ __invert__ = _func_op("not")
+ __rand__ = _bin_op("and")
+ __ror__ = _bin_op("or")
+
+ # bitwise operators
+ _bitwiseOR_doc = """
+ Compute bitwise OR of this expression with another expression.
+
+ Parameters
+ ----------
+ other
+ a value or :class:`Column` to calculate bitwise or(|) with
+ this :class:`Column`.
+
+ Examples
+ --------
+ >>> from pyspark.sql import Row
+ >>> df = spark.createDataFrame([Row(a=170, b=75)])
+ >>> df.select(df.a.bitwiseOR(df.b)).collect()
+ [Row((a | b)=235)]
+ """
+ _bitwiseAND_doc = """
+ Compute bitwise AND of this expression with another expression.
+
+ Parameters
+ ----------
+ other
+ a value or :class:`Column` to calculate bitwise and(&) with
+ this :class:`Column`.
+
+ Examples
+ --------
+ >>> from pyspark.sql import Row
+ >>> df = spark.createDataFrame([Row(a=170, b=75)])
+ >>> df.select(df.a.bitwiseAND(df.b)).collect()
+ [Row((a & b)=10)]
+ """
+ _bitwiseXOR_doc = """
+ Compute bitwise XOR of this expression with another expression.
+
+ Parameters
+ ----------
+ other
+ a value or :class:`Column` to calculate bitwise xor(^) with
+ this :class:`Column`.
+
+ Examples
+ --------
+ >>> from pyspark.sql import Row
+ >>> df = spark.createDataFrame([Row(a=170, b=75)])
+ >>> df.select(df.a.bitwiseXOR(df.b)).collect()
+ [Row((a ^ b)=225)]
+ """
+
+ bitwiseOR = _bin_op("bitwiseOR", _bitwiseOR_doc)
+ bitwiseAND = _bin_op("bitwiseAND", _bitwiseAND_doc)
+ bitwiseXOR = _bin_op("bitwiseXOR", _bitwiseXOR_doc)
+
+ # string methods
+ def contains(self, other: Union[PrimitiveType, "Column"]) -> "Column":
+ """
+ Contains the other element. Returns a boolean :class:`Column` based on a string match.
+
+ Parameters
+ ----------
+ other
+ string in line. A value as a literal or a :class:`Column`.
+
+ Examples
+ --------
+ >>> df = spark.createDataFrame(
+ ... [(2, "Alice"), (5, "Bob")], ["age", "name"])
+ >>> df.filter(df.name.contains('o')).collect()
+ [Row(age=5, name='Bob')]
+ """
+ return _bin_op("contains")(self, other)
+
+ def startswith(self, other: Union[PrimitiveType, "Column"]) -> "Column":
+ """
+ String starts with. Returns a boolean :class:`Column` based on a string match.
+
+ Parameters
+ ----------
+ other : :class:`Column` or str
+ string at start of line (do not use a regex `^`)
+
+ Examples
+ --------
+ >>> df = spark.createDataFrame(
+ ... [(2, "Alice"), (5, "Bob")], ["age", "name"])
+ >>> df.filter(df.name.startswith('Al')).collect()
+ [Row(age=2, name='Alice')]
+ >>> df.filter(df.name.startswith('^Al')).collect()
+ []
+ """
+ return _bin_op("startsWith")(self, other)
+
+ def endswith(self, other: Union[PrimitiveType, "Column"]) -> "Column":
+ """
+ String ends with. Returns a boolean :class:`Column` based on a string match.
+
+ Parameters
+ ----------
+ other : :class:`Column` or str
+ string at end of line (do not use a regex `$`)
+
+ Examples
+ --------
+ >>> df = spark.createDataFrame(
+ ... [(2, "Alice"), (5, "Bob")], ["age", "name"])
+ >>> df.filter(df.name.endswith('ice')).collect()
+ [Row(age=2, name='Alice')]
+ >>> df.filter(df.name.endswith('ice$')).collect()
+ []
+ """
+ return _bin_op("endsWith")(self, other)
+
+ def like(self: "Column", other: str) -> "Column":
+ """
+ SQL like expression. Returns a boolean :class:`Column` based on a SQL LIKE match.
+
+ Parameters
+ ----------
+ other : str
+ a SQL LIKE pattern
+ See Also
+ --------
+ pyspark.sql.Column.rlike
+ Returns
+ -------
+ :class:`Column`
+ Column of booleans showing whether each element
+ in the Column is matched by SQL LIKE pattern.
+
+ Examples
+ --------
+ >>> df = spark.createDataFrame(
+ ... [(2, "Alice"), (5, "Bob")], ["age", "name"])
+ >>> df.filter(df.name.like('Al%')).collect()
+ [Row(age=2, name='Alice')]
+ """
+ return _bin_op("like")(self, other)
+
+ def rlike(self: "Column", other: str) -> "Column":
+ """
+ SQL RLIKE expression (LIKE with Regex). Returns a boolean :class:`Column` based on a regex
+ match.
+
+ Parameters
+ ----------
+ other : str
+ an extended regex expression
+ Returns
+ -------
+ :class:`Column`
+ Column of booleans showing whether each element
+ in the Column is matched by extended regex expression.
+
+ Examples
+ --------
+ >>> df = spark.createDataFrame(
+ ... [(2, "Alice"), (5, "Bob")], ["age", "name"])
+ >>> df.filter(df.name.rlike('ice$')).collect()
+ [Row(age=2, name='Alice')]
+ """
+ return _bin_op("like")(self, other)
+
+ def ilike(self: "Column", other: str) -> "Column":
+ """
+ SQL ILIKE expression (case insensitive LIKE). Returns a boolean :class:`Column`
+ based on a case insensitive match.
+
+ Parameters
+ ----------
+ other : str
+ a SQL LIKE pattern
+ See Also
+ --------
+ pyspark.sql.Column.rlike
+ Returns
+ -------
+ :class:`Column`
+ Column of booleans showing whether each element
+ in the Column is matched by SQL LIKE pattern.
+
+ Examples
+ --------
+ >>> df = spark.createDataFrame(
+ ... [(2, "Alice"), (5, "Bob")], ["age", "name"])
+ >>> df.filter(df.name.ilike('%Ice')).collect()
+ [Row(age=2, name='Alice')]
+ """
+ return _bin_op("ilike")(self, other)
+
+ @overload
+ def substr(self, startPos: int, length: int) -> "Column":
+ ...
+
+ @overload
+ def substr(self, startPos: "Column", length: "Column") -> "Column":
+ ...
+
+ def substr(self, startPos: Union[int, "Column"], length: Union[int, "Column"]) -> "Column":
+ """
+ Return a :class:`Column` which is a substring of the column.
+
+ Parameters
+ ----------
+ startPos : :class:`Column` or int
+ start position
+ length : :class:`Column` or int
+ length of the substring
+ Returns
+ -------
+ :class:`Column`
+ Column representing whether each element of Column is substr of origin Column.
+
+ Examples
+ --------
+ >>> df = spark.createDataFrame(
+ ... [(2, "Alice"), (5, "Bob")], ["age", "name"])
+ >>> df.select(df.name.substr(1, 3).alias("col")).collect()
+ [Row(col='Ali'), Row(col='Bob')]
+ """
+ if type(startPos) != type(length):
+ raise TypeError(
+ "startPos and length must be the same type. "
+ "Got {startPos_t} and {length_t}, respectively.".format(
+ startPos_t=type(startPos),
+ length_t=type(length),
+ )
+ )
+ from pyspark.sql.connect.function_builder import functions as F
+
+ if isinstance(length, int):
+ length_exp = self._lit(length)
+ elif isinstance(length, Column):
+ length_exp = length
+ else:
+ raise TypeError("Unsupported type for substr().")
+
+ if isinstance(startPos, int):
+ start_exp = self._lit(startPos)
+ else:
+ start_exp = startPos
+
+ return F.substr(self, start_exp, length_exp)
def __eq__(self, other: Any) -> "Column": # type: ignore[override]
"""Returns a binary expression with the current column as the left
side and the other expression as the right side.
"""
- from pyspark.sql.connect._typing import PrimitiveType
Review Comment:
ok, let's fix it as followup
--
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: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] amaliujia commented on pull request #38844: [SPARK-41328][CONNECT][PYTHON] Add logical and string API to Column
Posted by GitBox <gi...@apache.org>.
amaliujia commented on PR #38844:
URL: https://github.com/apache/spark/pull/38844#issuecomment-1331524005
@grundprinzip @zhengruifeng @HyukjinKwon
--
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: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] zhengruifeng commented on a diff in pull request #38844: [SPARK-41328][CONNECT][PYTHON] Add logical and string API to Column
Posted by GitBox <gi...@apache.org>.
zhengruifeng commented on code in PR #38844:
URL: https://github.com/apache/spark/pull/38844#discussion_r1035479748
##########
python/pyspark/sql/connect/column.py:
##########
@@ -352,17 +365,326 @@ def __init__(self, expr: Expression) -> None:
__rpow__ = _bin_op("pow", reverse=True)
__ge__ = _bin_op(">=")
__le__ = _bin_op("<=")
- # __eq__ = _bin_op("==") # ignore [assignment]
+
+ _eqNullSafe_doc = """
+ Equality test that is safe for null values.
+
+ Parameters
+ ----------
+ other
+ a value or :class:`Column`
+
+ Examples
+ --------
+ >>> from pyspark.sql import Row
+ >>> df1 = spark.createDataFrame([
+ ... Row(id=1, value='foo'),
+ ... Row(id=2, value=None)
+ ... ])
+ >>> df1.select(
+ ... df1['value'] == 'foo',
+ ... df1['value'].eqNullSafe('foo'),
+ ... df1['value'].eqNullSafe(None)
+ ... ).show()
+ +-------------+---------------+----------------+
+ |(value = foo)|(value <=> foo)|(value <=> NULL)|
+ +-------------+---------------+----------------+
+ | true| true| false|
+ | null| false| true|
+ +-------------+---------------+----------------+
+ >>> df2 = spark.createDataFrame([
+ ... Row(value = 'bar'),
+ ... Row(value = None)
+ ... ])
+ >>> df1.join(df2, df1["value"] == df2["value"]).count()
+ 0
+ >>> df1.join(df2, df1["value"].eqNullSafe(df2["value"])).count()
+ 1
+ >>> df2 = spark.createDataFrame([
+ ... Row(id=1, value=float('NaN')),
+ ... Row(id=2, value=42.0),
+ ... Row(id=3, value=None)
+ ... ])
+ >>> df2.select(
+ ... df2['value'].eqNullSafe(None),
+ ... df2['value'].eqNullSafe(float('NaN')),
+ ... df2['value'].eqNullSafe(42.0)
+ ... ).show()
+ +----------------+---------------+----------------+
+ |(value <=> NULL)|(value <=> NaN)|(value <=> 42.0)|
+ +----------------+---------------+----------------+
+ | false| true| false|
+ | false| false| true|
+ | true| false| false|
+ +----------------+---------------+----------------+
+ Notes
+ -----
+ Unlike Pandas, PySpark doesn't consider NaN values to be NULL. See the
+ `NaN Semantics <https://spark.apache.org/docs/latest/sql-ref-datatypes.html#nan-semantics>`_
+ for details.
+ """
+ eqNullSafe = _bin_op("eqNullSafe", _eqNullSafe_doc)
+
+ __neg__ = _func_op("negate")
+
+ # `and`, `or`, `not` cannot be overloaded in Python,
+ # so use bitwise operators as boolean operators
+ __and__ = _bin_op("and")
+ __or__ = _bin_op("or")
+ __invert__ = _func_op("not")
+ __rand__ = _bin_op("and")
+ __ror__ = _bin_op("or")
+
+ # bitwise operators
+ _bitwiseOR_doc = """
+ Compute bitwise OR of this expression with another expression.
+
+ Parameters
+ ----------
+ other
+ a value or :class:`Column` to calculate bitwise or(|) with
+ this :class:`Column`.
+
+ Examples
+ --------
+ >>> from pyspark.sql import Row
+ >>> df = spark.createDataFrame([Row(a=170, b=75)])
+ >>> df.select(df.a.bitwiseOR(df.b)).collect()
+ [Row((a | b)=235)]
+ """
+ _bitwiseAND_doc = """
+ Compute bitwise AND of this expression with another expression.
+
+ Parameters
+ ----------
+ other
+ a value or :class:`Column` to calculate bitwise and(&) with
+ this :class:`Column`.
+
+ Examples
+ --------
+ >>> from pyspark.sql import Row
+ >>> df = spark.createDataFrame([Row(a=170, b=75)])
+ >>> df.select(df.a.bitwiseAND(df.b)).collect()
+ [Row((a & b)=10)]
+ """
+ _bitwiseXOR_doc = """
+ Compute bitwise XOR of this expression with another expression.
+
+ Parameters
+ ----------
+ other
+ a value or :class:`Column` to calculate bitwise xor(^) with
+ this :class:`Column`.
+
+ Examples
+ --------
+ >>> from pyspark.sql import Row
+ >>> df = spark.createDataFrame([Row(a=170, b=75)])
+ >>> df.select(df.a.bitwiseXOR(df.b)).collect()
+ [Row((a ^ b)=225)]
+ """
+
+ bitwiseOR = _bin_op("bitwiseOR", _bitwiseOR_doc)
+ bitwiseAND = _bin_op("bitwiseAND", _bitwiseAND_doc)
+ bitwiseXOR = _bin_op("bitwiseXOR", _bitwiseXOR_doc)
+
+ # string methods
+ def contains(self, other: Union[PrimitiveType, "Column"]) -> "Column":
+ """
+ Contains the other element. Returns a boolean :class:`Column` based on a string match.
+
+ Parameters
+ ----------
+ other
+ string in line. A value as a literal or a :class:`Column`.
+
+ Examples
+ --------
+ >>> df = spark.createDataFrame(
+ ... [(2, "Alice"), (5, "Bob")], ["age", "name"])
+ >>> df.filter(df.name.contains('o')).collect()
+ [Row(age=5, name='Bob')]
+ """
+ return _bin_op("contains")(self, other)
+
+ def startswith(self, other: Union[PrimitiveType, "Column"]) -> "Column":
+ """
+ String starts with. Returns a boolean :class:`Column` based on a string match.
+
+ Parameters
+ ----------
+ other : :class:`Column` or str
+ string at start of line (do not use a regex `^`)
+
+ Examples
+ --------
+ >>> df = spark.createDataFrame(
+ ... [(2, "Alice"), (5, "Bob")], ["age", "name"])
+ >>> df.filter(df.name.startswith('Al')).collect()
+ [Row(age=2, name='Alice')]
+ >>> df.filter(df.name.startswith('^Al')).collect()
+ []
+ """
+ return _bin_op("startsWith")(self, other)
+
+ def endswith(self, other: Union[PrimitiveType, "Column"]) -> "Column":
+ """
+ String ends with. Returns a boolean :class:`Column` based on a string match.
+
+ Parameters
+ ----------
+ other : :class:`Column` or str
+ string at end of line (do not use a regex `$`)
+
+ Examples
+ --------
+ >>> df = spark.createDataFrame(
+ ... [(2, "Alice"), (5, "Bob")], ["age", "name"])
+ >>> df.filter(df.name.endswith('ice')).collect()
+ [Row(age=2, name='Alice')]
+ >>> df.filter(df.name.endswith('ice$')).collect()
+ []
+ """
+ return _bin_op("endsWith")(self, other)
+
+ def like(self: "Column", other: str) -> "Column":
+ """
+ SQL like expression. Returns a boolean :class:`Column` based on a SQL LIKE match.
+
+ Parameters
+ ----------
+ other : str
+ a SQL LIKE pattern
+ See Also
+ --------
+ pyspark.sql.Column.rlike
+ Returns
+ -------
+ :class:`Column`
+ Column of booleans showing whether each element
+ in the Column is matched by SQL LIKE pattern.
+
+ Examples
+ --------
+ >>> df = spark.createDataFrame(
+ ... [(2, "Alice"), (5, "Bob")], ["age", "name"])
+ >>> df.filter(df.name.like('Al%')).collect()
+ [Row(age=2, name='Alice')]
+ """
+ return _bin_op("like")(self, other)
+
+ def rlike(self: "Column", other: str) -> "Column":
+ """
+ SQL RLIKE expression (LIKE with Regex). Returns a boolean :class:`Column` based on a regex
+ match.
+
+ Parameters
+ ----------
+ other : str
+ an extended regex expression
+ Returns
+ -------
+ :class:`Column`
+ Column of booleans showing whether each element
+ in the Column is matched by extended regex expression.
+
+ Examples
+ --------
+ >>> df = spark.createDataFrame(
+ ... [(2, "Alice"), (5, "Bob")], ["age", "name"])
+ >>> df.filter(df.name.rlike('ice$')).collect()
+ [Row(age=2, name='Alice')]
+ """
+ return _bin_op("like")(self, other)
+
+ def ilike(self: "Column", other: str) -> "Column":
+ """
+ SQL ILIKE expression (case insensitive LIKE). Returns a boolean :class:`Column`
+ based on a case insensitive match.
+
+ Parameters
+ ----------
+ other : str
+ a SQL LIKE pattern
+ See Also
+ --------
+ pyspark.sql.Column.rlike
+ Returns
+ -------
+ :class:`Column`
+ Column of booleans showing whether each element
+ in the Column is matched by SQL LIKE pattern.
+
+ Examples
+ --------
+ >>> df = spark.createDataFrame(
+ ... [(2, "Alice"), (5, "Bob")], ["age", "name"])
+ >>> df.filter(df.name.ilike('%Ice')).collect()
+ [Row(age=2, name='Alice')]
+ """
+ return _bin_op("ilike")(self, other)
+
+ @overload
+ def substr(self, startPos: int, length: int) -> "Column":
+ ...
+
+ @overload
+ def substr(self, startPos: "Column", length: "Column") -> "Column":
+ ...
+
+ def substr(self, startPos: Union[int, "Column"], length: Union[int, "Column"]) -> "Column":
+ """
+ Return a :class:`Column` which is a substring of the column.
+
+ Parameters
+ ----------
+ startPos : :class:`Column` or int
+ start position
+ length : :class:`Column` or int
+ length of the substring
+ Returns
+ -------
+ :class:`Column`
+ Column representing whether each element of Column is substr of origin Column.
+
+ Examples
+ --------
+ >>> df = spark.createDataFrame(
+ ... [(2, "Alice"), (5, "Bob")], ["age", "name"])
+ >>> df.select(df.name.substr(1, 3).alias("col")).collect()
+ [Row(col='Ali'), Row(col='Bob')]
+ """
+ if type(startPos) != type(length):
+ raise TypeError(
+ "startPos and length must be the same type. "
+ "Got {startPos_t} and {length_t}, respectively.".format(
+ startPos_t=type(startPos),
+ length_t=type(length),
+ )
+ )
+ from pyspark.sql.connect.function_builder import functions as F
+
+ if isinstance(length, int):
+ length_exp = self._lit(length)
+ elif isinstance(length, Column):
+ length_exp = length
+ else:
+ raise TypeError("Unsupported type for substr().")
+
+ if isinstance(startPos, int):
+ start_exp = self._lit(startPos)
+ else:
+ start_exp = startPos
+
+ return F.substr(self, start_exp, length_exp)
def __eq__(self, other: Any) -> "Column": # type: ignore[override]
"""Returns a binary expression with the current column as the left
side and the other expression as the right side.
"""
- from pyspark.sql.connect._typing import PrimitiveType
Review Comment:
I guess revert this change can avoid circular import
--
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: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] amaliujia commented on a diff in pull request #38844: [SPARK-41328][CONNECT][PYTHON] Add logical and string API to Column
Posted by GitBox <gi...@apache.org>.
amaliujia commented on code in PR #38844:
URL: https://github.com/apache/spark/pull/38844#discussion_r1035508038
##########
python/pyspark/sql/connect/column.py:
##########
@@ -352,17 +365,326 @@ def __init__(self, expr: Expression) -> None:
__rpow__ = _bin_op("pow", reverse=True)
__ge__ = _bin_op(">=")
__le__ = _bin_op("<=")
- # __eq__ = _bin_op("==") # ignore [assignment]
+
+ _eqNullSafe_doc = """
+ Equality test that is safe for null values.
+
+ Parameters
+ ----------
+ other
+ a value or :class:`Column`
+
+ Examples
+ --------
+ >>> from pyspark.sql import Row
+ >>> df1 = spark.createDataFrame([
+ ... Row(id=1, value='foo'),
+ ... Row(id=2, value=None)
+ ... ])
+ >>> df1.select(
+ ... df1['value'] == 'foo',
+ ... df1['value'].eqNullSafe('foo'),
+ ... df1['value'].eqNullSafe(None)
+ ... ).show()
+ +-------------+---------------+----------------+
+ |(value = foo)|(value <=> foo)|(value <=> NULL)|
+ +-------------+---------------+----------------+
+ | true| true| false|
+ | null| false| true|
+ +-------------+---------------+----------------+
+ >>> df2 = spark.createDataFrame([
+ ... Row(value = 'bar'),
+ ... Row(value = None)
+ ... ])
+ >>> df1.join(df2, df1["value"] == df2["value"]).count()
+ 0
+ >>> df1.join(df2, df1["value"].eqNullSafe(df2["value"])).count()
+ 1
+ >>> df2 = spark.createDataFrame([
+ ... Row(id=1, value=float('NaN')),
+ ... Row(id=2, value=42.0),
+ ... Row(id=3, value=None)
+ ... ])
+ >>> df2.select(
+ ... df2['value'].eqNullSafe(None),
+ ... df2['value'].eqNullSafe(float('NaN')),
+ ... df2['value'].eqNullSafe(42.0)
+ ... ).show()
+ +----------------+---------------+----------------+
+ |(value <=> NULL)|(value <=> NaN)|(value <=> 42.0)|
+ +----------------+---------------+----------------+
+ | false| true| false|
+ | false| false| true|
+ | true| false| false|
+ +----------------+---------------+----------------+
+ Notes
+ -----
+ Unlike Pandas, PySpark doesn't consider NaN values to be NULL. See the
+ `NaN Semantics <https://spark.apache.org/docs/latest/sql-ref-datatypes.html#nan-semantics>`_
+ for details.
+ """
+ eqNullSafe = _bin_op("eqNullSafe", _eqNullSafe_doc)
+
+ __neg__ = _func_op("negate")
+
+ # `and`, `or`, `not` cannot be overloaded in Python,
+ # so use bitwise operators as boolean operators
+ __and__ = _bin_op("and")
+ __or__ = _bin_op("or")
+ __invert__ = _func_op("not")
+ __rand__ = _bin_op("and")
+ __ror__ = _bin_op("or")
+
+ # bitwise operators
+ _bitwiseOR_doc = """
+ Compute bitwise OR of this expression with another expression.
+
+ Parameters
+ ----------
+ other
+ a value or :class:`Column` to calculate bitwise or(|) with
+ this :class:`Column`.
+
+ Examples
+ --------
+ >>> from pyspark.sql import Row
+ >>> df = spark.createDataFrame([Row(a=170, b=75)])
+ >>> df.select(df.a.bitwiseOR(df.b)).collect()
+ [Row((a | b)=235)]
+ """
+ _bitwiseAND_doc = """
+ Compute bitwise AND of this expression with another expression.
+
+ Parameters
+ ----------
+ other
+ a value or :class:`Column` to calculate bitwise and(&) with
+ this :class:`Column`.
+
+ Examples
+ --------
+ >>> from pyspark.sql import Row
+ >>> df = spark.createDataFrame([Row(a=170, b=75)])
+ >>> df.select(df.a.bitwiseAND(df.b)).collect()
+ [Row((a & b)=10)]
+ """
+ _bitwiseXOR_doc = """
+ Compute bitwise XOR of this expression with another expression.
+
+ Parameters
+ ----------
+ other
+ a value or :class:`Column` to calculate bitwise xor(^) with
+ this :class:`Column`.
+
+ Examples
+ --------
+ >>> from pyspark.sql import Row
+ >>> df = spark.createDataFrame([Row(a=170, b=75)])
+ >>> df.select(df.a.bitwiseXOR(df.b)).collect()
+ [Row((a ^ b)=225)]
+ """
+
+ bitwiseOR = _bin_op("bitwiseOR", _bitwiseOR_doc)
+ bitwiseAND = _bin_op("bitwiseAND", _bitwiseAND_doc)
+ bitwiseXOR = _bin_op("bitwiseXOR", _bitwiseXOR_doc)
+
+ # string methods
+ def contains(self, other: Union[PrimitiveType, "Column"]) -> "Column":
+ """
+ Contains the other element. Returns a boolean :class:`Column` based on a string match.
+
+ Parameters
+ ----------
+ other
+ string in line. A value as a literal or a :class:`Column`.
+
+ Examples
+ --------
+ >>> df = spark.createDataFrame(
+ ... [(2, "Alice"), (5, "Bob")], ["age", "name"])
+ >>> df.filter(df.name.contains('o')).collect()
+ [Row(age=5, name='Bob')]
+ """
+ return _bin_op("contains")(self, other)
+
+ def startswith(self, other: Union[PrimitiveType, "Column"]) -> "Column":
+ """
+ String starts with. Returns a boolean :class:`Column` based on a string match.
+
+ Parameters
+ ----------
+ other : :class:`Column` or str
+ string at start of line (do not use a regex `^`)
+
+ Examples
+ --------
+ >>> df = spark.createDataFrame(
+ ... [(2, "Alice"), (5, "Bob")], ["age", "name"])
+ >>> df.filter(df.name.startswith('Al')).collect()
+ [Row(age=2, name='Alice')]
+ >>> df.filter(df.name.startswith('^Al')).collect()
+ []
+ """
+ return _bin_op("startsWith")(self, other)
+
+ def endswith(self, other: Union[PrimitiveType, "Column"]) -> "Column":
+ """
+ String ends with. Returns a boolean :class:`Column` based on a string match.
+
+ Parameters
+ ----------
+ other : :class:`Column` or str
+ string at end of line (do not use a regex `$`)
+
+ Examples
+ --------
+ >>> df = spark.createDataFrame(
+ ... [(2, "Alice"), (5, "Bob")], ["age", "name"])
+ >>> df.filter(df.name.endswith('ice')).collect()
+ [Row(age=2, name='Alice')]
+ >>> df.filter(df.name.endswith('ice$')).collect()
+ []
+ """
+ return _bin_op("endsWith")(self, other)
+
+ def like(self: "Column", other: str) -> "Column":
+ """
+ SQL like expression. Returns a boolean :class:`Column` based on a SQL LIKE match.
+
+ Parameters
+ ----------
+ other : str
+ a SQL LIKE pattern
+ See Also
+ --------
+ pyspark.sql.Column.rlike
+ Returns
+ -------
+ :class:`Column`
+ Column of booleans showing whether each element
+ in the Column is matched by SQL LIKE pattern.
+
+ Examples
+ --------
+ >>> df = spark.createDataFrame(
+ ... [(2, "Alice"), (5, "Bob")], ["age", "name"])
+ >>> df.filter(df.name.like('Al%')).collect()
+ [Row(age=2, name='Alice')]
+ """
+ return _bin_op("like")(self, other)
+
+ def rlike(self: "Column", other: str) -> "Column":
+ """
+ SQL RLIKE expression (LIKE with Regex). Returns a boolean :class:`Column` based on a regex
+ match.
+
+ Parameters
+ ----------
+ other : str
+ an extended regex expression
+ Returns
+ -------
+ :class:`Column`
+ Column of booleans showing whether each element
+ in the Column is matched by extended regex expression.
+
+ Examples
+ --------
+ >>> df = spark.createDataFrame(
+ ... [(2, "Alice"), (5, "Bob")], ["age", "name"])
+ >>> df.filter(df.name.rlike('ice$')).collect()
+ [Row(age=2, name='Alice')]
+ """
+ return _bin_op("like")(self, other)
+
+ def ilike(self: "Column", other: str) -> "Column":
+ """
+ SQL ILIKE expression (case insensitive LIKE). Returns a boolean :class:`Column`
+ based on a case insensitive match.
+
+ Parameters
+ ----------
+ other : str
+ a SQL LIKE pattern
+ See Also
+ --------
+ pyspark.sql.Column.rlike
+ Returns
+ -------
+ :class:`Column`
+ Column of booleans showing whether each element
+ in the Column is matched by SQL LIKE pattern.
+
+ Examples
+ --------
+ >>> df = spark.createDataFrame(
+ ... [(2, "Alice"), (5, "Bob")], ["age", "name"])
+ >>> df.filter(df.name.ilike('%Ice')).collect()
+ [Row(age=2, name='Alice')]
+ """
+ return _bin_op("ilike")(self, other)
+
+ @overload
+ def substr(self, startPos: int, length: int) -> "Column":
+ ...
+
+ @overload
+ def substr(self, startPos: "Column", length: "Column") -> "Column":
+ ...
+
+ def substr(self, startPos: Union[int, "Column"], length: Union[int, "Column"]) -> "Column":
+ """
+ Return a :class:`Column` which is a substring of the column.
+
+ Parameters
+ ----------
+ startPos : :class:`Column` or int
+ start position
+ length : :class:`Column` or int
+ length of the substring
+ Returns
+ -------
+ :class:`Column`
+ Column representing whether each element of Column is substr of origin Column.
+
+ Examples
+ --------
+ >>> df = spark.createDataFrame(
+ ... [(2, "Alice"), (5, "Bob")], ["age", "name"])
+ >>> df.select(df.name.substr(1, 3).alias("col")).collect()
+ [Row(col='Ali'), Row(col='Bob')]
+ """
+ if type(startPos) != type(length):
+ raise TypeError(
+ "startPos and length must be the same type. "
+ "Got {startPos_t} and {length_t}, respectively.".format(
+ startPos_t=type(startPos),
+ length_t=type(length),
+ )
+ )
+ from pyspark.sql.connect.function_builder import functions as F
+
+ if isinstance(length, int):
+ length_exp = self._lit(length)
+ elif isinstance(length, Column):
+ length_exp = length
+ else:
+ raise TypeError("Unsupported type for substr().")
+
+ if isinstance(startPos, int):
+ start_exp = self._lit(startPos)
+ else:
+ start_exp = startPos
+
+ return F.substr(self, start_exp, length_exp)
def __eq__(self, other: Any) -> "Column": # type: ignore[override]
"""Returns a binary expression with the current column as the left
side and the other expression as the right side.
"""
- from pyspark.sql.connect._typing import PrimitiveType
Review Comment:
I got something like this which actually is the case that code cannot run (so not only fail mypy check)
```
File "/Users/rui.wang/Documents/github/spark/python/pyspark/sql/connect/_typing.py", line 29, in <module>
from pyspark.sql.connect.column import ScalarFunctionExpression, Column
ImportError: cannot import name 'ScalarFunctionExpression' from partially initialized module 'pyspark.sql.connect.column' (most likely due to a circular import) (/Users/rui.wang/Documents/github/spark/python/pyspark/sql/connect/column.py)
```
--
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: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] amaliujia commented on a diff in pull request #38844: [SPARK-41328][CONNECT][PYTHON] Add logical and string API to Column
Posted by GitBox <gi...@apache.org>.
amaliujia commented on code in PR #38844:
URL: https://github.com/apache/spark/pull/38844#discussion_r1035473000
##########
python/pyspark/sql/connect/column.py:
##########
@@ -352,17 +365,332 @@ def __init__(self, expr: Expression) -> None:
__rpow__ = _bin_op("pow", reverse=True)
__ge__ = _bin_op(">=")
__le__ = _bin_op("<=")
- # __eq__ = _bin_op("==") # ignore [assignment]
+
+ _eqNullSafe_doc = """
+ Equality test that is safe for null values.
+
+ .. versionadded:: 2.3.0
Review Comment:
I chose to remove all `versionadded` from this PR.
Later we can go through all the places of Connect probably to remove `versionadded:: 3.4.0` but only have package level comment, given Connect is a new thing since 3.4.
--
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: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] HyukjinKwon commented on pull request #38844: [SPARK-41328][CONNECT][PYTHON] Add logical and string API to Column
Posted by GitBox <gi...@apache.org>.
HyukjinKwon commented on PR #38844:
URL: https://github.com/apache/spark/pull/38844#issuecomment-1331622275
Okay, I am gonna just merge this first. Let's address it in a followup.
--
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: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] HyukjinKwon commented on a diff in pull request #38844: [SPARK-41328][CONNECT][PYTHON] Add logical and string API to Column
Posted by GitBox <gi...@apache.org>.
HyukjinKwon commented on code in PR #38844:
URL: https://github.com/apache/spark/pull/38844#discussion_r1035441705
##########
python/pyspark/sql/connect/column.py:
##########
@@ -352,17 +365,307 @@ def __init__(self, expr: Expression) -> None:
__rpow__ = _bin_op("pow", reverse=True)
__ge__ = _bin_op(">=")
__le__ = _bin_op("<=")
- # __eq__ = _bin_op("==") # ignore [assignment]
+
+ _eqNullSafe_doc = """
+ Equality test that is safe for null values.
+ .. versionadded:: 2.3.0
+ Parameters
+ ----------
+ other
+ a value or :class:`Column`
+ Examples
+ --------
+ >>> from pyspark.sql import Row
+ >>> df1 = spark.createDataFrame([
+ ... Row(id=1, value='foo'),
+ ... Row(id=2, value=None)
+ ... ])
+ >>> df1.select(
+ ... df1['value'] == 'foo',
+ ... df1['value'].eqNullSafe('foo'),
+ ... df1['value'].eqNullSafe(None)
+ ... ).show()
+ +-------------+---------------+----------------+
+ |(value = foo)|(value <=> foo)|(value <=> NULL)|
+ +-------------+---------------+----------------+
+ | true| true| false|
+ | null| false| true|
+ +-------------+---------------+----------------+
+ >>> df2 = spark.createDataFrame([
+ ... Row(value = 'bar'),
+ ... Row(value = None)
+ ... ])
+ >>> df1.join(df2, df1["value"] == df2["value"]).count()
+ 0
+ >>> df1.join(df2, df1["value"].eqNullSafe(df2["value"])).count()
+ 1
+ >>> df2 = spark.createDataFrame([
+ ... Row(id=1, value=float('NaN')),
+ ... Row(id=2, value=42.0),
+ ... Row(id=3, value=None)
+ ... ])
+ >>> df2.select(
+ ... df2['value'].eqNullSafe(None),
+ ... df2['value'].eqNullSafe(float('NaN')),
+ ... df2['value'].eqNullSafe(42.0)
+ ... ).show()
+ +----------------+---------------+----------------+
+ |(value <=> NULL)|(value <=> NaN)|(value <=> 42.0)|
+ +----------------+---------------+----------------+
+ | false| true| false|
+ | false| false| true|
+ | true| false| false|
+ +----------------+---------------+----------------+
+ Notes
+ -----
+ Unlike Pandas, PySpark doesn't consider NaN values to be NULL. See the
+ `NaN Semantics <https://spark.apache.org/docs/latest/sql-ref-datatypes.html#nan-semantics>`_
+ for details.
+ """
+ eqNullSafe = _bin_op("eqNullSafe", _eqNullSafe_doc)
+
+ __neg__ = _func_op("negate")
+
+ # `and`, `or`, `not` cannot be overloaded in Python,
+ # so use bitwise operators as boolean operators
+ __and__ = _bin_op("and")
+ __or__ = _bin_op("or")
+ __invert__ = _func_op("not")
+ __rand__ = _bin_op("and")
+ __ror__ = _bin_op("or")
+
+ # bitwise operators
+ _bitwiseOR_doc = """
+ Compute bitwise OR of this expression with another expression.
+ Parameters
Review Comment:
ditto for spaces
--
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: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] amaliujia commented on a diff in pull request #38844: [SPARK-41328][CONNECT][PYTHON] Add logical and string API to Column
Posted by GitBox <gi...@apache.org>.
amaliujia commented on code in PR #38844:
URL: https://github.com/apache/spark/pull/38844#discussion_r1035472392
##########
python/pyspark/sql/connect/column.py:
##########
@@ -29,6 +29,17 @@
from pyspark.sql.connect.client import SparkConnectClient
import pyspark.sql.connect.proto as proto
+# TODO: solve the circular import between _typing and this class if we want to
Review Comment:
Created a JIRA and linked to TODO comments.
Will probably need to ask a Python expert to help on this topic....
--
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: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] zhengruifeng commented on a diff in pull request #38844: [SPARK-41328][CONNECT][PYTHON] Add logical and string API to Column
Posted by GitBox <gi...@apache.org>.
zhengruifeng commented on code in PR #38844:
URL: https://github.com/apache/spark/pull/38844#discussion_r1035502286
##########
python/pyspark/sql/connect/column.py:
##########
@@ -352,17 +365,326 @@ def __init__(self, expr: Expression) -> None:
__rpow__ = _bin_op("pow", reverse=True)
__ge__ = _bin_op(">=")
__le__ = _bin_op("<=")
- # __eq__ = _bin_op("==") # ignore [assignment]
+
+ _eqNullSafe_doc = """
+ Equality test that is safe for null values.
+
+ Parameters
+ ----------
+ other
+ a value or :class:`Column`
+
+ Examples
+ --------
+ >>> from pyspark.sql import Row
+ >>> df1 = spark.createDataFrame([
+ ... Row(id=1, value='foo'),
+ ... Row(id=2, value=None)
+ ... ])
+ >>> df1.select(
+ ... df1['value'] == 'foo',
+ ... df1['value'].eqNullSafe('foo'),
+ ... df1['value'].eqNullSafe(None)
+ ... ).show()
+ +-------------+---------------+----------------+
+ |(value = foo)|(value <=> foo)|(value <=> NULL)|
+ +-------------+---------------+----------------+
+ | true| true| false|
+ | null| false| true|
+ +-------------+---------------+----------------+
+ >>> df2 = spark.createDataFrame([
+ ... Row(value = 'bar'),
+ ... Row(value = None)
+ ... ])
+ >>> df1.join(df2, df1["value"] == df2["value"]).count()
+ 0
+ >>> df1.join(df2, df1["value"].eqNullSafe(df2["value"])).count()
+ 1
+ >>> df2 = spark.createDataFrame([
+ ... Row(id=1, value=float('NaN')),
+ ... Row(id=2, value=42.0),
+ ... Row(id=3, value=None)
+ ... ])
+ >>> df2.select(
+ ... df2['value'].eqNullSafe(None),
+ ... df2['value'].eqNullSafe(float('NaN')),
+ ... df2['value'].eqNullSafe(42.0)
+ ... ).show()
+ +----------------+---------------+----------------+
+ |(value <=> NULL)|(value <=> NaN)|(value <=> 42.0)|
+ +----------------+---------------+----------------+
+ | false| true| false|
+ | false| false| true|
+ | true| false| false|
+ +----------------+---------------+----------------+
+ Notes
+ -----
+ Unlike Pandas, PySpark doesn't consider NaN values to be NULL. See the
+ `NaN Semantics <https://spark.apache.org/docs/latest/sql-ref-datatypes.html#nan-semantics>`_
+ for details.
+ """
+ eqNullSafe = _bin_op("eqNullSafe", _eqNullSafe_doc)
+
+ __neg__ = _func_op("negate")
+
+ # `and`, `or`, `not` cannot be overloaded in Python,
+ # so use bitwise operators as boolean operators
+ __and__ = _bin_op("and")
+ __or__ = _bin_op("or")
+ __invert__ = _func_op("not")
+ __rand__ = _bin_op("and")
+ __ror__ = _bin_op("or")
+
+ # bitwise operators
+ _bitwiseOR_doc = """
+ Compute bitwise OR of this expression with another expression.
+
+ Parameters
+ ----------
+ other
+ a value or :class:`Column` to calculate bitwise or(|) with
+ this :class:`Column`.
+
+ Examples
+ --------
+ >>> from pyspark.sql import Row
+ >>> df = spark.createDataFrame([Row(a=170, b=75)])
+ >>> df.select(df.a.bitwiseOR(df.b)).collect()
+ [Row((a | b)=235)]
+ """
+ _bitwiseAND_doc = """
+ Compute bitwise AND of this expression with another expression.
+
+ Parameters
+ ----------
+ other
+ a value or :class:`Column` to calculate bitwise and(&) with
+ this :class:`Column`.
+
+ Examples
+ --------
+ >>> from pyspark.sql import Row
+ >>> df = spark.createDataFrame([Row(a=170, b=75)])
+ >>> df.select(df.a.bitwiseAND(df.b)).collect()
+ [Row((a & b)=10)]
+ """
+ _bitwiseXOR_doc = """
+ Compute bitwise XOR of this expression with another expression.
+
+ Parameters
+ ----------
+ other
+ a value or :class:`Column` to calculate bitwise xor(^) with
+ this :class:`Column`.
+
+ Examples
+ --------
+ >>> from pyspark.sql import Row
+ >>> df = spark.createDataFrame([Row(a=170, b=75)])
+ >>> df.select(df.a.bitwiseXOR(df.b)).collect()
+ [Row((a ^ b)=225)]
+ """
+
+ bitwiseOR = _bin_op("bitwiseOR", _bitwiseOR_doc)
+ bitwiseAND = _bin_op("bitwiseAND", _bitwiseAND_doc)
+ bitwiseXOR = _bin_op("bitwiseXOR", _bitwiseXOR_doc)
+
+ # string methods
+ def contains(self, other: Union[PrimitiveType, "Column"]) -> "Column":
+ """
+ Contains the other element. Returns a boolean :class:`Column` based on a string match.
+
+ Parameters
+ ----------
+ other
+ string in line. A value as a literal or a :class:`Column`.
+
+ Examples
+ --------
+ >>> df = spark.createDataFrame(
+ ... [(2, "Alice"), (5, "Bob")], ["age", "name"])
+ >>> df.filter(df.name.contains('o')).collect()
+ [Row(age=5, name='Bob')]
+ """
+ return _bin_op("contains")(self, other)
+
+ def startswith(self, other: Union[PrimitiveType, "Column"]) -> "Column":
+ """
+ String starts with. Returns a boolean :class:`Column` based on a string match.
+
+ Parameters
+ ----------
+ other : :class:`Column` or str
+ string at start of line (do not use a regex `^`)
+
+ Examples
+ --------
+ >>> df = spark.createDataFrame(
+ ... [(2, "Alice"), (5, "Bob")], ["age", "name"])
+ >>> df.filter(df.name.startswith('Al')).collect()
+ [Row(age=2, name='Alice')]
+ >>> df.filter(df.name.startswith('^Al')).collect()
+ []
+ """
+ return _bin_op("startsWith")(self, other)
+
+ def endswith(self, other: Union[PrimitiveType, "Column"]) -> "Column":
+ """
+ String ends with. Returns a boolean :class:`Column` based on a string match.
+
+ Parameters
+ ----------
+ other : :class:`Column` or str
+ string at end of line (do not use a regex `$`)
+
+ Examples
+ --------
+ >>> df = spark.createDataFrame(
+ ... [(2, "Alice"), (5, "Bob")], ["age", "name"])
+ >>> df.filter(df.name.endswith('ice')).collect()
+ [Row(age=2, name='Alice')]
+ >>> df.filter(df.name.endswith('ice$')).collect()
+ []
+ """
+ return _bin_op("endsWith")(self, other)
+
+ def like(self: "Column", other: str) -> "Column":
+ """
+ SQL like expression. Returns a boolean :class:`Column` based on a SQL LIKE match.
+
+ Parameters
+ ----------
+ other : str
+ a SQL LIKE pattern
+ See Also
+ --------
+ pyspark.sql.Column.rlike
+ Returns
+ -------
+ :class:`Column`
+ Column of booleans showing whether each element
+ in the Column is matched by SQL LIKE pattern.
+
+ Examples
+ --------
+ >>> df = spark.createDataFrame(
+ ... [(2, "Alice"), (5, "Bob")], ["age", "name"])
+ >>> df.filter(df.name.like('Al%')).collect()
+ [Row(age=2, name='Alice')]
+ """
+ return _bin_op("like")(self, other)
+
+ def rlike(self: "Column", other: str) -> "Column":
+ """
+ SQL RLIKE expression (LIKE with Regex). Returns a boolean :class:`Column` based on a regex
+ match.
+
+ Parameters
+ ----------
+ other : str
+ an extended regex expression
+ Returns
+ -------
+ :class:`Column`
+ Column of booleans showing whether each element
+ in the Column is matched by extended regex expression.
+
+ Examples
+ --------
+ >>> df = spark.createDataFrame(
+ ... [(2, "Alice"), (5, "Bob")], ["age", "name"])
+ >>> df.filter(df.name.rlike('ice$')).collect()
+ [Row(age=2, name='Alice')]
+ """
+ return _bin_op("like")(self, other)
+
+ def ilike(self: "Column", other: str) -> "Column":
+ """
+ SQL ILIKE expression (case insensitive LIKE). Returns a boolean :class:`Column`
+ based on a case insensitive match.
+
+ Parameters
+ ----------
+ other : str
+ a SQL LIKE pattern
+ See Also
+ --------
+ pyspark.sql.Column.rlike
+ Returns
+ -------
+ :class:`Column`
+ Column of booleans showing whether each element
+ in the Column is matched by SQL LIKE pattern.
+
+ Examples
+ --------
+ >>> df = spark.createDataFrame(
+ ... [(2, "Alice"), (5, "Bob")], ["age", "name"])
+ >>> df.filter(df.name.ilike('%Ice')).collect()
+ [Row(age=2, name='Alice')]
+ """
+ return _bin_op("ilike")(self, other)
+
+ @overload
+ def substr(self, startPos: int, length: int) -> "Column":
+ ...
+
+ @overload
+ def substr(self, startPos: "Column", length: "Column") -> "Column":
+ ...
+
+ def substr(self, startPos: Union[int, "Column"], length: Union[int, "Column"]) -> "Column":
+ """
+ Return a :class:`Column` which is a substring of the column.
+
+ Parameters
+ ----------
+ startPos : :class:`Column` or int
+ start position
+ length : :class:`Column` or int
+ length of the substring
+ Returns
+ -------
+ :class:`Column`
+ Column representing whether each element of Column is substr of origin Column.
+
+ Examples
+ --------
+ >>> df = spark.createDataFrame(
+ ... [(2, "Alice"), (5, "Bob")], ["age", "name"])
+ >>> df.select(df.name.substr(1, 3).alias("col")).collect()
+ [Row(col='Ali'), Row(col='Bob')]
+ """
+ if type(startPos) != type(length):
+ raise TypeError(
+ "startPos and length must be the same type. "
+ "Got {startPos_t} and {length_t}, respectively.".format(
+ startPos_t=type(startPos),
+ length_t=type(length),
+ )
+ )
+ from pyspark.sql.connect.function_builder import functions as F
+
+ if isinstance(length, int):
+ length_exp = self._lit(length)
+ elif isinstance(length, Column):
+ length_exp = length
+ else:
+ raise TypeError("Unsupported type for substr().")
+
+ if isinstance(startPos, int):
+ start_exp = self._lit(startPos)
+ else:
+ start_exp = startPos
+
+ return F.substr(self, start_exp, length_exp)
def __eq__(self, other: Any) -> "Column": # type: ignore[override]
"""Returns a binary expression with the current column as the left
side and the other expression as the right side.
"""
- from pyspark.sql.connect._typing import PrimitiveType
Review Comment:
normally, we put those things under:
```
if TYPE_CHECKING:
from pyspark.sql.connect._typing import PrimitiveType
```
then it will be ok for mypy.
The problem here is `get_args(PrimitiveType)` requires `_typing`. Maybe we can just use `(bool, float, int, str)` instead of `get_args(PrimitiveType)`
##########
python/pyspark/sql/connect/column.py:
##########
@@ -352,17 +365,326 @@ def __init__(self, expr: Expression) -> None:
__rpow__ = _bin_op("pow", reverse=True)
__ge__ = _bin_op(">=")
__le__ = _bin_op("<=")
- # __eq__ = _bin_op("==") # ignore [assignment]
+
+ _eqNullSafe_doc = """
+ Equality test that is safe for null values.
+
+ Parameters
+ ----------
+ other
+ a value or :class:`Column`
+
+ Examples
+ --------
+ >>> from pyspark.sql import Row
+ >>> df1 = spark.createDataFrame([
+ ... Row(id=1, value='foo'),
+ ... Row(id=2, value=None)
+ ... ])
+ >>> df1.select(
+ ... df1['value'] == 'foo',
+ ... df1['value'].eqNullSafe('foo'),
+ ... df1['value'].eqNullSafe(None)
+ ... ).show()
+ +-------------+---------------+----------------+
+ |(value = foo)|(value <=> foo)|(value <=> NULL)|
+ +-------------+---------------+----------------+
+ | true| true| false|
+ | null| false| true|
+ +-------------+---------------+----------------+
+ >>> df2 = spark.createDataFrame([
+ ... Row(value = 'bar'),
+ ... Row(value = None)
+ ... ])
+ >>> df1.join(df2, df1["value"] == df2["value"]).count()
+ 0
+ >>> df1.join(df2, df1["value"].eqNullSafe(df2["value"])).count()
+ 1
+ >>> df2 = spark.createDataFrame([
+ ... Row(id=1, value=float('NaN')),
+ ... Row(id=2, value=42.0),
+ ... Row(id=3, value=None)
+ ... ])
+ >>> df2.select(
+ ... df2['value'].eqNullSafe(None),
+ ... df2['value'].eqNullSafe(float('NaN')),
+ ... df2['value'].eqNullSafe(42.0)
+ ... ).show()
+ +----------------+---------------+----------------+
+ |(value <=> NULL)|(value <=> NaN)|(value <=> 42.0)|
+ +----------------+---------------+----------------+
+ | false| true| false|
+ | false| false| true|
+ | true| false| false|
+ +----------------+---------------+----------------+
+ Notes
+ -----
+ Unlike Pandas, PySpark doesn't consider NaN values to be NULL. See the
+ `NaN Semantics <https://spark.apache.org/docs/latest/sql-ref-datatypes.html#nan-semantics>`_
+ for details.
+ """
+ eqNullSafe = _bin_op("eqNullSafe", _eqNullSafe_doc)
+
+ __neg__ = _func_op("negate")
+
+ # `and`, `or`, `not` cannot be overloaded in Python,
+ # so use bitwise operators as boolean operators
+ __and__ = _bin_op("and")
+ __or__ = _bin_op("or")
+ __invert__ = _func_op("not")
+ __rand__ = _bin_op("and")
+ __ror__ = _bin_op("or")
+
+ # bitwise operators
+ _bitwiseOR_doc = """
+ Compute bitwise OR of this expression with another expression.
+
+ Parameters
+ ----------
+ other
+ a value or :class:`Column` to calculate bitwise or(|) with
+ this :class:`Column`.
+
+ Examples
+ --------
+ >>> from pyspark.sql import Row
+ >>> df = spark.createDataFrame([Row(a=170, b=75)])
+ >>> df.select(df.a.bitwiseOR(df.b)).collect()
+ [Row((a | b)=235)]
+ """
+ _bitwiseAND_doc = """
+ Compute bitwise AND of this expression with another expression.
+
+ Parameters
+ ----------
+ other
+ a value or :class:`Column` to calculate bitwise and(&) with
+ this :class:`Column`.
+
+ Examples
+ --------
+ >>> from pyspark.sql import Row
+ >>> df = spark.createDataFrame([Row(a=170, b=75)])
+ >>> df.select(df.a.bitwiseAND(df.b)).collect()
+ [Row((a & b)=10)]
+ """
+ _bitwiseXOR_doc = """
+ Compute bitwise XOR of this expression with another expression.
+
+ Parameters
+ ----------
+ other
+ a value or :class:`Column` to calculate bitwise xor(^) with
+ this :class:`Column`.
+
+ Examples
+ --------
+ >>> from pyspark.sql import Row
+ >>> df = spark.createDataFrame([Row(a=170, b=75)])
+ >>> df.select(df.a.bitwiseXOR(df.b)).collect()
+ [Row((a ^ b)=225)]
+ """
+
+ bitwiseOR = _bin_op("bitwiseOR", _bitwiseOR_doc)
+ bitwiseAND = _bin_op("bitwiseAND", _bitwiseAND_doc)
+ bitwiseXOR = _bin_op("bitwiseXOR", _bitwiseXOR_doc)
+
+ # string methods
+ def contains(self, other: Union[PrimitiveType, "Column"]) -> "Column":
+ """
+ Contains the other element. Returns a boolean :class:`Column` based on a string match.
+
+ Parameters
+ ----------
+ other
+ string in line. A value as a literal or a :class:`Column`.
+
+ Examples
+ --------
+ >>> df = spark.createDataFrame(
+ ... [(2, "Alice"), (5, "Bob")], ["age", "name"])
+ >>> df.filter(df.name.contains('o')).collect()
+ [Row(age=5, name='Bob')]
+ """
+ return _bin_op("contains")(self, other)
+
+ def startswith(self, other: Union[PrimitiveType, "Column"]) -> "Column":
+ """
+ String starts with. Returns a boolean :class:`Column` based on a string match.
+
+ Parameters
+ ----------
+ other : :class:`Column` or str
+ string at start of line (do not use a regex `^`)
+
+ Examples
+ --------
+ >>> df = spark.createDataFrame(
+ ... [(2, "Alice"), (5, "Bob")], ["age", "name"])
+ >>> df.filter(df.name.startswith('Al')).collect()
+ [Row(age=2, name='Alice')]
+ >>> df.filter(df.name.startswith('^Al')).collect()
+ []
+ """
+ return _bin_op("startsWith")(self, other)
+
+ def endswith(self, other: Union[PrimitiveType, "Column"]) -> "Column":
+ """
+ String ends with. Returns a boolean :class:`Column` based on a string match.
+
+ Parameters
+ ----------
+ other : :class:`Column` or str
+ string at end of line (do not use a regex `$`)
+
+ Examples
+ --------
+ >>> df = spark.createDataFrame(
+ ... [(2, "Alice"), (5, "Bob")], ["age", "name"])
+ >>> df.filter(df.name.endswith('ice')).collect()
+ [Row(age=2, name='Alice')]
+ >>> df.filter(df.name.endswith('ice$')).collect()
+ []
+ """
+ return _bin_op("endsWith")(self, other)
+
+ def like(self: "Column", other: str) -> "Column":
+ """
+ SQL like expression. Returns a boolean :class:`Column` based on a SQL LIKE match.
+
+ Parameters
+ ----------
+ other : str
+ a SQL LIKE pattern
+ See Also
+ --------
+ pyspark.sql.Column.rlike
+ Returns
+ -------
+ :class:`Column`
+ Column of booleans showing whether each element
+ in the Column is matched by SQL LIKE pattern.
+
+ Examples
+ --------
+ >>> df = spark.createDataFrame(
+ ... [(2, "Alice"), (5, "Bob")], ["age", "name"])
+ >>> df.filter(df.name.like('Al%')).collect()
+ [Row(age=2, name='Alice')]
+ """
+ return _bin_op("like")(self, other)
+
+ def rlike(self: "Column", other: str) -> "Column":
+ """
+ SQL RLIKE expression (LIKE with Regex). Returns a boolean :class:`Column` based on a regex
+ match.
+
+ Parameters
+ ----------
+ other : str
+ an extended regex expression
+ Returns
+ -------
+ :class:`Column`
+ Column of booleans showing whether each element
+ in the Column is matched by extended regex expression.
+
+ Examples
+ --------
+ >>> df = spark.createDataFrame(
+ ... [(2, "Alice"), (5, "Bob")], ["age", "name"])
+ >>> df.filter(df.name.rlike('ice$')).collect()
+ [Row(age=2, name='Alice')]
+ """
+ return _bin_op("like")(self, other)
+
+ def ilike(self: "Column", other: str) -> "Column":
+ """
+ SQL ILIKE expression (case insensitive LIKE). Returns a boolean :class:`Column`
+ based on a case insensitive match.
+
+ Parameters
+ ----------
+ other : str
+ a SQL LIKE pattern
+ See Also
+ --------
+ pyspark.sql.Column.rlike
+ Returns
+ -------
+ :class:`Column`
+ Column of booleans showing whether each element
+ in the Column is matched by SQL LIKE pattern.
+
+ Examples
+ --------
+ >>> df = spark.createDataFrame(
+ ... [(2, "Alice"), (5, "Bob")], ["age", "name"])
+ >>> df.filter(df.name.ilike('%Ice')).collect()
+ [Row(age=2, name='Alice')]
+ """
+ return _bin_op("ilike")(self, other)
+
+ @overload
+ def substr(self, startPos: int, length: int) -> "Column":
+ ...
+
+ @overload
+ def substr(self, startPos: "Column", length: "Column") -> "Column":
+ ...
+
+ def substr(self, startPos: Union[int, "Column"], length: Union[int, "Column"]) -> "Column":
+ """
+ Return a :class:`Column` which is a substring of the column.
+
+ Parameters
+ ----------
+ startPos : :class:`Column` or int
+ start position
+ length : :class:`Column` or int
+ length of the substring
+ Returns
+ -------
+ :class:`Column`
+ Column representing whether each element of Column is substr of origin Column.
+
+ Examples
+ --------
+ >>> df = spark.createDataFrame(
+ ... [(2, "Alice"), (5, "Bob")], ["age", "name"])
+ >>> df.select(df.name.substr(1, 3).alias("col")).collect()
+ [Row(col='Ali'), Row(col='Bob')]
+ """
+ if type(startPos) != type(length):
+ raise TypeError(
+ "startPos and length must be the same type. "
+ "Got {startPos_t} and {length_t}, respectively.".format(
+ startPos_t=type(startPos),
+ length_t=type(length),
+ )
+ )
+ from pyspark.sql.connect.function_builder import functions as F
+
+ if isinstance(length, int):
+ length_exp = self._lit(length)
+ elif isinstance(length, Column):
+ length_exp = length
+ else:
+ raise TypeError("Unsupported type for substr().")
+
+ if isinstance(startPos, int):
+ start_exp = self._lit(startPos)
+ else:
+ start_exp = startPos
+
+ return F.substr(self, start_exp, length_exp)
def __eq__(self, other: Any) -> "Column": # type: ignore[override]
"""Returns a binary expression with the current column as the left
side and the other expression as the right side.
"""
- from pyspark.sql.connect._typing import PrimitiveType
Review Comment:
cc @HyukjinKwon
--
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: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] amaliujia commented on a diff in pull request #38844: [SPARK-41328][CONNECT][PYTHON] Add logical and string API to Column
Posted by GitBox <gi...@apache.org>.
amaliujia commented on code in PR #38844:
URL: https://github.com/apache/spark/pull/38844#discussion_r1035490664
##########
python/pyspark/sql/connect/column.py:
##########
@@ -352,17 +365,326 @@ def __init__(self, expr: Expression) -> None:
__rpow__ = _bin_op("pow", reverse=True)
__ge__ = _bin_op(">=")
__le__ = _bin_op("<=")
- # __eq__ = _bin_op("==") # ignore [assignment]
+
+ _eqNullSafe_doc = """
+ Equality test that is safe for null values.
+
+ Parameters
+ ----------
+ other
+ a value or :class:`Column`
+
+ Examples
+ --------
+ >>> from pyspark.sql import Row
+ >>> df1 = spark.createDataFrame([
+ ... Row(id=1, value='foo'),
+ ... Row(id=2, value=None)
+ ... ])
+ >>> df1.select(
+ ... df1['value'] == 'foo',
+ ... df1['value'].eqNullSafe('foo'),
+ ... df1['value'].eqNullSafe(None)
+ ... ).show()
+ +-------------+---------------+----------------+
+ |(value = foo)|(value <=> foo)|(value <=> NULL)|
+ +-------------+---------------+----------------+
+ | true| true| false|
+ | null| false| true|
+ +-------------+---------------+----------------+
+ >>> df2 = spark.createDataFrame([
+ ... Row(value = 'bar'),
+ ... Row(value = None)
+ ... ])
+ >>> df1.join(df2, df1["value"] == df2["value"]).count()
+ 0
+ >>> df1.join(df2, df1["value"].eqNullSafe(df2["value"])).count()
+ 1
+ >>> df2 = spark.createDataFrame([
+ ... Row(id=1, value=float('NaN')),
+ ... Row(id=2, value=42.0),
+ ... Row(id=3, value=None)
+ ... ])
+ >>> df2.select(
+ ... df2['value'].eqNullSafe(None),
+ ... df2['value'].eqNullSafe(float('NaN')),
+ ... df2['value'].eqNullSafe(42.0)
+ ... ).show()
+ +----------------+---------------+----------------+
+ |(value <=> NULL)|(value <=> NaN)|(value <=> 42.0)|
+ +----------------+---------------+----------------+
+ | false| true| false|
+ | false| false| true|
+ | true| false| false|
+ +----------------+---------------+----------------+
+ Notes
+ -----
+ Unlike Pandas, PySpark doesn't consider NaN values to be NULL. See the
+ `NaN Semantics <https://spark.apache.org/docs/latest/sql-ref-datatypes.html#nan-semantics>`_
+ for details.
+ """
+ eqNullSafe = _bin_op("eqNullSafe", _eqNullSafe_doc)
+
+ __neg__ = _func_op("negate")
+
+ # `and`, `or`, `not` cannot be overloaded in Python,
+ # so use bitwise operators as boolean operators
+ __and__ = _bin_op("and")
+ __or__ = _bin_op("or")
+ __invert__ = _func_op("not")
+ __rand__ = _bin_op("and")
+ __ror__ = _bin_op("or")
+
+ # bitwise operators
+ _bitwiseOR_doc = """
+ Compute bitwise OR of this expression with another expression.
+
+ Parameters
+ ----------
+ other
+ a value or :class:`Column` to calculate bitwise or(|) with
+ this :class:`Column`.
+
+ Examples
+ --------
+ >>> from pyspark.sql import Row
+ >>> df = spark.createDataFrame([Row(a=170, b=75)])
+ >>> df.select(df.a.bitwiseOR(df.b)).collect()
+ [Row((a | b)=235)]
+ """
+ _bitwiseAND_doc = """
+ Compute bitwise AND of this expression with another expression.
+
+ Parameters
+ ----------
+ other
+ a value or :class:`Column` to calculate bitwise and(&) with
+ this :class:`Column`.
+
+ Examples
+ --------
+ >>> from pyspark.sql import Row
+ >>> df = spark.createDataFrame([Row(a=170, b=75)])
+ >>> df.select(df.a.bitwiseAND(df.b)).collect()
+ [Row((a & b)=10)]
+ """
+ _bitwiseXOR_doc = """
+ Compute bitwise XOR of this expression with another expression.
+
+ Parameters
+ ----------
+ other
+ a value or :class:`Column` to calculate bitwise xor(^) with
+ this :class:`Column`.
+
+ Examples
+ --------
+ >>> from pyspark.sql import Row
+ >>> df = spark.createDataFrame([Row(a=170, b=75)])
+ >>> df.select(df.a.bitwiseXOR(df.b)).collect()
+ [Row((a ^ b)=225)]
+ """
+
+ bitwiseOR = _bin_op("bitwiseOR", _bitwiseOR_doc)
+ bitwiseAND = _bin_op("bitwiseAND", _bitwiseAND_doc)
+ bitwiseXOR = _bin_op("bitwiseXOR", _bitwiseXOR_doc)
+
+ # string methods
+ def contains(self, other: Union[PrimitiveType, "Column"]) -> "Column":
+ """
+ Contains the other element. Returns a boolean :class:`Column` based on a string match.
+
+ Parameters
+ ----------
+ other
+ string in line. A value as a literal or a :class:`Column`.
+
+ Examples
+ --------
+ >>> df = spark.createDataFrame(
+ ... [(2, "Alice"), (5, "Bob")], ["age", "name"])
+ >>> df.filter(df.name.contains('o')).collect()
+ [Row(age=5, name='Bob')]
+ """
+ return _bin_op("contains")(self, other)
+
+ def startswith(self, other: Union[PrimitiveType, "Column"]) -> "Column":
+ """
+ String starts with. Returns a boolean :class:`Column` based on a string match.
+
+ Parameters
+ ----------
+ other : :class:`Column` or str
+ string at start of line (do not use a regex `^`)
+
+ Examples
+ --------
+ >>> df = spark.createDataFrame(
+ ... [(2, "Alice"), (5, "Bob")], ["age", "name"])
+ >>> df.filter(df.name.startswith('Al')).collect()
+ [Row(age=2, name='Alice')]
+ >>> df.filter(df.name.startswith('^Al')).collect()
+ []
+ """
+ return _bin_op("startsWith")(self, other)
+
+ def endswith(self, other: Union[PrimitiveType, "Column"]) -> "Column":
+ """
+ String ends with. Returns a boolean :class:`Column` based on a string match.
+
+ Parameters
+ ----------
+ other : :class:`Column` or str
+ string at end of line (do not use a regex `$`)
+
+ Examples
+ --------
+ >>> df = spark.createDataFrame(
+ ... [(2, "Alice"), (5, "Bob")], ["age", "name"])
+ >>> df.filter(df.name.endswith('ice')).collect()
+ [Row(age=2, name='Alice')]
+ >>> df.filter(df.name.endswith('ice$')).collect()
+ []
+ """
+ return _bin_op("endsWith")(self, other)
+
+ def like(self: "Column", other: str) -> "Column":
+ """
+ SQL like expression. Returns a boolean :class:`Column` based on a SQL LIKE match.
+
+ Parameters
+ ----------
+ other : str
+ a SQL LIKE pattern
+ See Also
+ --------
+ pyspark.sql.Column.rlike
+ Returns
+ -------
+ :class:`Column`
+ Column of booleans showing whether each element
+ in the Column is matched by SQL LIKE pattern.
+
+ Examples
+ --------
+ >>> df = spark.createDataFrame(
+ ... [(2, "Alice"), (5, "Bob")], ["age", "name"])
+ >>> df.filter(df.name.like('Al%')).collect()
+ [Row(age=2, name='Alice')]
+ """
+ return _bin_op("like")(self, other)
+
+ def rlike(self: "Column", other: str) -> "Column":
+ """
+ SQL RLIKE expression (LIKE with Regex). Returns a boolean :class:`Column` based on a regex
+ match.
+
+ Parameters
+ ----------
+ other : str
+ an extended regex expression
+ Returns
+ -------
+ :class:`Column`
+ Column of booleans showing whether each element
+ in the Column is matched by extended regex expression.
+
+ Examples
+ --------
+ >>> df = spark.createDataFrame(
+ ... [(2, "Alice"), (5, "Bob")], ["age", "name"])
+ >>> df.filter(df.name.rlike('ice$')).collect()
+ [Row(age=2, name='Alice')]
+ """
+ return _bin_op("like")(self, other)
+
+ def ilike(self: "Column", other: str) -> "Column":
+ """
+ SQL ILIKE expression (case insensitive LIKE). Returns a boolean :class:`Column`
+ based on a case insensitive match.
+
+ Parameters
+ ----------
+ other : str
+ a SQL LIKE pattern
+ See Also
+ --------
+ pyspark.sql.Column.rlike
+ Returns
+ -------
+ :class:`Column`
+ Column of booleans showing whether each element
+ in the Column is matched by SQL LIKE pattern.
+
+ Examples
+ --------
+ >>> df = spark.createDataFrame(
+ ... [(2, "Alice"), (5, "Bob")], ["age", "name"])
+ >>> df.filter(df.name.ilike('%Ice')).collect()
+ [Row(age=2, name='Alice')]
+ """
+ return _bin_op("ilike")(self, other)
+
+ @overload
+ def substr(self, startPos: int, length: int) -> "Column":
+ ...
+
+ @overload
+ def substr(self, startPos: "Column", length: "Column") -> "Column":
+ ...
+
+ def substr(self, startPos: Union[int, "Column"], length: Union[int, "Column"]) -> "Column":
+ """
+ Return a :class:`Column` which is a substring of the column.
+
+ Parameters
+ ----------
+ startPos : :class:`Column` or int
+ start position
+ length : :class:`Column` or int
+ length of the substring
+ Returns
+ -------
+ :class:`Column`
+ Column representing whether each element of Column is substr of origin Column.
+
+ Examples
+ --------
+ >>> df = spark.createDataFrame(
+ ... [(2, "Alice"), (5, "Bob")], ["age", "name"])
+ >>> df.select(df.name.substr(1, 3).alias("col")).collect()
+ [Row(col='Ali'), Row(col='Bob')]
+ """
+ if type(startPos) != type(length):
+ raise TypeError(
+ "startPos and length must be the same type. "
+ "Got {startPos_t} and {length_t}, respectively.".format(
+ startPos_t=type(startPos),
+ length_t=type(length),
+ )
+ )
+ from pyspark.sql.connect.function_builder import functions as F
+
+ if isinstance(length, int):
+ length_exp = self._lit(length)
+ elif isinstance(length, Column):
+ length_exp = length
+ else:
+ raise TypeError("Unsupported type for substr().")
+
+ if isinstance(startPos, int):
+ start_exp = self._lit(startPos)
+ else:
+ start_exp = startPos
+
+ return F.substr(self, start_exp, length_exp)
def __eq__(self, other: Any) -> "Column": # type: ignore[override]
"""Returns a binary expression with the current column as the left
side and the other expression as the right side.
"""
- from pyspark.sql.connect._typing import PrimitiveType
Review Comment:
I am pretty it does not solve the root problem...
If you can column.py, _typing.py and functions.py, you could see that _typing.py and functions.py uses `Column`, then whenever `column.py` wants to include anything from that two classes, it become circular import
--
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: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] amaliujia commented on a diff in pull request #38844: [SPARK-41328][CONNECT][PYTHON] Add logical and string API to Column
Posted by GitBox <gi...@apache.org>.
amaliujia commented on code in PR #38844:
URL: https://github.com/apache/spark/pull/38844#discussion_r1035490664
##########
python/pyspark/sql/connect/column.py:
##########
@@ -352,17 +365,326 @@ def __init__(self, expr: Expression) -> None:
__rpow__ = _bin_op("pow", reverse=True)
__ge__ = _bin_op(">=")
__le__ = _bin_op("<=")
- # __eq__ = _bin_op("==") # ignore [assignment]
+
+ _eqNullSafe_doc = """
+ Equality test that is safe for null values.
+
+ Parameters
+ ----------
+ other
+ a value or :class:`Column`
+
+ Examples
+ --------
+ >>> from pyspark.sql import Row
+ >>> df1 = spark.createDataFrame([
+ ... Row(id=1, value='foo'),
+ ... Row(id=2, value=None)
+ ... ])
+ >>> df1.select(
+ ... df1['value'] == 'foo',
+ ... df1['value'].eqNullSafe('foo'),
+ ... df1['value'].eqNullSafe(None)
+ ... ).show()
+ +-------------+---------------+----------------+
+ |(value = foo)|(value <=> foo)|(value <=> NULL)|
+ +-------------+---------------+----------------+
+ | true| true| false|
+ | null| false| true|
+ +-------------+---------------+----------------+
+ >>> df2 = spark.createDataFrame([
+ ... Row(value = 'bar'),
+ ... Row(value = None)
+ ... ])
+ >>> df1.join(df2, df1["value"] == df2["value"]).count()
+ 0
+ >>> df1.join(df2, df1["value"].eqNullSafe(df2["value"])).count()
+ 1
+ >>> df2 = spark.createDataFrame([
+ ... Row(id=1, value=float('NaN')),
+ ... Row(id=2, value=42.0),
+ ... Row(id=3, value=None)
+ ... ])
+ >>> df2.select(
+ ... df2['value'].eqNullSafe(None),
+ ... df2['value'].eqNullSafe(float('NaN')),
+ ... df2['value'].eqNullSafe(42.0)
+ ... ).show()
+ +----------------+---------------+----------------+
+ |(value <=> NULL)|(value <=> NaN)|(value <=> 42.0)|
+ +----------------+---------------+----------------+
+ | false| true| false|
+ | false| false| true|
+ | true| false| false|
+ +----------------+---------------+----------------+
+ Notes
+ -----
+ Unlike Pandas, PySpark doesn't consider NaN values to be NULL. See the
+ `NaN Semantics <https://spark.apache.org/docs/latest/sql-ref-datatypes.html#nan-semantics>`_
+ for details.
+ """
+ eqNullSafe = _bin_op("eqNullSafe", _eqNullSafe_doc)
+
+ __neg__ = _func_op("negate")
+
+ # `and`, `or`, `not` cannot be overloaded in Python,
+ # so use bitwise operators as boolean operators
+ __and__ = _bin_op("and")
+ __or__ = _bin_op("or")
+ __invert__ = _func_op("not")
+ __rand__ = _bin_op("and")
+ __ror__ = _bin_op("or")
+
+ # bitwise operators
+ _bitwiseOR_doc = """
+ Compute bitwise OR of this expression with another expression.
+
+ Parameters
+ ----------
+ other
+ a value or :class:`Column` to calculate bitwise or(|) with
+ this :class:`Column`.
+
+ Examples
+ --------
+ >>> from pyspark.sql import Row
+ >>> df = spark.createDataFrame([Row(a=170, b=75)])
+ >>> df.select(df.a.bitwiseOR(df.b)).collect()
+ [Row((a | b)=235)]
+ """
+ _bitwiseAND_doc = """
+ Compute bitwise AND of this expression with another expression.
+
+ Parameters
+ ----------
+ other
+ a value or :class:`Column` to calculate bitwise and(&) with
+ this :class:`Column`.
+
+ Examples
+ --------
+ >>> from pyspark.sql import Row
+ >>> df = spark.createDataFrame([Row(a=170, b=75)])
+ >>> df.select(df.a.bitwiseAND(df.b)).collect()
+ [Row((a & b)=10)]
+ """
+ _bitwiseXOR_doc = """
+ Compute bitwise XOR of this expression with another expression.
+
+ Parameters
+ ----------
+ other
+ a value or :class:`Column` to calculate bitwise xor(^) with
+ this :class:`Column`.
+
+ Examples
+ --------
+ >>> from pyspark.sql import Row
+ >>> df = spark.createDataFrame([Row(a=170, b=75)])
+ >>> df.select(df.a.bitwiseXOR(df.b)).collect()
+ [Row((a ^ b)=225)]
+ """
+
+ bitwiseOR = _bin_op("bitwiseOR", _bitwiseOR_doc)
+ bitwiseAND = _bin_op("bitwiseAND", _bitwiseAND_doc)
+ bitwiseXOR = _bin_op("bitwiseXOR", _bitwiseXOR_doc)
+
+ # string methods
+ def contains(self, other: Union[PrimitiveType, "Column"]) -> "Column":
+ """
+ Contains the other element. Returns a boolean :class:`Column` based on a string match.
+
+ Parameters
+ ----------
+ other
+ string in line. A value as a literal or a :class:`Column`.
+
+ Examples
+ --------
+ >>> df = spark.createDataFrame(
+ ... [(2, "Alice"), (5, "Bob")], ["age", "name"])
+ >>> df.filter(df.name.contains('o')).collect()
+ [Row(age=5, name='Bob')]
+ """
+ return _bin_op("contains")(self, other)
+
+ def startswith(self, other: Union[PrimitiveType, "Column"]) -> "Column":
+ """
+ String starts with. Returns a boolean :class:`Column` based on a string match.
+
+ Parameters
+ ----------
+ other : :class:`Column` or str
+ string at start of line (do not use a regex `^`)
+
+ Examples
+ --------
+ >>> df = spark.createDataFrame(
+ ... [(2, "Alice"), (5, "Bob")], ["age", "name"])
+ >>> df.filter(df.name.startswith('Al')).collect()
+ [Row(age=2, name='Alice')]
+ >>> df.filter(df.name.startswith('^Al')).collect()
+ []
+ """
+ return _bin_op("startsWith")(self, other)
+
+ def endswith(self, other: Union[PrimitiveType, "Column"]) -> "Column":
+ """
+ String ends with. Returns a boolean :class:`Column` based on a string match.
+
+ Parameters
+ ----------
+ other : :class:`Column` or str
+ string at end of line (do not use a regex `$`)
+
+ Examples
+ --------
+ >>> df = spark.createDataFrame(
+ ... [(2, "Alice"), (5, "Bob")], ["age", "name"])
+ >>> df.filter(df.name.endswith('ice')).collect()
+ [Row(age=2, name='Alice')]
+ >>> df.filter(df.name.endswith('ice$')).collect()
+ []
+ """
+ return _bin_op("endsWith")(self, other)
+
+ def like(self: "Column", other: str) -> "Column":
+ """
+ SQL like expression. Returns a boolean :class:`Column` based on a SQL LIKE match.
+
+ Parameters
+ ----------
+ other : str
+ a SQL LIKE pattern
+ See Also
+ --------
+ pyspark.sql.Column.rlike
+ Returns
+ -------
+ :class:`Column`
+ Column of booleans showing whether each element
+ in the Column is matched by SQL LIKE pattern.
+
+ Examples
+ --------
+ >>> df = spark.createDataFrame(
+ ... [(2, "Alice"), (5, "Bob")], ["age", "name"])
+ >>> df.filter(df.name.like('Al%')).collect()
+ [Row(age=2, name='Alice')]
+ """
+ return _bin_op("like")(self, other)
+
+ def rlike(self: "Column", other: str) -> "Column":
+ """
+ SQL RLIKE expression (LIKE with Regex). Returns a boolean :class:`Column` based on a regex
+ match.
+
+ Parameters
+ ----------
+ other : str
+ an extended regex expression
+ Returns
+ -------
+ :class:`Column`
+ Column of booleans showing whether each element
+ in the Column is matched by extended regex expression.
+
+ Examples
+ --------
+ >>> df = spark.createDataFrame(
+ ... [(2, "Alice"), (5, "Bob")], ["age", "name"])
+ >>> df.filter(df.name.rlike('ice$')).collect()
+ [Row(age=2, name='Alice')]
+ """
+ return _bin_op("like")(self, other)
+
+ def ilike(self: "Column", other: str) -> "Column":
+ """
+ SQL ILIKE expression (case insensitive LIKE). Returns a boolean :class:`Column`
+ based on a case insensitive match.
+
+ Parameters
+ ----------
+ other : str
+ a SQL LIKE pattern
+ See Also
+ --------
+ pyspark.sql.Column.rlike
+ Returns
+ -------
+ :class:`Column`
+ Column of booleans showing whether each element
+ in the Column is matched by SQL LIKE pattern.
+
+ Examples
+ --------
+ >>> df = spark.createDataFrame(
+ ... [(2, "Alice"), (5, "Bob")], ["age", "name"])
+ >>> df.filter(df.name.ilike('%Ice')).collect()
+ [Row(age=2, name='Alice')]
+ """
+ return _bin_op("ilike")(self, other)
+
+ @overload
+ def substr(self, startPos: int, length: int) -> "Column":
+ ...
+
+ @overload
+ def substr(self, startPos: "Column", length: "Column") -> "Column":
+ ...
+
+ def substr(self, startPos: Union[int, "Column"], length: Union[int, "Column"]) -> "Column":
+ """
+ Return a :class:`Column` which is a substring of the column.
+
+ Parameters
+ ----------
+ startPos : :class:`Column` or int
+ start position
+ length : :class:`Column` or int
+ length of the substring
+ Returns
+ -------
+ :class:`Column`
+ Column representing whether each element of Column is substr of origin Column.
+
+ Examples
+ --------
+ >>> df = spark.createDataFrame(
+ ... [(2, "Alice"), (5, "Bob")], ["age", "name"])
+ >>> df.select(df.name.substr(1, 3).alias("col")).collect()
+ [Row(col='Ali'), Row(col='Bob')]
+ """
+ if type(startPos) != type(length):
+ raise TypeError(
+ "startPos and length must be the same type. "
+ "Got {startPos_t} and {length_t}, respectively.".format(
+ startPos_t=type(startPos),
+ length_t=type(length),
+ )
+ )
+ from pyspark.sql.connect.function_builder import functions as F
+
+ if isinstance(length, int):
+ length_exp = self._lit(length)
+ elif isinstance(length, Column):
+ length_exp = length
+ else:
+ raise TypeError("Unsupported type for substr().")
+
+ if isinstance(startPos, int):
+ start_exp = self._lit(startPos)
+ else:
+ start_exp = startPos
+
+ return F.substr(self, start_exp, length_exp)
def __eq__(self, other: Any) -> "Column": # type: ignore[override]
"""Returns a binary expression with the current column as the left
side and the other expression as the right side.
"""
- from pyspark.sql.connect._typing import PrimitiveType
Review Comment:
I am pretty sure it does not solve the root problem...
If you can column.py, _typing.py and functions.py, you could see that _typing.py and functions.py uses `Column`, then whenever `column.py` wants to include anything from that two classes, it become circular import
--
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: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] HyukjinKwon commented on pull request #38844: [SPARK-41328][CONNECT][PYTHON] Add logical and string API to Column
Posted by GitBox <gi...@apache.org>.
HyukjinKwon commented on PR #38844:
URL: https://github.com/apache/spark/pull/38844#issuecomment-1331622389
Merged to master.
--
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: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org