关于如何在 python 中使用属性功能的真实示例？

Question

我对如何在 Python 中使用@property很感兴趣。 我已经阅读了 python 文档，我认为那里的示例只是一个玩具代码：

class C(object):
    def __init__(self):
        self._x = None

    @property
    def x(self):
        """I'm the 'x' property."""
        return self._x

    @x.setter
    def x(self, value):
        self._x = value

    @x.deleter
    def x(self):
        del self._x

我不知道包装充满属性装饰器的_x可以获得什么好处。 为什么不直接实现为：

class C(object):
    def __init__(self):
        self.x = None

我认为，属性功能在某些情况下可能很有用。 但当？ 有人可以给我一些现实世界的例子吗？

谢谢。

Answer 1

其他示例是对设置属性的验证/过滤（强制它们在界限内或可接受的范围内）以及对复杂或快速变化的术语的惰性评估。

隐藏在属性后面的复杂计算：

class PDB_Calculator(object):
    ...
    @property
    def protein_folding_angle(self):
        # number crunching, remote server calls, etc
        # all results in an angle set in 'some_angle'
        # It could also reference a cache, remote or otherwise,
        # that holds the latest value for this angle
        return some_angle

>>> f = PDB_Calculator()
>>> angle = f.protein_folding_angle
>>> angle
44.33276

验证：

class Pedometer(object)
    ...
    @property
    def stride_length(self):
        return self._stride_length

    @stride_length.setter
    def stride_length(self, value):
        if value > 10:
            raise ValueError("This pedometer is based on the human stride - a stride length above 10m is not supported")
        else:
            self._stride_length = value

Answer 2

一个简单的用例是设置一个只读实例属性，如您所知，在 python 中以一个下划线_x开头的变量名通常意味着它是私有的（内部使用），但有时我们希望能够读取实例属性而不是写下来，这样我们就可以为此使用property ：

>>> class C(object):

        def __init__(self, x):
            self._x = x

        @property
        def x(self):
            return self._x

>>> c = C(1)
>>> c.x
1
>>> c.x = 2
AttributeError        Traceback (most recent call last)

AttributeError: can't set attribute

Answer 3

看看这篇文章有一个非常实用的用途。 简而言之，它解释了在 Python 中，您通常可以放弃显式 getter/setter 方法，因为如果您在某个阶段需要它们，您可以使用property进行无缝实现。

Answer 4

我使用它的一件事是缓存存储在数据库中的查找缓慢但不变的值。 这适用于您的属性需要计算或其他一些您只想按需执行的长时间操作（例如数据库检查、网络通信）的任何情况。

class Model(object):

  def get_a(self):
    if not hasattr(self, "_a"):
      self._a = self.db.lookup("a")
    return self._a

  a = property(get_a)

这是在 web 应用程序中，其中任何给定的页面视图可能只需要此类特定属性，但底层对象本身可能具有多个此类属性 - 在构造时将它们全部初始化将是浪费的，并且属性允许我灵活地在其中属性是惰性的，哪些不是。

Answer 5

属性只是围绕字段的抽象，它使您可以更好地控制特定字段的操作方式和进行中间件计算。 很少想到的用法是验证和事先初始化和访问限制

@property
def x(self):
    """I'm the 'x' property."""
    if self._x is None:
        self._x = Foo()

    return self._x

Answer 6

与使用 setter 和 getter 相比，属性的另一个不错的特性是它们允许您继续在属性上使用 OP= 运算符（例如 +=、-=、*= 等），同时仍然保留任何验证、访问控制、缓存等setter 和 getter 将提供。

例如，如果您使用 setter setage(newage)和 getter getage()编写 class Person ，那么要增加您必须编写的年龄：

bob = Person('Robert', 25)
bob.setage(bob.getage() + 1)

但是如果你把age作为一个属性，你可以写得更干净：

bob.age += 1

Answer 7

通读答案和评论，主题似乎是答案似乎缺少一个简单但有用的例子。 我在这里包含了一个非常简单的例子，它演示了@property装饰器的简单使用。 这是一个 class 允许用户使用各种不同的单位（即in_feet或in_metres ）指定和获取距离测量值。

