写入时复制 (CoW)#

注意

写入时复制将在 pandas 3.0 中成为默认设置。我们建议现在就开启它,以从所有改进中获益。

写入时复制最初是在 1.5.0 版本中引入的。从 2.0 版本开始,通过 CoW 实现的大多数优化都已实现并得到支持。从 pandas 2.1 开始,所有可能的优化都得到支持。

CoW 将在 3.0 版本中默认启用。

CoW 将带来更可预测的行为,因为不可能用一个语句更新多个对象,例如索引操作或方法不会产生副作用。此外,通过尽可能延迟复制,平均性能和内存使用将得到改善。

之前的行为#

pandas 的索引行为很难理解。一些操作返回视图,而另一些则返回副本。根据操作的结果,修改一个对象可能会意外地修改另一个对象。

In [1]: df = pd.DataFrame({"foo": [1, 2, 3], "bar": [4, 5, 6]})

In [2]: subset = df["foo"]

In [3]: subset.iloc[0] = 100

In [4]: df
Out[4]: 
   foo  bar
0  100    4
1    2    5
2    3    6

修改 subset,例如更新其值,也会更新 df。确切的行为难以预测。写入时复制解决了意外修改多个对象的问题,它明确禁止这样做。启用 CoW 后,df 将保持不变。

In [5]: pd.options.mode.copy_on_write = True

In [6]: df = pd.DataFrame({"foo": [1, 2, 3], "bar": [4, 5, 6]})

In [7]: subset = df["foo"]

In [8]: subset.iloc[0] = 100

In [9]: df
Out[9]: 
   foo  bar
0    1    4
1    2    5
2    3    6

以下部分将解释这意味着什么以及它如何影响现有应用。

迁移到写入时复制#

写入时复制将是 pandas 3.0 中的默认且唯一模式。这意味着用户需要迁移他们的代码以符合 CoW 规则。

pandas 中的默认模式将对某些会主动改变行为并因此改变用户预期行为的情况发出警告。

我们添加了另一种模式,例如:

pd.options.mode.copy_on_write = "warn"

它将对每个在 CoW 下会改变行为的操作发出警告。我们预计这种模式会非常“吵闹”,因为许多我们不认为会影响用户的情况也会发出警告。我们建议检查此模式并分析警告,但并非必须解决所有这些警告。以下列表中的前两项是使现有代码在 CoW 下工作唯一需要解决的情况。

以下几项描述了用户可见的更改

链式赋值将永远不会工作

应使用 loc 作为替代方案。有关更多详细信息,请参阅链式赋值部分

访问 pandas 对象的底层数组将返回一个只读视图

In [10]: ser = pd.Series([1, 2, 3])

In [11]: ser.to_numpy()
Out[11]: array([1, 2, 3])

此示例返回一个 NumPy 数组,它是 Series 对象的视图。此视图可以修改,从而也会修改 pandas 对象。这不符合 CoW 规则。返回的数组被设置为不可写以防止此行为。创建此数组的副本允许修改。如果不再关心 pandas 对象,您也可以再次使数组可写。

有关更多详细信息,请参阅关于只读 NumPy 数组的部分。

一次只更新一个 pandas 对象

以下代码片段在没有 CoW 的情况下同时更新 dfsubset

In [12]: df = pd.DataFrame({"foo": [1, 2, 3], "bar": [4, 5, 6]})

In [13]: subset = df["foo"]

In [14]: subset.iloc[0] = 100

In [15]: df
Out[15]: 
   foo  bar
0    1    4
1    2    5
2    3    6

在 CoW 下这不再可能,因为 CoW 规则明确禁止这样做。这包括将单个列作为 Series 更新并依赖更改传播回父级 DataFrame。如果需要此行为,此语句可以使用 lociloc 重写为单个语句。DataFrame.where() 是这种情况下的另一个合适替代方案。

使用 inplace 方法更新从 DataFrame 中选择的列也将不再起作用。

In [16]: df = pd.DataFrame({"foo": [1, 2, 3], "bar": [4, 5, 6]})

In [17]: df["foo"].replace(1, 5, inplace=True)

In [18]: df
Out[18]: 
   foo  bar
