pandas.Index.rename#

Index.rename(name, *, inplace=False)[源代码][源代码]#

更改索引或 MultiIndex 名称。

能够在不设置级别的情况下设置新名称。默认返回新索引。名称的长度必须与 MultiIndex 中的级别数匹配。

参数:

名字标签或标签列表: 要设置的名称。
inplace布尔值, 默认为 False: 直接修改对象，而不是创建新的 Index 或 MultiIndex。

返回:

索引或无: 与调用者相同类型，如果 inplace=True 则为 None。

参见

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