pandas.Series.rename_axis

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

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

Параметры:

mapper : scalar, list-like, optional Значение для установки имени оси. index, columns : scalar, list-like, dict-like or function, optional Скаляр, список, словарь или функция преобразования, применяемая к значениям этой оси. Используйте либо mapper и axis для указания оси, к которой применять mapper, либо index и/или columns. Изменено в версии 0.24.0. axis : {0 or ‘index’, 1 or ‘columns’}, default 0 Ось для переименования. copy : bool, default True Также скопировать исходные данные. inplace : bool, default False Изменяет объект напрямую, а не создаёт новую Series или DataFrame.

Возвращает:

Series, DataFrame или None Тип, совпадающий с вызывающим объектом, или None, если inplace имеет значение True.

См. также

Series.rename

Изменение меток индекса или имени Series.

DataFrame.rename

Изменение меток индекса или имени DataFrame.

Index.rename

Установить новые имена индекса.

Примечания

До версии 0.21.0, rename_axis также можно было использовать для изменения меток осей, передав отображение или скаляр. Это поведение устарело и будет удалено в будущей версии. Используйте 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