pandas.Series.rename_axis

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

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