Skip to content

TYPING: change to FrameOrSeries Alias in pandas._typing #28173

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 2 commits into from
Aug 27, 2019
Merged

TYPING: change to FrameOrSeries Alias in pandas._typing #28173

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
30bf1ed
TYPING: change to FrameOrSeries Alias in pandas._typing
simonjayhawkins Aug 27, 2019
c46de97
add comment
simonjayhawkins Aug 27, 2019
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
7 changes: 5 additions & 2 deletions pandas/_typing.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@
from pandas.core.arrays.base import ExtensionArray # noqa: F401
from pandas.core.dtypes.dtypes import ExtensionDtype # noqa: F401
from pandas.core.indexes.base import Index # noqa: F401
from pandas.core.frame import DataFrame # noqa: F401
from pandas.core.series import Series # noqa: F401
from pandas.core.sparse.series import SparseSeries # noqa: F401
from pandas.core.generic import NDFrame # noqa: F401


AnyArrayLike = TypeVar(
Expand All @@ -24,7 +24,10 @@
Dtype = Union[str, np.dtype, "ExtensionDtype"]
FilePathOrBuffer = Union[str, Path, IO[AnyStr]]

FrameOrSeries = TypeVar("FrameOrSeries", "Series", "DataFrame")
FrameOrSeries = TypeVar("FrameOrSeries", bound="NDFrame")
Scalar = Union[str, int, float]
Axis = Union[str, int]
Ordered = Optional[bool]

# to maintain type information across generic functions and parametrization
_T = TypeVar("_T")
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you just add a quick inline comment for the purpose of this one? May be useful for those who haven't invested a lot of time in annotations yet

Copy link
Member Author

@simonjayhawkins simonjayhawkins Aug 27, 2019 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

something like

# Unconstrained type variable for generic functions and user-defined generic types.
# see https://docs.python.org/3/library/typing.html#generics and
# https://docs.python.org/3/library/typing.html#typing.TypeVar for more info.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ideally less technical. Maybe something like # to maintain type information across generic functions and parametrization or even slightly less technical if possible