Skip to content

Refine type overload for HiveServer2Hook #50211

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
eladkal merged 1 commit into from
May 5, 2025
Merged

Refine type overload for HiveServer2Hook #50211

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 23 additions & 1 deletion providers/apache/hive/src/airflow/providers/apache/hive/hooks/hive.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
from typing import TYPE_CHECKING, Any

from deprecated import deprecated
from typing_extensions import Literal
from typing_extensions import Literal, overload

if TYPE_CHECKING:
import pandas as pd
Expand Down Expand Up @@ -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
self,
sql: str,
Expand Down
3 changes: 3 additions & 0 deletions providers/apache/hive/tests/unit/apache/hive/hooks/test_hive.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
from unittest import mock

import pandas as pd
import polars as pl
import pytest
from hmsclient import HMSClient

Expand Down Expand Up @@ -737,8 +738,10 @@ def test_get_df(self, df_type):
assert len(df) == 2
if df_type == "pandas":
assert df["hive_server_hook.a"].values.tolist() == [1, 2]
assert isinstance(df, pd.DataFrame)
elif df_type == "polars":
assert df["hive_server_hook.a"].to_list() == [1, 2]
assert isinstance(df, pl.DataFrame)
date_key = "logical_date" if AIRFLOW_V_3_0_PLUS else "execution_date"
hook.get_conn.assert_called_with(self.database)
hook.mock_cursor.execute.assert_any_call("set airflow.ctx.dag_id=test_dag_id")
Expand Down