pandas.Index.rename

Index.rename(name, *, inplace=False)

更改 Index 或 MultiIndex 的名称。

能够设置新名称而不设置级别。默认为返回新索引。names的长度必须与MultiIndex的级别数匹配。

Parameters:

name标签或标签列表

要设置的名称。

inplacebool，默认 False

直接修改对象，而不是创建新的Index或MultiIndex。

Returns:

索引 或 None

与调用者相同的类型，或在 inplace=True 时为 None。

参见

Index.set_names

能够部分设置新名称，并按级别设置。

Examples

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