return Python class 方法调用结果的常用方法是什么？

Question

我在 Python 中有一个 class 用于训练给定数据的模型：

class Model(object):
    def __init__(self, data):
        self.data = data
        self.result = None

    def train(self):
        ... some codes for training the model ...
        self.result = ...

创建模型对象后，

myModel = Model(myData)

模型未经过训练。然后我可以调用 train 方法来启动训练：

myModel.train()

然后 myModel.result 将就地更新。

此外，我可以将 train 方法重写为：

def train(self):
    ... some code for training the model ...
    result = ...
    # avoid update in-place
    trainedModel = copy.copy(self)
    trainedModel.result = result
    return trainedModel

这样，通过调用myTrainedModel = myModel.train()我得到了一个新对象，并且原来myModel的状态没有改变

我的问题是：将方法的返回结果存储在class中，哪种方法更常见？

Answer 1

My question is: Which is a more common way to store the returned result from a method in a class?

这里真的不好说。您的示例将其缩小到一个非常具体的用例，即使范围更广，也可能找不到完全没有主观性的答案。

不过，我或许可以提供一些信息来帮助您做出决定。

纯函数

纯函数是不会触发副作用的函数。他们不修改函数之外的任何状态。它们通常被认为是最容易正确使用的函数类型，因为副作用是开发中的常见触发点 ("Which part of this system caused this state to change to this?") 具有零的函数副作用几乎不会被绊倒。

你的第二个版本是一个纯函数。它没有副作用：它 return 是一个新训练的 Model。它不会影响任何已经存在的东西。

纯函数本身也是线程安全的。由于它们不修改共享状态，因此它们对并发范例非常友好。

副作用

然而，触发副作用的功能在许多程序中通常是实际必需的。从单线程效率的角度来看，任何面临修改复杂状态或 returning 一个全新状态之间的选择的函数都可能因后者而受到严重瓶颈。

想象一下，作为一个粗略的例子，一个函数在图像上绘制一个像素 return 绘制一个带有像素的全新图像，而不是修改您传入的图像。这往往会立即成为一个重要的瓶颈。另一方面，如果我们 return 的结果并不复杂（例如：只是一个整数或非常简单的聚合），通常纯函数甚至更快。

因此，在某些情况下，当结果复杂且创建成本高时，触发副作用的函数（理想情况下只有一个逻辑副作用，以避免成为令人困惑的错误来源）通常是实际必需的。

纯或"Impure"

所以这里的选择归结为纯函数或具有一个副作用的 "impure" 函数。由于我们处理的是面向对象的场景，另一种看待这个问题的方法是可变性与不变性（这通常与纯函数和 "impure" 函数有相似的区别）。我们可以训练 Model 或创建和 return 训练有素的 Model 而无需触及现有的。

选择哪个可能 "better" 取决于您的追求。如果安全性和可维护性是您的目标，那么纯版本可能会有所帮助。如果创建和 return 创建新模型的成本很高，而效率是您的主要目标，那么训练现有模型可能会帮助您避免瓶颈。

如有疑问，我一般建议使用纯净版。提高生产率的安全性和可维护性等品质往往先于担心性能。稍后您可以获取一个分析器并深入到您的热点，如果您发现 return 使用全新的训练模型是一个瓶颈，您可以添加一种新方法来就地训练您的模型用于最关键的代码路径。

return Python class 方法调用结果的常用方法是什么？

What is a common way to return the result of method call in Python class?

python

coding-style

class