我很好奇在 Python 中定义值对象的好方法。根据维基百科:“value object 是一个小对象，表示一个简单实体，其相等性不基于身份:即两个值对象在具有相同值时相等，不一定是同一对象”。在 Python 中，这本质上意味着重新定义 __eq__ 和 __hash__ 方法，以及不变性。

标准 namedtuple 看起来几乎是完美的解决方案，除了它们不能很好地与 PyCharm 等现代 Python IDE 配合使用。我的意思是 IDE 不会真正提供有关定义为 namedtuple 的类的任何有用见解。虽然可以使用如下技巧将文档字符串附加到此类:

class Point2D(namedtuple("Point2D", "x y")):
    """Class for immutable value objects"""
    pass

根本没有地方可以放置构造函数参数的描述并指定它们的类型。 PyCharm 足够聪明，可以猜测 Point2D“构造函数”的参数，但在类型方面它是盲目的。

此代码已推送一些类型信息，但不是很有用:

class Point2D(namedtuple("Point2D", "x y")):
    """Class for immutable value objects"""
    def __new__(cls, x, y):
        """
        :param x: X coordinate
        :type x: float

        :param y: Y coordinate
        :type y: float

        :rtype: Point2D
        """
        return super(Point2D, cls).__new__(cls, x, y)

point = Point2D(1.0, 2.0)

PyCharm 在构造新对象时会看到类型，但不会掌握 point.x 和 point.y 是 float ，因此无助于检测它们的误用。而且我也不喜欢在常规基础上重新定义“魔术”方法的想法。

所以我正在寻找的东西将是:

• 就像普通的 Python 类或 namedtuple 一样容易定义
• 提供值语义(平等、哈希、不变性)
• 易于以与 IDE 兼容的方式记录

理想的解决方案可能是这样的:

class Point2D(ValueObject):
    """Class for immutable value objects"""
    def __init__(self, x, y):
        """
        :param x: X coordinate
        :type x: float

        :param y: Y coordinate
        :type y: float
        """
        super(Point2D, self).__init__(cls, x, y)

或者说:

class Point2D(object):
    """Class for immutable value objects"""

    __metaclass__ = ValueObject

    def __init__(self, x, y):
        """
        :param x: X coordinate
        :type x: float

        :param y: Y coordinate
        :type y: float
        """
        pass

我试图找到类似的东西但没有成功。我认为在自己实现之前寻求帮助是明智的。

更新: 在 user4815162342 的帮助下，我设法想出了一些可行的方法。这是代码:

class ValueObject(object):
    __slots__ = ()

    def __repr__(self):
        attrs = ' '.join('%s=%r' % (slot, getattr(self, slot)) for slot in self.__slots__)
        return '<%s %s>' % (type(self).__name__, attrs)

    def _vals(self):
        return tuple(getattr(self, slot) for slot in self.__slots__)

    def __eq__(self, other):
        if not isinstance(other, ValueObject):
            return NotImplemented
        return self.__slots__ == other.__slots__ and self._vals() == other._vals()

    def __ne__(self, other):
        return not self == other

    def __hash__(self):
        return hash(self._vals())

    def __getstate__(self):
        """
        Required to pickle classes with __slots__
        Must be consistent with __setstate__
        """
        return self._vals()

    def __setstate__(self, state):
        """
        Required to unpickle classes with __slots__
        Must be consistent with __getstate__
        """
        for slot, value in zip(self.__slots__, state):
            setattr(self, slot, value)

这远非理想的解决方案。类声明如下所示:

class X(ValueObject):
    __slots__ = "a", "b", "c"

    def __init__(self, a, b, c):
        """
        :param a:
        :type a: int
        :param b:
        :type b: str
        :param c:
        :type c: unicode
        """
        self.a = a
        self.b = b
        self.c = c

列出所有属性总共四次:在 __slots__ 中，在 ctor arguments 中，在 docstring 中和在 ctor body 中。到目前为止，我不知道如何让它不那么尴尬。

最佳答案

3.5 版的新功能:typing 模块和 NamedTuple

在版本 3.5 中，typing模块已添加，在其中，您将找到一个完全符合您需求的类。

新NamedTuple

它的工作方式与您预期的一样:

• 简单的类型定义:

  from typing import NamedTuple
  class DownloadableFile(NamedTuple):
      file_path: str
      download_url: str
  

• 在 PyCharm 中识别:

  

注意:
截至今天，API 仍在 provisional stage 中。 .这意味着它不能保证在发布新版本时向后兼容。不过，预计不会更改界面。我个人的看法是:考虑到设计的简单性，如果有改变，我相信这将是一个简单的重构；)

关于python - 如何在 Python 中定义 PyCharm 友好的值对象？，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/19508572/