pandas.Index.rename

Index.rename(name, *, inplace=False)[source]

Изменение имени индекса или многоуровневого индекса.

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

Параметры:

name:метка или список меток

Имя(на) для установки.

inplace:bool, по умолчанию False

Изменяет объект напрямую вместо создания нового индекса или многоуровневого индекса.

Возвращает:

Индекс или None

Тип, такой же, как у вызывающего объекта, или None, если inplace=True.

См. также

Index.set_names

Возможность установки новых имён частично и по уровням.

Примеры

>>> idx = pd.Index(['A', 'C', 'A', 'B'], name='score')
>>> idx.rename('grade')
Index(['A', 'C', 'A', 'B'], dtype='object', name='grade')

>>> idx = pd.MultiIndex.from_product([['python', 'cobra'],
...                                   [2018, 2019]],
...                                   names=['kind', 'year'])
>>> idx
MultiIndex([('python', 2018),
            ('python', 2019),
            ( 'cobra', 2018),
            ( 'cobra', 2019)],
           names=['kind', 'year'])
>>> idx.rename(['species', 'year'])
MultiIndex([('python', 2018),
            ('python', 2019),
            ( 'cobra', 2018),
            ( 'cobra', 2019)],
           names=['species', 'year'])
>>> idx.rename('species')
Traceback (most recent call last):
TypeError: Must pass list-like as `names`.