pandas.DataFrame.rename_axis

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

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

Параметры:

mapper:скаляр, список, опционально

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

index, columns:скаляр, список, словарь или функция, опционально

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

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

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

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

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

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

Примечание

Ключевое слово copy изменит поведение в pandas 3.0. Copy-on-Write будет включено по умолчанию, что означает, что все методы с ключевым словом copy будут использовать механизм ленивой копии для отсрочки копии и игнорировать ключевое слово copy. Ключевое слово copy будет удалено в будущей версии pandas.

Вы уже можете получить будущее поведение и улучшения, включив копирование при записи pd.options.mode.copy_on_write = 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