Skip to content

TYP: type NDFrame.(_get_axis|_get_axis_name|_get_axis_number) #33610

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.

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
Apr 18, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 3 additions & 1 deletion doc/source/whatsnew/v1.1.0.rst
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,9 @@ Other API changes
Backwards incompatible API changes
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- :meth:`DataFrame.swaplevels` now raises a ``TypeError`` if the axis is not a :class:`MultiIndex`.
Previously a ``AttributeError`` was raised (:issue:`31126`)
Previously an ``AttributeError`` was raised (:issue:`31126`)
- :meth:`DataFrame.xs` now raises a ``TypeError`` if a ``level`` keyword is supplied and the axis is not a :class:`MultiIndex`.
Previously an ``AttributeError`` was raised (:issue:`33610`)
- :meth:`DataFrameGroupby.mean` and :meth:`SeriesGroupby.mean` (and similarly for :meth:`~DataFrameGroupby.median`, :meth:`~DataFrameGroupby.std` and :meth:`~DataFrameGroupby.var`)
now raise a ``TypeError`` if a not-accepted keyword argument is passed into it.
Previously a ``UnsupportedFunctionCall`` was raised (``AssertionError`` if ``min_count`` passed into :meth:`~DataFrameGroupby.median`) (:issue:`31485`)
Expand Down
36 changes: 18 additions & 18 deletions pandas/core/generic.py
Original file line number Diff line number Diff line change
Expand Up @@ -353,7 +353,7 @@ def _construct_axes_from_arguments(
return axes, kwargs

@classmethod
def _get_axis_number(cls, axis):
def _get_axis_number(cls, axis) -> int:
axis = cls._AXIS_ALIASES.get(axis, axis)
if is_integer(axis):
if axis in cls._AXIS_NAMES:
Expand All @@ -366,7 +366,7 @@ def _get_axis_number(cls, axis):
raise ValueError(f"No axis named {axis} for object type {cls.__name__}")

@classmethod
def _get_axis_name(cls, axis):
def _get_axis_name(cls, axis) -> str:
axis = cls._AXIS_ALIASES.get(axis, axis)
if isinstance(axis, str):
if axis in cls._AXIS_NUMBERS:
Expand All @@ -378,12 +378,12 @@ def _get_axis_name(cls, axis):
pass
raise ValueError(f"No axis named {axis} for object type {cls.__name__}")

def _get_axis(self, axis):
def _get_axis(self, axis) -> Index:
name = self._get_axis_name(axis)
return getattr(self, name)

@classmethod
def _get_block_manager_axis(cls, axis):
def _get_block_manager_axis(cls, axis) -> int:
Copy link
Member

Choose a reason for hiding this comment

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

can "axis" be typed as Axis?

Copy link
Contributor Author

@topper-123 topper-123 Apr 17, 2020

Choose a reason for hiding this comment

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

Yeah, but in some cases axis is returned, so that that would require some refactoring inside the function, which I'd like to do seperately. For example I'm pretty sure _AXIS_ALIASES can be removed from the code base.

Copy link
Member

Choose a reason for hiding this comment

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

makes sense, thanks

"""Map the axis to the block_manager axis."""
axis = cls._get_axis_number(axis)
if cls._AXIS_REVERSED:
Expand Down Expand Up @@ -590,7 +590,9 @@ def swapaxes(self: FrameOrSeries, axis1, axis2, copy=True) -> FrameOrSeries:
if copy:
new_values = new_values.copy()

return self._constructor(new_values, *new_axes).__finalize__(
# ignore needed because of NDFrame constructor is different than
# DataFrame/Series constructors.
return self._constructor(new_values, *new_axes).__finalize__( # type: ignore
Copy link
Member

Choose a reason for hiding this comment

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

hmm, can you add the mypy error as a comment.

IIUC there were issues with deprecating this method, xref #26654.

For series, it's a no-op. maybe now that Panel is deprecated, we could have logic in DataFrame and Series instead of NDFrame and simplify.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yeah, I remember that. The problem was that np.swapaxes(df, 0, 1), np.swapaxes(series, 0, 0) works in master and are tested for. It's not unreasonable that it works, but users should really use transpose/T instead.

Maybe add swapaxes to _deprecations to get it out of the tab-list?

self, method="swapaxes"
)

Expand Down Expand Up @@ -3490,6 +3492,8 @@ class animal locomotion
axis = self._get_axis_number(axis)
labels = self._get_axis(axis)
if level is not None:
if not isinstance(labels, MultiIndex):
raise TypeError("Index must be a MultiIndex")
loc, new_ax = labels.get_loc_level(key, level=level, drop_level=drop_level)

# create the tuple of the indexer
Expand Down Expand Up @@ -7621,11 +7625,11 @@ def at_time(
axis = self._get_axis_number(axis)

index = self._get_axis(axis)
try:
indexer = index.indexer_at_time(time, asof=asof)
except AttributeError as err:
raise TypeError("Index must be DatetimeIndex") from err

if not isinstance(index, DatetimeIndex):
raise TypeError("Index must be DatetimeIndex")

indexer = index.indexer_at_time(time, asof=asof)
return self._take_with_is_copy(indexer, axis=axis)

def between_time(
Expand Down Expand Up @@ -7704,16 +7708,12 @@ def between_time(
axis = self._get_axis_number(axis)

index = self._get_axis(axis)
try:
indexer = index.indexer_between_time(
start_time,
end_time,
include_start=include_start,
include_end=include_end,
)
except AttributeError as err:
raise TypeError("Index must be DatetimeIndex") from err
if not isinstance(index, DatetimeIndex):
raise TypeError("Index must be DatetimeIndex")
Copy link
Member

Choose a reason for hiding this comment

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

+1


indexer = index.indexer_between_time(
start_time, end_time, include_start=include_start, include_end=include_end,
)
return self._take_with_is_copy(indexer, axis=axis)

def resample(
Expand Down
12 changes: 12 additions & 0 deletions pandas/tests/indexing/multiindex/test_xs.py
Original file line number Diff line number Diff line change
Expand Up @@ -243,3 +243,15 @@ def test_series_getitem_multiindex_xs_by_label():

result = s.xs("one", level="L2")
tm.assert_series_equal(result, expected)


def test_xs_levels_raises():
df = DataFrame({"A": [1, 2, 3]})

msg = "Index must be a MultiIndex"
with pytest.raises(TypeError, match=msg):
df.xs(0, level="as")

s = df.A
with pytest.raises(TypeError, match=msg):
s.xs(0, level="as")