pandas.Series.rename_axis

Series.rename_axis(mapper=_NoDefault.no_default, *, index=_NoDefault.no_default, axis=0, copy=True, 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