maxframe.dataframe.DataFrame.rename_axis#

DataFrame.rename_axis(mapper=<no_default>, index=<no_default>, columns=<no_default>, axis=0, copy=True, inplace=False)#

设置索引或列的轴名称。

参数:

  • mapper (scalar, list-like, optional) -- 用于设置轴名称属性的值。

  • index (scalar, list-like, dict-like or function, optional) -- 应用于该轴值的标量、列表类、字典类或函数变换。注意，如果对象是 Series，则不允许使用 columns 参数。此参数仅适用于 DataFrame 类型对象。使用 mapper 和 axis 来指定要应用 mapper 的轴，或者使用 index 和/或 columns。

  • columns (scalar, list-like, dict-like or function, optional) -- 应用于该轴值的标量、列表类、字典类或函数变换。注意，如果对象是 Series，则不允许使用 columns 参数。此参数仅适用于 DataFrame 类型对象。使用 mapper 和 axis 来指定要应用 mapper 的轴，或者使用 index 和/或 columns。

  • axis ({0 or 'index', 1 or 'columns'}, default 0) -- 要重命名的轴。

  • copy (bool, default True) -- 同时复制底层数据。

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

返回:

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

返回类型:

Series, DataFrame, or None

参见

Series.rename

更改 Series 的索引标签或名称。

DataFrame.rename

更改 DataFrame 的索引标签或名称。

Index.rename

为索引设置新名称。

备注

DataFrame.rename_axis 支持两种调用方式

  • (index=index_mapper, columns=columns_mapper, ...)

  • (mapper, axis={'index', 'columns'}, ...)

第一种调用方式只会修改索引名称和/或作为列的 Index 对象的名称。在此情况下，参数 copy 将被忽略。

第二种调用方式在 mapper 是列表或标量时，会修改相应索引的名称。但如果 mapper 是字典类或函数，则会使用已被弃用的行为，即修改轴 标签。

我们 强烈 推荐使用关键字参数来明确你的意图。

示例

Series

>>> import maxframe.dataframe as md
>>> s = md.Series(["dog", "cat", "monkey"])
>>> s.execute()
0       dog
1       cat
2    monkey
dtype: object
>>> s.rename_axis("animal").execute()
animal
0    dog
1    cat
2    monkey
dtype: object

DataFrame

>>> df = md.DataFrame({"num_legs": [4, 4, 2],
...                    "num_arms": [0, 0, 2]},
...                   ["dog", "cat", "monkey"])
>>> df.execute()
        num_legs  num_arms
dog            4         0
cat            4         0
monkey         2         2
>>> df = df.rename_axis("animal")
>>> df.execute()
        num_legs  num_arms
animal
dog            4         0
cat            4         0
monkey         2         2
>>> df = df.rename_axis("limbs", axis="columns")
>>> df.execute()
limbs   num_legs  num_arms
animal
dog            4         0
cat            4         0
monkey         2         2