REF: _AXIS_TO_AXIS_NUMBER to simplify axis access #33637
Conversation
| """.. deprecated:: 1.1.0""" | ||
| super()._AXIS_NAMES | ||
| return {0: "index", 1: "columns"} | ||
|
|
There was a problem hiding this comment.
Neither _AXIS_NUMBERS and _AXIS_NAMES are needed anymore. Just in case they are used downstream I've deprecated them instead of just removing them.
topper-123
force-pushed
the
cln_get_axis
branch
2 times, most recently
from
162b954
to
ab8ed31
Compare
|
This is not adding things, it's moving things around and simplifying. A nice side effect will that we can now see the allowed values for |
topper-123
force-pushed
the
cln_get_axis
branch
2 times, most recently
from
39ba455
to
db44239
Compare
pandas/core/generic.py
Outdated
| def _AXIS_NUMBERS(self) -> Dict[str, int]: | ||
| """.. deprecated:: 1.1.0""" | ||
| warnings.warn( | ||
| "_AXIS_NUMBERS has been deprecated. Call ._get_axis_number instead", |
There was a problem hiding this comment.
we should probably not point to another private method? (maybe just say it is deprecated, without alternative, unless we want to expose something more publicly somewhere, or document this private method as "public" for developer use)
topper-123
force-pushed
the
cln_get_axis
branch
3 times, most recently
from
dd76ae0
to
014b95f
Compare
topper-123
force-pushed
the
cln_get_axis
branch
from
014b95f
to
7932822
Compare
|
I've found out that this PR requires a change to the recipe on setting aliases in cookbook.rst. I quite dislike encouraging setting aliases in the official pandas docs. If anyone actually uses that pattern in real code, is would be just confusing without being helpful IMO. But I've just changed it to the new style, for now, but would prefer to delete the section on aliases if there's no objections. |
doc/source/user_guide/cookbook.rst
Outdated
| @@ -1336,21 +1336,27 @@ Values can be set to NaT using np.nan, similar to datetime | |||
| Aliasing axis names | |||
| ------------------- | |||
|
|
|||
| .. versionchanged:: 1.1.0 | |||
There was a problem hiding this comment.
we should just remove this section entirely. it isn't really tested / nor well supported.
Could you expand, I don't understand this comment (and maybe the first comment too). |
|
I think Jeff just mean to say to remove the cookbook example, alltogether, as you did (and indeed, that is not something to put in our docs I think) |
|
Ok. |
|
thanks @topper-123 very nice |
|
can you add the deprecations to issue for removal: #30228 |
This adds a dict called
_AXIS_TO_AXIS_NUMBERto NDFrame/DataFrame where the keys are the allowed parameter values for theaxisparameter in various ndframe methods and the dict values are the related axis number. This makes getting to the correct axis more straight forward, see for example the new_get_axis_number, and makes adding type hints to theaxisparameter easier.