Skip to content

Commit 0b1d520

Browse files
gab23rgabriel
and
gabriel
authored
fix(python): Fix row_by_key typing (#19888)
Co-authored-by: gabriel <[email protected]>
1 parent f0d087d commit 0b1d520

File tree

1 file changed

+37
-1
lines changed

1 file changed

+37
-1
lines changed

py-polars/polars/dataframe/frame.py

+37-1
Original file line numberDiff line numberDiff line change
@@ -10350,14 +10350,50 @@ def rows(
1035010350
else:
1035110351
return self._df.row_tuples()
1035210352

10353+
@overload
10354+
def rows_by_key(
10355+
self,
10356+
key: ColumnNameOrSelector | Sequence[ColumnNameOrSelector],
10357+
*,
10358+
named: Literal[False] = ...,
10359+
include_key: bool = ...,
10360+
unique: Literal[False] = ...,
10361+
) -> dict[Any, list[Any]]: ...
10362+
@overload
10363+
def rows_by_key(
10364+
self,
10365+
key: ColumnNameOrSelector | Sequence[ColumnNameOrSelector],
10366+
*,
10367+
named: Literal[False] = ...,
10368+
include_key: bool = ...,
10369+
unique: Literal[True],
10370+
) -> dict[Any, Any]: ...
10371+
@overload
10372+
def rows_by_key(
10373+
self,
10374+
key: ColumnNameOrSelector | Sequence[ColumnNameOrSelector],
10375+
*,
10376+
named: Literal[True],
10377+
include_key: bool = ...,
10378+
unique: Literal[False] = ...,
10379+
) -> dict[Any, list[dict[str, Any]]]: ...
10380+
@overload
10381+
def rows_by_key(
10382+
self,
10383+
key: ColumnNameOrSelector | Sequence[ColumnNameOrSelector],
10384+
*,
10385+
named: Literal[True],
10386+
include_key: bool = ...,
10387+
unique: Literal[True],
10388+
) -> dict[Any, dict[str, Any]]: ...
1035310389
def rows_by_key(
1035410390
self,
1035510391
key: ColumnNameOrSelector | Sequence[ColumnNameOrSelector],
1035610392
*,
1035710393
named: bool = False,
1035810394
include_key: bool = False,
1035910395
unique: bool = False,
10360-
) -> dict[Any, Iterable[Any]]:
10396+
) -> dict[Any, Any]:
1036110397
"""
1036210398
Returns all data as a dictionary of python-native values keyed by some column.
1036310399

0 commit comments

Comments
 (0)