Skip to content

Add explicit .pl(lazy=True) overload #172

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
merged 1 commit into from
Nov 10, 2025
Merged

Add explicit .pl(lazy=True) overload #172

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
41 changes: 38 additions & 3 deletions _duckdb-stubs/__init__.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -318,7 +318,18 @@ class DuckDBPyConnection:
def list_type(self, type: sqltypes.DuckDBPyType) -> sqltypes.DuckDBPyType: ...
def load_extension(self, extension: str) -> None: ...
def map_type(self, key: sqltypes.DuckDBPyType, value: sqltypes.DuckDBPyType) -> sqltypes.DuckDBPyType: ...
def pl(self, rows_per_batch: pytyping.SupportsInt = 1000000, *, lazy: bool = False) -> polars.DataFrame: ...
@pytyping.overload
def pl(
self, rows_per_batch: pytyping.SupportsInt = 1000000, *, lazy: pytyping.Literal[False] = ...
) -> polars.DataFrame: ...
@pytyping.overload
def pl(
self, rows_per_batch: pytyping.SupportsInt = 1000000, *, lazy: pytyping.Literal[True]
) -> polars.LazyFrame: ...
@pytyping.overload
def pl(
self, rows_per_batch: pytyping.SupportsInt = 1000000, *, lazy: bool = False
) -> pytyping.Union[polars.DataFrame, polars.LazyFrame]: ...
def query(self, query: str, *, alias: str = "", params: object = None) -> DuckDBPyRelation: ...
def query_progress(self) -> float: ...
def read_csv(
Expand Down Expand Up @@ -596,7 +607,16 @@ class DuckDBPyRelation:
) -> DuckDBPyRelation: ...
def order(self, order_expr: str) -> DuckDBPyRelation: ...
def percent_rank(self, window_spec: str, projected_columns: str = "") -> DuckDBPyRelation: ...
def pl(self, batch_size: pytyping.SupportsInt = 1000000, *, lazy: bool = False) -> polars.DataFrame: ...
@pytyping.overload
def pl(
self, batch_size: pytyping.SupportsInt = 1000000, *, lazy: pytyping.Literal[False] = ...
) -> polars.DataFrame: ...
@pytyping.overload
def pl(self, batch_size: pytyping.SupportsInt = 1000000, *, lazy: pytyping.Literal[True]) -> polars.LazyFrame: ...
@pytyping.overload
def pl(
self, batch_size: pytyping.SupportsInt = 1000000, *, lazy: bool = False
) -> pytyping.Union[polars.DataFrame, polars.LazyFrame]: ...
def product(
self, column: str, groups: str = "", window_spec: str = "", projected_columns: str = ""
) -> DuckDBPyRelation: ...
Expand Down Expand Up @@ -1241,12 +1261,27 @@ def map_type(
def order(
df: pandas.DataFrame, order_expr: str, *, connection: DuckDBPyConnection | None = None
) -> DuckDBPyRelation: ...
@pytyping.overload
def pl(
rows_per_batch: pytyping.SupportsInt = 1000000,
*,
lazy: bool = False,
lazy: pytyping.Literal[False] = ...,
connection: DuckDBPyConnection | None = None,
) -> polars.DataFrame: ...
@pytyping.overload
def pl(
rows_per_batch: pytyping.SupportsInt = 1000000,
*,
lazy: pytyping.Literal[True],
connection: DuckDBPyConnection | None = None,
) -> polars.LazyFrame: ...
@pytyping.overload
def pl(
rows_per_batch: pytyping.SupportsInt = 1000000,
*,
lazy: bool = False,
connection: DuckDBPyConnection | None = None,
) -> pytyping.Union[polars.DataFrame, polars.LazyFrame]: ...
def project(
df: pandas.DataFrame, *args: str | Expression, groups: str = "", connection: DuckDBPyConnection | None = None
) -> DuckDBPyRelation: ...
Expand Down
Loading