pandas.DataFrame.rename_axis

DataFrame.rename_axis(mapper=None, index=None, columns=None, axis=None, copy=True)[source]

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

Параметры

mapper:скаляр, список-подобный объект, необязательно

Значение для установки атрибута имени оси.

index, columns:скаляр, список-подобный объект, словарь-подобный объект или функция, необязательно

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

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

axis:{0 или ‘index’, 1 или ‘columns’}, по умолчанию 0

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

copy:bool, по умолчанию True

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

inplace:bool, по умолчанию 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