pandas.DataFrame.rename_axis#

DataFrame.rename_axis(mapper=<no_default>, *, index=<no_default>, columns=<no_default>, axis=0, copy=<no_default>, inplace=False)[源代码]#

设置索引或列的轴名称。

参数:

mapper标量, 类列表, 可选

设置轴名称属性的值。

使用 mapper 和 axis 来指定 mapper 要针对的轴，或者使用 index 和/或 columns。

索引标量、类似列表、类似字典或函数，可选

对该轴值应用的标量、类列表、类字典或函数变换。

列标量、类似列表、类似字典或函数，可选

对该轴值应用的标量、类列表、类字典或函数变换。

轴{0 或 ‘index’, 1 或 ‘columns’}, 默认 0

要重命名的轴。

复制布尔值, 默认为 False

同时复制底层数据。

备注

copy 关键字将在 pandas 3.0 中改变行为。写时复制将默认启用，这意味着所有带有 copy 关键字的方法将使用延迟复制机制来推迟复制并忽略 copy 关键字。copy 关键字将在未来版本的 pandas 中被移除。

通过启用写时复制 pd.options.mode.copy_on_write = True，您已经可以获得未来的行为和改进。

自 3.0.0 版本弃用.

inplace布尔值, 默认为 False

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

返回:

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

参见

Series.rename: 修改系列索引标签或名称。
DataFrame.rename: 修改 DataFrame 索引标签或名称。
Index.rename: 在索引上设置新名称。

备注

DataFrame.rename_axis 支持两种调用约定

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

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

第二种调用约定将修改相应索引的名称，如果 mapper 是一个列表或标量。然而，如果 mapper 是类字典或函数，它将使用修改轴标签的已弃用行为。

我们*强烈*建议使用关键字参数来明确你的意图。

示例

DataFrame

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

MultiIndex

>>> df.index = pd.MultiIndex.from_product(
...     [["mammal"], ["dog", "cat", "monkey"]], names=["type", "name"]
... )
>>> df
limbs          num_legs  num_arms
type   name
mammal dog            4         0
       cat            4         0
       monkey         2         2

>>> df.rename_axis(index={"type": "class"})
limbs          num_legs  num_arms
class  name
mammal dog            4         0
       cat            4         0
       monkey         2         2

>>> df.rename_axis(columns=str.upper)
LIMBS          num_legs  num_arms
type   name
mammal dog            4         0
       cat            4         0
       monkey         2         2