在熊猫中理解inplace=True

Question

在熊猫库中，很多时候都有一个更改对象的选项，例如使用以下语句...

df.dropna(axis='index', how='all', inplace=True)

我很好奇在传递inplace=True与inplace=False时返回什么以及如何处理对象。

当inplace=True时，是否所有操作都在修改self？当inplace=False立即创建一个新对象，比如new_df=self，然后返回new_df？

Answer 1

我使用它的方式是

# Have to assign back to dataframe (because it is a new copy)
df = df.some_operation(inplace=False) 

或

# No need to assign back to dataframe (because it is on the same copy)
df.some_operation(inplace=True)

结论：

 if inplace is False
      Assign to a new variable;
 else
      No need to assign

Answer 2

• inplace，与名称的含义相反，通常不会阻止创建副本，并且（几乎）从不提供任何性能优势
• inplace不适用于方法链接
• inplace如果在DataFrame列上使用，可能会导致SettinSusCopyWarning，并且可能会阻止操作进行，从而导致代码中难以调试的错误

上面的痛点是初学者的常见陷阱，因此删除此选项将简化API。

我不建议设置此参数，因为它用处不大。请参阅这个GitHub问题，它提议在api范围内弃用inplace参数。

一种常见的误解是，使用inplace=True将导致更高效或优化的代码。实际上，使用inplace=True绝对没有性能优势。就地版本和异地版本都会创建数据的副本，就地版本会自动将副本分配回。

inplace=True是初学者的一个常见陷阱。例如，它可以触发SettinSusCopyWarning：

df = pd.DataFrame({'a': [3, 2, 1], 'b': ['x', 'y', 'z']})

df2 = df[df['a'] > 1]
df2['b'].replace({'x': 'abc'}, inplace=True)
# SettingWithCopyWarning: 
# A value is trying to be set on a copy of a slice from a DataFrame

使用inplace=True调用DataFrame列上的函数可能有效，也可能无效。当涉及链式索引时尤其如此。

似乎上述问题还不够，inplace=True也会阻碍方法链接。对比

result = df.some_function1().reset_index().some_function2()

而不是

temp = df.some_function1()
temp.reset_index(inplace=True)
result = temp.some_function2()

前者有助于更好的代码组织和可读性。

另一个支持性声明是，set_axis的API最近发生了更改，使得inplace默认值从True切换到False。见GH27600。干得好，开发人员！

Answer 3

当传递inplace=True时，数据将被就地重命名（不返回任何内容），因此您可以使用：

df.an_operation(inplace=True)

当传递inplace=False时（这是默认值，因此没有必要），执行操作并返回对象的副本，因此您可以使用：

df = df.an_operation(inplace=False)