TYP: DataFrame.(index|columns) and Series.index #31126
Conversation
topper-123
changed the title
pandas/core/series.py
Outdated
| index: "Index" = properties.AxisProperty( | ||
| axis=0, doc="The index (axis labels) of the Series." | ||
| ) | ||
| generic.NDFrame._internal_names_set.add("index") |
There was a problem hiding this comment.
shouldn't this actually be on Series._internal_names_set? (and same for Frame)
| @@ -295,6 +298,9 @@ def _get_footer(self) -> str: | |||
| footer = "" | |||
|
|
|||
| if getattr(self.series.index, "freq", None) is not None: | |||
| assert isinstance( | |||
| self.series.index, (ABCDatetimeIndex, ABCPeriodIndex, ABCTimedeltaIndex) | |||
There was a problem hiding this comment.
don't we have a ABCDatetimelike ?
There was a problem hiding this comment.
No, and I only found two instances of this pattern.
topper-123
changed the title
| @@ -5300,8 +5304,10 @@ def reorder_levels(self, order, axis=0) -> "DataFrame": | |||
| result = self.copy() | |||
|
|
|||
| if axis == 0: | |||
| assert isinstance(result.index, ABCMultiIndex) | |||
There was a problem hiding this comment.
isn't this is a breaking change?
this PR
>>> pd.DataFrame().swaplevel()
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
File "C:\Users\simon\pandas\pandas\core\frame.py", line 5270, in swaplevel
assert isinstance(result.index, ABCMultiIndex)
AssertionError
>>>on master
>>> pd.DataFrame().swaplevel()
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
File "C:\Users\simon\pandas\pandas\core\frame.py", line 5268, in swaplevel
result.index = result.index.swaplevel(i, j)
AttributeError: 'Index' object has no attribute 'swaplevel'
>>>There was a problem hiding this comment.
Yeah, I've made it a TypeError, to mirror reorder_levels. I also added a Whatsnew note.
There was a problem hiding this comment.
BTW, is this an API change? We're reaching 1.0, so in principle we should be wary on changing the API. Should I raise an AttributeError instead of TypeError to maintain compatibility (though that is strictly a wrong error to raise)?
| @@ -379,7 +379,7 @@ def _generate_marginal_results_without_values( | |||
| ): | |||
| if len(cols) > 0: | |||
| # need to "interleave" the margins | |||
| margin_keys = [] | |||
| margin_keys: Union[List, Index] = [] | |||
There was a problem hiding this comment.
could be ArrayLike? (not sure it matters, but can update in followon if this works)
There was a problem hiding this comment.
That would not work, because Union[List, Index] is the precise type of this.
doc/source/whatsnew/v1.0.0.rst
Outdated
| @@ -666,7 +666,8 @@ Other API changes | |||
| - When testing pandas, the new minimum required version of pytest is 5.0.1 (:issue:`29664`) | |||
| - :meth:`Series.str.__iter__` was deprecated and will be removed in future releases (:issue:`28277`). | |||
| - Added ``<NA>`` to the list of default NA values for :meth:`read_csv` (:issue:`30821`) | |||
|
|
|||
| - a ``TypeError`` is now raised if attempting to call :meth:`DataFrame.swaplevels` and the axis is not | |||
topper-123
force-pushed
the
type_index_columns
branch
from
a1b0d21
to
745d7e1
Compare
|
Ping. |
|
thanks! |
Makes mypy discover the
.indexand.columnsattributes and that they'reIndex(sub-)classes.This is done by manually adding the
properties.AxisPropertyto DataFrame/Series instead of doing it programatically, as mypy doesn't like adding attributes programatically very much.