0    1    4
1    2    5
2    3    6

这是链式赋值的另一种形式。这通常可以重写为 2 种不同的形式

In [19]: df = pd.DataFrame({"foo": [1, 2, 3], "bar": [4, 5, 6]})

In [20]: df.replace({"foo": {1: 5}}, inplace=True)

In [21]: df
Out[21]: 
   foo  bar
0    5    4
1    2    5
2    3    6

另一种不同的替代方案是不使用 inplace

In [22]: df = pd.DataFrame({"foo": [1, 2, 3], "bar": [4, 5, 6]})

In [23]: df["foo"] = df["foo"].replace(1, 5)

In [24]: df
Out[24]: 
   foo  bar
0    5    4
1    2    5
2    3    6

构造函数现在默认复制 NumPy 数组

如果未另行指定,Series 和 DataFrame 构造函数现在将默认复制 NumPy 数组。这样更改是为了避免在 NumPy 数组在 pandas 之外被 inplace 修改时改变 pandas 对象。您可以设置 copy=False 来避免此复制。

描述#

CoW 意味着任何以任何方式派生自另一个 DataFrame 或 Series 的对象始终表现为副本。因此,我们只能通过修改对象本身来更改对象的值。CoW 不允许 inplace 更新与另一个 DataFrame 或 Series 对象共享数据的 DataFrame 或 Series。

这避免了修改值时的副作用,因此,大多数方法可以避免实际复制数据,并且仅在必要时触发复制。

以下示例将在 CoW 下进行 inplace 操作

In [25]: df = pd.DataFrame({"foo": [1, 2, 3], "bar": [4, 5, 6]})

In [26]: df.iloc[0, 0] = 100

In [27]: df
Out[27]: 
   foo  bar
0  100    4
1    2    5
2    3    6

对象 df 不与任何其他对象共享任何数据,因此更新值时不会触发复制。相反,以下操作在 CoW 下会触发数据复制

In [28]: df = pd.DataFrame({"foo": [1, 2, 3], "bar": [4, 5, 6]})

In [29]: df2 = df.reset_index(drop=True)

In [30]: df2.iloc[0, 0] = 100

In [31]: df
Out[31]: 
   foo  bar
0    1    4
1    2    5
2    3    6

In [32]: df2
Out[32]: 
   foo  bar
0  100    4
1    2    5
2    3    6

reset_index 在 CoW 下返回一个惰性副本,而在没有 CoW 的情况下它会复制数据。由于 dfdf2 这两个对象共享相同的数据,因此在修改 df2 时会触发复制。对象 df 仍然具有与最初相同的值,而 df2 已被修改。

如果在执行 reset_index 操作后不再需要对象 df,您可以通过将 reset_index 的输出赋值给同一变量来模拟类似 inplace 的操作

In [33]: df = pd.DataFrame({"foo": [1, 2, 3], "bar": [4, 5, 6]})

In [34]: df = df.reset_index(drop=True)

In [35]: df.iloc[0, 0] = 100

In [36]: df
Out[36]: 
   foo  bar
0  100    4
1    2    5
2    3    6

一旦 reset_index 的结果被重新赋值,初始对象就会超出作用域,因此 df 不会与任何其他对象共享数据。修改对象时无需复制。这通常适用于 写入时复制优化 中列出的所有方法。

以前,在对视图进行操作时,视图和父对象都会被修改

In [37]: with pd.option_context("mode.copy_on_write", False):
   ....:     df = pd.DataFrame({"foo": [1, 2, 3], "bar": [4, 5, 6]})
   ....:     view = df[:]
   ....:     df.iloc[0, 0] = 100
   ....: 

In [38]: df
Out[38]: 
   foo  bar
0  100    4
1    2    5
2    3    6

In [39]: view
Out[39]: 
   foo  bar
0  100    4
1    2    5
2    3    6

df 更改时,CoW 会触发复制,以避免同时也修改 view

In [40]: df = pd.DataFrame({"foo": [1, 2, 3], "bar": [4, 5, 6]})

In [41]: view = df[:]

In [42]: df.iloc[0, 0] = 100

In [43]: df
Out[43]: 
   foo  bar
0  100    4
1    2    5
2    3    6

