maxframe.dataframe.Index.rename

Index.rename(name, inplace=False)

更改 Index 或 MultiIndex 的名称。

可以在不指定层级的情况下设置新名称。默认返回新的索引。名称的长度必须与 MultiIndex 中的层级数量一致。

参数:

• name (label or list of labels) -- 要设置的名称。

• inplace (bool, default False) -- 直接修改对象，而不是创建一个新的 Index 或 MultiIndex。

返回:

与调用者相同类型的对象，如果 inplace 为 True 则返回 None。

返回类型:

Index

参见

Index.set_names

可以按层级部分地设置新名称。

示例

>>> import maxframe.dataframe as md
>>> idx = md.Index(['A', 'C', 'A', 'B'], name='score')
>>> idx.rename('grade').execute()
Index(['A', 'C', 'A', 'B'], dtype='object', name='grade')

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