TYP: rename FrameOrSeries to NDFrameT (#43752)

Author: twoertwein

pandas/_typing.py

@@ -101,11 +101,11 @@
 ]
 Timezone = Union[str, tzinfo]
 
-# FrameOrSeries is stricter and ensures that the same subclass of NDFrame always is
-# used. E.g. `def func(a: FrameOrSeries) -> FrameOrSeries: ...` means that if a
+# NDFrameT is stricter and ensures that the same subclass of NDFrame always is
+# used. E.g. `def func(a: NDFrameT) -> NDFrameT: ...` means that if a
 # Series is passed into a function, a Series is always returned and if a DataFrame is
 # passed in, a DataFrame is always returned.
-FrameOrSeries = TypeVar("FrameOrSeries", bound="NDFrame")
+NDFrameT = TypeVar("NDFrameT", bound="NDFrame")
 
 Axis = Union[str, int]
 IndexLabel = Union[Hashable, Sequence[Hashable]]

pandas/core/apply.py

@@ -30,7 +30,7 @@
     AggFuncTypeDict,
     AggObjType,
     Axis,
-    FrameOrSeries,
+    NDFrameT,
 )
 from pandas.util._decorators import cache_readonly
 from pandas.util._exceptions import find_stack_level
@@ -1120,7 +1120,7 @@ def apply_standard(self) -> DataFrame | Series:
 class GroupByApply(Apply):
     def __init__(
         self,
-        obj: GroupBy[FrameOrSeries],
+        obj: GroupBy[NDFrameT],
         func: AggFuncType,
         args,
         kwargs,

pandas/core/base.py

@@ -22,8 +22,8 @@
 from pandas._typing import (
     ArrayLike,
     DtypeObj,
-    FrameOrSeries,
     IndexLabel,
+    NDFrameT,
     Shape,
     npt,
 )
@@ -181,13 +181,13 @@ class SpecificationError(Exception):
     pass
 
 
-class SelectionMixin(Generic[FrameOrSeries]):
+class SelectionMixin(Generic[NDFrameT]):
     """
     mixin implementing the selection & aggregation interface on a group-like
     object sub-classes need to define: obj, exclusions
     """
 
-    obj: FrameOrSeries
+    obj: NDFrameT
     _selection: IndexLabel | None = None
     exclusions: frozenset[Hashable]
     _internal_names = ["_cache", "__setstate__"]

pandas/core/computation/align.py

@@ -15,7 +15,6 @@
 
 import numpy as np
 
-from pandas._typing import FrameOrSeries
 from pandas.errors import PerformanceWarning
 
 from pandas.core.dtypes.generic import (
@@ -28,14 +27,15 @@
 from pandas.core.computation.common import result_type_many
 
 if TYPE_CHECKING:
+    from pandas.core.generic import NDFrame
     from pandas.core.indexes.api import Index
 
 
 def _align_core_single_unary_op(
     term,
-) -> tuple[partial | type[FrameOrSeries], dict[str, Index] | None]:
+) -> tuple[partial | type[NDFrame], dict[str, Index] | None]:
 
-    typ: partial | type[FrameOrSeries]
+    typ: partial | type[NDFrame]
     axes: dict[str, Index] | None = None
 
     if isinstance(term.value, np.ndarray):
@@ -49,7 +49,7 @@ def _align_core_single_unary_op(
 
 
 def _zip_axes_from_type(
-    typ: type[FrameOrSeries], new_axes: Sequence[Index]
+    typ: type[NDFrame], new_axes: Sequence[Index]
 ) -> dict[str, Index]:
     return {name: new_axes[i] for i, name in enumerate(typ._AXIS_ORDERS)}
 

pandas/core/describe.py

@@ -22,7 +22,7 @@
 import numpy as np
 
 from pandas._libs.tslibs import Timestamp
-from pandas._typing import FrameOrSeries
+from pandas._typing import NDFrameT
 from pandas.util._validators import validate_percentile
 
 from pandas.core.dtypes.common import (
@@ -45,12 +45,12 @@
 
 def describe_ndframe(
     *,
-    obj: FrameOrSeries,
+    obj: NDFrameT,
     include: str | Sequence[str] | None,
     exclude: str | Sequence[str] | None,
     datetime_is_numeric: bool,
     percentiles: Sequence[float] | np.ndarray | None,
-) -> FrameOrSeries:
+) -> NDFrameT:
     """Describe series or dataframe.
 
     Called from pandas.core.generic.NDFrame.describe()
@@ -91,7 +91,7 @@ def describe_ndframe(
         )
 
     result = describer.describe(percentiles=percentiles)
-    return cast(FrameOrSeries, result)
+    return cast(NDFrameT, result)
 
 
 class NDFrameDescriberAbstract(ABC):