Pandas DataFrame rename_axis() Method

Example

Set the name of the row axis:

import pandas as pd

data = {
"name": ["Sally", "Mary", "John"],
"age": [50, 40, 30],
"qualified": [True, False, False]
}
df = pd.DataFrame(data)

newdf = df.rename_axis("members")

print(newdf)

Try it Yourself »

Definition and Usage

The rename_axis() method allows you to change the name of the row axis or the columns axis.

Syntax

dataframe.rename_axis(mapper, index, columns, axis, copy, inplace)

Parameters

The index, columns, axis, copy, inplace parameters are keyword arguments.

Parameter	Value	Description
mapper		Optional. A string or list with the new name of the axis
index	String List Dictionary	Optional. A string, list, or a dictionary with the new name of the row axis
columns	String List Dictionary	Optional. A string, list, or a dictionary with the new name of the column axis
axis	`0 1 'index' 'columns'`	Optional, default 0. The axis to perform the renaming on (important if the mapper parameter is present and index or columns are not)
copy	`True False`	Optional, default True. Whether to also copy underlying data or not
inplace	`True False`	Optional, default False. If True: the operation is done on the current DataFrame. If False: returns a copy where the operation is done.

Return Value

A DataFrame with the result, or None if the inplace parameter is set to True.

This function does NOT make changes to the original DataFrame object.

❮ DataFrame Reference