pandas.Series.rename_axis

Series.rename_axis(mapper=<no_default>, *, index=<no_default>, axis=0, copy=True, inplace=False)[исходный код]

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

Параметры:

mapper:scalar, list-like, optional

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

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

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

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

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

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

copy:bool, default None

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

Примечание

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

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

inplace:bool, default False

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

Возвращает:

Series, DataFrame, or 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 имеет тип dict-like или является функцией, будет использовано устаревшее поведение, при котором изменяются метки оси.

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

Примеры

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