In [44]: view
Out[44]: 
   foo  bar
0    1    4
1    2    5
2    3    6

链式赋值#

链式赋值指的是通过两个连续的索引操作更新对象的技术,例如:

In [45]: with pd.option_context("mode.copy_on_write", False):
   ....:     df = pd.DataFrame({"foo": [1, 2, 3], "bar": [4, 5, 6]})
   ....:     df["foo"][df["bar"] > 5] = 100
   ....:     df
   ....: 

在列 bar 大于 5 的地方更新列 foo。但这违反了 CoW 原则,因为它必须一步修改视图 df["foo"]df。因此,启用 CoW 后,链式赋值将始终不起作用,并会引发 ChainedAssignmentError 警告。

In [46]: df = pd.DataFrame({"foo": [1, 2, 3], "bar": [4, 5, 6]})

In [47]: df["foo"][df["bar"] > 5] = 100

使用写入时复制,这可以通过使用 loc 来完成。

In [48]: df.loc[df["bar"] > 5, "foo"] = 100

只读 NumPy 数组#

如果数组与初始 DataFrame 共享数据,访问 DataFrame 的底层 NumPy 数组将返回一个只读数组。

如果初始 DataFrame 包含多个数组,则该数组是副本

In [49]: df = pd.DataFrame({"a": [1, 2], "b": [1.5, 2.5]})

In [50]: df.to_numpy()
Out[50]: 
array([[1. , 1.5],
       [2. , 2.5]])

如果 DataFrame 仅包含一个 NumPy 数组,则该数组与 DataFrame 共享数据

In [51]: df = pd.DataFrame({"a": [1, 2], "b": [3, 4]})

In [52]: df.to_numpy()
Out[52]: 
array([[1, 3],
       [2, 4]])

此数组是只读的,这意味着它不能进行 inplace 修改

In [53]: arr = df.to_numpy()

In [54]: arr[0, 0] = 100
---------------------------------------------------------------------------
ValueError                                Traceback (most recent call last)
Cell In[54], line 1
----> 1 arr[0, 0] = 100

ValueError: assignment destination is read-only

对于 Series 也是如此,因为 Series 始终由单个数组组成。

对此有两种潜在的解决方案

  • 如果要避免更新与您的数组共享内存的 DataFrame,请手动触发复制。

  • 使数组可写。这是一种性能更好的解决方案,但它绕过了写入时复制规则,因此应谨慎使用。

In [55]: arr = df.to_numpy()

In [56]: arr.flags.writeable = True

In [57]: arr[0, 0] = 100

In [58]: arr
Out[58]: 
array([[100,   3],
       [  2,   4]])

应避免的模式#

如果两个对象共享相同的数据,并且您正在 inplace 修改其中一个对象,则不会执行防御性复制。

In [59]: df = pd.DataFrame({"a": [1, 2, 3], "b": [4, 5, 6]})

In [60]: df2 = df.reset_index(drop=True)

In [61]: df2.iloc[0, 0] = 100

这会创建两个共享数据的对象,因此 setitem 操作会触发复制。如果不再需要初始对象 df,则无需这样做。简单地重新赋值给同一变量将使对象持有的引用失效。

In [62]: df = pd.DataFrame({"a": [1, 2, 3], "b": [4, 5, 6]})

In [63]: df = df.reset_index(drop=True)

In [64]: df.iloc[0, 0] = 100

在此示例中无需复制。创建多个引用会使不必要的引用保持活跃,从而会影响写入时复制的性能。

写入时复制优化#

一种新的惰性复制机制,它将复制推迟到被操作对象被修改时才进行,并且仅当该对象与另一个对象共享数据时才触发。此机制已添加到不需要复制底层数据的方法中。常见示例包括 axis=1 时的 DataFrame.drop()DataFrame.rename()

当启用写入时复制时,这些方法返回视图,与常规执行相比,这提供了显著的性能改进。

如何启用 CoW#

写入时复制可以通过配置选项 copy_on_write 启用。该选项可以通过以下任一方式__全局__开启:

In [65]: pd.set_option("mode.copy_on_write", True)

In [66]: pd.options.mode.copy_on_write = True