You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by "guan404ming (via GitHub)" <gi...@apache.org> on 2025/05/05 15:58:53 UTC
[PR] Refine type overload for `HiveServer2Hook` [airflow]
guan404ming opened a new pull request, #50211:
URL: https://github.com/apache/airflow/pull/50211
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
<!--
Thank you for contributing! Please make sure that your code changes
are covered with tests. And in case of new features or big changes
remember to adjust the documentation.
Feel free to ping committers for the review!
In case of an existing issue, reference it using one of the following:
closes: #ISSUE
related: #ISSUE
How to write a good git commit message:
http://chris.beams.io/posts/git-commit/
-->
## Why
Since `HiveServer2Hook`'s `get_df` has its own overwrite which would be used by `Amazon/transfer`, we need a more precise overload like previously added in `common-sql` to prevent the union type issue.
## How
- add overload for `get_df`
- add type assertion in unit test
<!-- Please keep an empty line above the dashes. -->
---
**^ Add meaningful description above**
Read the **[Pull Request Guidelines](https://github.com/apache/airflow/blob/main/contributing-docs/05_pull_requests.rst#pull-request-guidelines)** for more information.
In case of fundamental code changes, an Airflow Improvement Proposal ([AIP](https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+Improvement+Proposals)) is needed.
In case of a new dependency, check compliance with the [ASF 3rd Party License Policy](https://www.apache.org/legal/resolved.html#category-x).
In case of backwards incompatible changes please leave a note in a newsfragment file, named `{pr_number}.significant.rst` or `{issue_number}.significant.rst`, in [airflow-core/newsfragments](https://github.com/apache/airflow/tree/main/airflow-core/newsfragments).
--
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: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Refine type overload for `HiveServer2Hook` [airflow]
Posted by "guan404ming (via GitHub)" <gi...@apache.org>.
guan404ming commented on code in PR #50211:
URL: https://github.com/apache/airflow/pull/50211#discussion_r2073944290
##########
providers/apache/hive/src/airflow/providers/apache/hive/hooks/hive.py:
##########
@@ -1071,6 +1071,28 @@ def _get_polars_df( # type: ignore
df = pl.DataFrame(res["data"], schema=[c[0] for c in res["header"]], orient="row", **kwargs)
return df
+ @overload # type: ignore[override]
+ def get_df(
+ self,
+ sql: str,
+ schema: str = "default",
+ hive_conf: dict[Any, Any] | None = None,
+ *,
+ df_type: Literal["pandas"] = "pandas",
+ **kwargs: Any,
+ ) -> pd.DataFrame: ...
+
+ @overload # type: ignore[override]
+ def get_df(
+ self,
+ sql: str,
+ schema: str = "default",
+ hive_conf: dict[Any, Any] | None = None,
+ *,
+ df_type: Literal["polars"],
+ **kwargs: Any,
+ ) -> pl.DataFrame: ...
+
def get_df( # type: ignore
Review Comment:
Yes, since it receive schema and hive_conf which is different from our get_df in the dbApiHook class, the sub-class here then needs to ignore incompatible override in type check.
--
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: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Refine type overload for `HiveServer2Hook` [airflow]
Posted by "guan404ming (via GitHub)" <gi...@apache.org>.
guan404ming commented on code in PR #50211:
URL: https://github.com/apache/airflow/pull/50211#discussion_r2073944290
##########
providers/apache/hive/src/airflow/providers/apache/hive/hooks/hive.py:
##########
@@ -1071,6 +1071,28 @@ def _get_polars_df( # type: ignore
df = pl.DataFrame(res["data"], schema=[c[0] for c in res["header"]], orient="row", **kwargs)
return df
+ @overload # type: ignore[override]
+ def get_df(
+ self,
+ sql: str,
+ schema: str = "default",
+ hive_conf: dict[Any, Any] | None = None,
+ *,
+ df_type: Literal["pandas"] = "pandas",
+ **kwargs: Any,
+ ) -> pd.DataFrame: ...
+
+ @overload # type: ignore[override]
+ def get_df(
+ self,
+ sql: str,
+ schema: str = "default",
+ hive_conf: dict[Any, Any] | None = None,
+ *,
+ df_type: Literal["polars"],
+ **kwargs: Any,
+ ) -> pl.DataFrame: ...
+
def get_df( # type: ignore
Review Comment:
Yes, since it receive schema and hive_conf which is different from our get_df in the dbApiHook class, it needs to ignore incompatible override in type check.
--
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: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Refine type overload for `HiveServer2Hook` [airflow]
Posted by "guan404ming (via GitHub)" <gi...@apache.org>.
guan404ming commented on PR #50211:
URL: https://github.com/apache/airflow/pull/50211#issuecomment-2853457236
Thanks for the review!
--
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: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Refine type overload for `HiveServer2Hook` [airflow]
Posted by "eladkal (via GitHub)" <gi...@apache.org>.
eladkal commented on code in PR #50211:
URL: https://github.com/apache/airflow/pull/50211#discussion_r2073938042
##########
providers/apache/hive/src/airflow/providers/apache/hive/hooks/hive.py:
##########
@@ -1071,6 +1071,28 @@ def _get_polars_df( # type: ignore
df = pl.DataFrame(res["data"], schema=[c[0] for c in res["header"]], orient="row", **kwargs)
return df
+ @overload # type: ignore[override]
+ def get_df(
+ self,
+ sql: str,
+ schema: str = "default",
+ hive_conf: dict[Any, Any] | None = None,
+ *,
+ df_type: Literal["pandas"] = "pandas",
+ **kwargs: Any,
+ ) -> pd.DataFrame: ...
+
+ @overload # type: ignore[override]
+ def get_df(
+ self,
+ sql: str,
+ schema: str = "default",
+ hive_conf: dict[Any, Any] | None = None,
+ *,
+ df_type: Literal["polars"],
+ **kwargs: Any,
+ ) -> pl.DataFrame: ...
+
def get_df( # type: ignore
Review Comment:
Do we still need the type ignore here?
--
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: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Refine type overload for `HiveServer2Hook` [airflow]
Posted by "eladkal (via GitHub)" <gi...@apache.org>.
eladkal merged PR #50211:
URL: https://github.com/apache/airflow/pull/50211
--
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: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org