class Distance(object):
    def __init__(self):
        # This private attribute will store the distance in metres
        # All units provided using setters will be converted before
        # being stored
        self._distance = 0.0

    @property
    def in_metres(self):
        return self._distance

    @in_metres.setter
    def in_metres(self, val):
        try:
            self._distance = float(val)
        except:
            raise ValueError("The input you have provided is not recognised "
                             "as a valid number")

    @property
    def in_feet(self):
        return self._distance * 3.2808399

    @in_feet.setter
    def in_feet(self, val):
        try:
            self._distance = float(val) / 3.2808399
        except:
            raise ValueError("The input you have provided is not recognised "
                             "as a valid number")

    @property
    def in_parsecs(self):
        return self._distance * 3.24078e-17

    @in_parsecs.setter
    def in_parsecs(self, val):
        try:
            self._distance = float(val) / 3.24078e-17
        except:
            raise ValueError("The input you have provided is not recognised "
                             "as a valid number")

用法：

>>> distance = Distance()
>>> distance.in_metres = 1000.0
>>> distance.in_metres
1000.0
>>> distance.in_feet
3280.8399
>>> distance.in_parsecs
3.24078e-14

Answer 8

对您的问题的简短回答是，在您的示例中，没有任何好处。 您可能应该使用不涉及属性的表单。

存在属性的原因是，如果您的代码在未来发生变化，并且您突然需要对数据执行更多操作：缓存值、保护访问、查询一些外部资源......无论如何，您可以轻松修改 class 以添加 getter并在不更改接口的情况下设置数据，因此您不必在代码中找到访问数据的任何地方并对其进行更改。

Answer 9

是的，对于发布的原始示例，该属性的工作方式与简单地使用实例变量“x”完全相同。

这是关于 python 属性的最好的事情。 从外部看，它们的工作方式与实例变量完全一样。 这允许您使用类外部的实例变量。

这意味着您的第一个示例实际上可以使用实例变量。 如果事情发生了变化，然后您决定更改您的实现并且某个属性很有用，那么该属性的接口在 class 之外的代码中仍然是相同的。 从实例变量到属性的更改对 class 之外的代码没有影响。

许多其他语言和编程课程将指示程序员永远不要公开实例变量，而是使用“getters”和“setters”来从 class 外部访问任何值，即使是问题中引用的简单案例。

class 之外的代码使用多种语言（例如 Java）

object.get_i()
    #and
object.set_i(value)

#in place of (with python)
object.i
    #and 
object.i = value

在实现 class 时，有许多“getter”和“setter”与您的第一个示例完全相同：复制一个简单的实例变量。 这些 getter 和 setter 是必需的，因为如果 class 实现发生更改，则 class 之外的所有代码都需要更改。 但是 python 属性允许 class 之外的代码与实例变量相同。 因此，如果添加属性或具有简单的实例变量，则不需要更改 class 之外的代码。 因此，与大多数 Object 面向语言不同，对于您的简单示例，您可以使用实例变量而不是真正不需要的“getter”和“setter”，确保如果您将来更改为属性，代码使用你的 class 不需要改变。

这意味着您只需要在存在复杂行为的情况下创建属性，并且对于非常常见的简单情况，如问题中所述，只需要一个简单的实例变量，您可以只使用实例变量。

Answer 10

许多人一开始没有注意到的是，您可以创建自己的属性子类。 我发现这对于公开只读 object 属性或您可以读写但不能删除的属性非常有用。 它也是包装功能的绝佳方式，例如跟踪对 object 字段的修改。

class reader(property):
    def __init__(self, varname):
        _reader = lambda obj: getattr(obj, varname)
        super(reader, self).__init__(_reader)

class accessor(property):
    def __init__(self, varname, set_validation=None):
        _reader = lambda obj: getattr(obj, varname)
        def _writer(obj, value):
            if set_validation is not None:
               if set_validation(value):
                  setattr(obj, varname, value)
        super(accessor, self).__init__(_reader, _writer)

#example
class MyClass(object):
   def __init__(self):
     self._attr = None

   attr = reader('_attr')