tobiasedwards opened a new pull request #33428:
URL: https://github.com/apache/spark/pull/33428
<!--
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.
-->
This change changes the type annotations for `pyspark.sql.types.Row`'s
`__new__` and `__init__` methods when invoked without keyword arguments
(_i.e._, `*args` rather than `**kwargs`) from `str` to `Any`.
### 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.
2. If you fix a bug, you can clarify why it is a bug.
-->
When creating a
[Row](https://hyukjin-spark.readthedocs.io/en/latest/reference/api/pyspark.sql.types.Row.html)
with unnamed fields which are not of type `str` (_e.g._, `row1 = Row("Alice",
11)` appears in the `Row` documentation) type checkers produce an error.
The implementation doesn't assume the arguments are of type `str`, and in
fact the documentation includes an example where non-`str` types are provided
in this way (see [the final example
here](https://hyukjin-spark.readthedocs.io/en/latest/reference/api/pyspark.sql.types.Row.html)).
An example of the type error produced by
[pyright](https://github.com/microsoft/pyright) is
```
error: No overloads for "__init__" match the provided arguments
Argument types: (Literal['Alice'], Literal[11]) (reportGeneralTypeIssues)
```
### 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'.
-->
It changes the python type annotation for `Row`, which is user facing. The
change makes the type annotation more general, and should not be a breaking
change in any sense.
The previous type annotation behaves like so:
```python
# Will not produce type errors:
Row("Alice", "Bob")
# Will produce type errors:
Row("Alice", 11)
```
After this change, both lines will be accepted by a type checker.
### 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.
-->
- [x] MyPy tests of PySpark source code
```
mypy --no-incremental --config python/mypy.ini python/pyspark
```
For me, this currently fails on `master` with the following errors:
```
python/pyspark/mllib/tree.pyi:29: error: Overloaded function signatures
1 and 2 overlap with incompatible return types
python/pyspark/mllib/tree.pyi:38: error: Overloaded function signatures
1 and 2 overlap with incompatible return types
python/pyspark/mllib/feature.pyi:34: error: Overloaded function
signatures 1 and 2 overlap with incompatible return types
python/pyspark/mllib/feature.pyi:42: error: Overloaded function
signatures 1 and 2 overlap with incompatible return types
python/pyspark/mllib/feature.pyi:48: error: Overloaded function
signatures 1 and 2 overlap with incompatible return types
python/pyspark/mllib/feature.pyi:54: error: Overloaded function
signatures 1 and 2 overlap with incompatible return types
python/pyspark/mllib/feature.pyi:76: error: Overloaded function
signatures 1 and 2 overlap with incompatible return types
python/pyspark/mllib/feature.pyi:124: error: Overloaded function
signatures 1 and 2 overlap with incompatible return types
python/pyspark/mllib/feature.pyi:165: error: Overloaded function
signatures 1 and 2 overlap with incompatible return types
python/pyspark/mllib/clustering.pyi:45: error: Overloaded function
signatures 1 and 2 overlap with incompatible return types
python/pyspark/mllib/clustering.pyi:72: error: Overloaded function
signatures 1 and 2 overlap with incompatible return types
python/pyspark/mllib/classification.pyi:39: error: Overloaded function
signatures 1 and 2 overlap with incompatible return types
python/pyspark/mllib/classification.pyi:52: error: Overloaded function
signatures 1 and 2 overlap with incompatible return types
Found 13 errors in 4 files (checked 314 source files)
```
Re-running after my change doesn't introduce any new errors. MyPy
version 0.910 was used.
Tagging @HyukjinKwon and @zero323 as you both seem to have worked on type
annotations recently. Thanks in advance for your help 😃
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
