pandas 1.4.2

NotesParametersReturnsBackRef
rename_axis(self, mapper=None, index=None, columns=None, axis=None, copy=True, inplace=False)

Notes

DataFrame.rename_axis supports two calling conventions

The first calling convention will only modify the names of the index and/or the names of the Index object that is the columns. In this case, the parameter copy is ignored.

The second calling convention will modify the names of the corresponding index if mapper is a list or a scalar. However, if mapper is dict-like or a function, it will use the deprecated behavior of modifying the axis labels.

We highly recommend using keyword arguments to clarify your intent.

Parameters

mapper : scalar, list-like, optional

Value to set the axis name attribute.

index, columns : scalar, list-like, dict-like or function, optional

A scalar, list-like, dict-like or functions transformations to apply to that axis' values. Note that the columns parameter is not allowed if the object is a Series. This parameter only apply for DataFrame type objects.

Use either mapper and axis to specify the axis to target with mapper , or index and/or columns .

axis : {0 or 'index', 1 or 'columns'}, default 0

The axis to rename.

copy : bool, default True

Also copy underlying data.

inplace : bool, default False

Modifies the object directly, instead of creating a new Series or DataFrame.

Returns

Series, DataFrame, or None

The same type as the caller or None if inplace=True .

Set the name of the axis for the index or columns.

See Also

DataFrame.rename

Alter DataFrame index labels or name.

Index.rename

Set new names on index.

Series.rename

Alter Series index labels or name.

Examples

Series

This example is valid syntax, but we were not able to check execution
>>> s = pd.Series(["dog", "cat", "monkey"])
... s 0 dog 1 cat 2 monkey dtype: object
This example is valid syntax, but we were not able to check execution
>>> s.rename_axis("animal")
animal
0    dog
1    cat
2    monkey
dtype: object

DataFrame

This example is valid syntax, but we were not able to check execution
>>> df = pd.DataFrame({"num_legs": [4, 4, 2],
...  "num_arms": [0, 0, 2]},
...  ["dog", "cat", "monkey"])
... df num_legs num_arms dog 4 0 cat 4 0 monkey 2 2
This example is valid syntax, but we were not able to check execution
>>> df = df.rename_axis("animal")
... df num_legs num_arms animal dog 4 0 cat 4 0 monkey 2 2
This example is valid syntax, but we were not able to check execution
>>> df = df.rename_axis("limbs", axis="columns")
... df limbs num_legs num_arms animal dog 4 0 cat 4 0 monkey 2 2

MultiIndex

This example is valid syntax, but we were not able to check execution
>>> df.index = pd.MultiIndex.from_product([['mammal'],
...  ['dog', 'cat', 'monkey']],
...  names=['type', 'name'])
... df limbs num_legs num_arms type name mammal dog 4 0 cat 4 0 monkey 2 2
This example is valid syntax, but we were not able to check execution
>>> df.rename_axis(index={'type': 'class'})
limbs          num_legs  num_arms
class  name
mammal dog            4         0
       cat            4         0
       monkey         2         2
This example is valid syntax, but we were not able to check execution
>>> df.rename_axis(columns=str.upper)
LIMBS          num_legs  num_arms
type   name
mammal dog            4         0
       cat            4         0
       monkey         2         2
See :

Back References

The following pages refer to to this document either explicitly or contain code examples using this.

pandas.core.generic.NDFrame._rename

Local connectivity graph

Hover to see nodes names; edges to Self not shown, Caped at 50 nodes.

Using a canvas is more power efficient and can get hundred of nodes ; but does not allow hyperlinks; , arrows or text (beyond on hover)

SVG is more flexible but power hungry; and does not scale well to 50 + nodes.

All aboves nodes referred to, (or are referred from) current nodes; Edges from Self to other have been omitted (or all nodes would be connected to the central node "self" which is not useful). Nodes are colored by the library they belong to, and scaled with the number of references pointing them


File: /pandas/core/generic.py#1165
type: <class 'function'>
Commit: