pandas.DataFrame.rename_axis

DataFrame.rename_axis(mapper=<no_default>, *, index=<no_default>, columns=<no_default>, axis=0, copy=None, inplace=False)[source]

Задать имя оси для индекса или столбцов.

Параметры:

mapper:scalar, list-like, optional

Значение, задаваемое атрибуту имени оси.

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

Скаляр, список, словарь или функция для преобразования значений этой оси. Обратите внимание, что параметр columns недопустим, если объект является Series. Этот параметр применим только к объектам типа DataFrame.

Используйте mapper и axis, чтобы указать ось, к которой следует применить mapper, или index и/или columns.

axis:{0 or ‘index’, 1 or ‘columns’}, default 0

Ось, имя которой нужно изменить. Для Series этот параметр не используется, а его значение по умолчанию — 0.

copy:bool, default None

Также копировать базовые данные.

Примечание

Поведение ключевого слова copy изменится в pandas 3.0. По умолчанию будет включён режим копирования при записи: все методы с ключевым словом copy будут использовать механизм отложенного копирования и игнорировать ключевое слово copy. В будущей версии pandas ключевое слово copy будет удалено.

Вы уже можете получить будущее поведение и улучшения, включив копирование при записи pd.options.mode.copy_on_write = True

inplace:bool, default False

Изменить объект напрямую, не создавая новый Series или DataFrame.

Возвращает:

Series, DataFrame, или None

Объект того же типа, что и исходный, или None, если inplace=True.

См. также

Series.rename

Изменить метки или имя индекса Series.

DataFrame.rename

Изменить метки или имя индекса DataFrame.

Index.rename

Задать новые имена индексу.

Примечания

DataFrame.rename_axis поддерживает два варианта вызова

• (index=index_mapper, columns=columns_mapper, ...)

• (mapper, axis={'index', 'columns'}, ...)

Первый вариант вызова изменяет только имена индекса и/или объекта Index, являющегося столбцами. В этом случае параметр copy игнорируется.

Второй вариант вызова изменяет имена соответствующего индекса, если mapper — список или скаляр. Однако если mapper имеет вид словаря или является функцией, будет использовано устаревшее поведение, при котором изменяются метки оси.

Мы настоятельно рекомендуем использовать именованные аргументы, чтобы чётко обозначить намерение.

Примеры

Series

>>> s = pd.Series(["dog", "cat", "monkey"])
>>> s
0       dog
1       cat
2    monkey
dtype: object
>>> s.rename_axis("animal")
animal
0    dog
1    cat
2    monkey
dtype: object

DataFrame

>>> 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
>>> df = df.rename_axis("animal")
>>> df
        num_legs  num_arms
animal
dog            4         0
cat            4         0
monkey         2         2
>>> df = df.rename_axis("limbs", axis="columns")
>>> df
limbs   num_legs  num_arms
animal
dog            4         0
cat            4         0
monkey         2         2

MultiIndex

>>> 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

>>> df.rename_axis(index={'type': 'class'})
limbs          num_legs  num_arms
class  name
mammal dog            4         0
       cat            4         0
       monkey         2         2

>>> df.rename_axis(columns=str.upper)
LIMBS          num_legs  num_arms
type   name
mammal dog            4         0
       cat            4         0
       monkey         2         2