Skip to content

typing: DataSource.to_polars and .to_pandas #177

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

Open
StefanoCretti wants to merge 1 commit into
base: main
Choose a base branch
from
Open

typing: DataSource.to_polars and .to_pandas #177

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
15 changes: 12 additions & 3 deletions py-oxbow/oxbow/_core/base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
import pathlib
import warnings
from abc import abstractmethod
from typing import IO, Any, Callable, Generator, Literal
from typing import IO, TYPE_CHECKING, Any, Callable, Generator, Literal, overload

try:
from typing import Self
Expand All @@ -21,6 +21,10 @@
BatchReaderFragment,
)

if TYPE_CHECKING:
import pandas as pd
import polars as pl


class DataSource:
"""
Expand Down Expand Up @@ -226,7 +230,7 @@ def dataset(self) -> BatchReaderDataset:
"""
return BatchReaderDataset(self.fragments())

def to_pandas(self):
def to_pandas(self) -> "pd.DataFrame":
"""
Convert the dataset to a Pandas DataFrame.

Expand All @@ -239,7 +243,12 @@ def to_pandas(self):

pd = to_pandas

def to_polars(self, lazy=False):
@overload
def to_polars(self, lazy: Literal[True]) -> "pl.LazyFrame": ...
@overload
def to_polars(self, lazy: Literal[False] = ...) -> "pl.DataFrame": ...

def to_polars(self, lazy: bool = False) -> "pl.DataFrame | pl.LazyFrame":
"""
Convert the data source to a Polars DataFrame or LazyFrame.

Expand Down