python - 使实例中的选定属性成为只读的最简单、最简洁的方法是什么？

Question

在 Python 中，我想让类的选定实例属性对类外的代码只读。我希望外部代码无法更改属性，除非间接通过调用实例上的方法。我希望语法简洁。什么是最好的方法？（我在下面给出我目前的最佳答案......）

Answer 1

你应该使用@property装饰器。

>>> class a(object):
...     def __init__(self, x):
...             self.x = x
...     @property
...     def xval(self):
...             return self.x
... 
>>> b = a(5)
>>> b.xval
5
>>> b.xval = 6
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
AttributeError: can't set attribute

Answer 2

class C(object):

    def __init__(self):

        self.fullaccess = 0
        self.__readonly = 22 # almost invisible to outside code...

    # define a publicly visible, read-only version of '__readonly':
    readonly = property(lambda self: self.__readonly)

    def inc_readonly( self ):
        self.__readonly += 1

c=C()

# prove regular attribute is RW...
print "c.fullaccess = %s" % c.fullaccess
c.fullaccess = 1234
print "c.fullaccess = %s" % c.fullaccess

# prove 'readonly' is a read-only attribute
print "c.readonly = %s" % c.readonly
try:
    c.readonly = 3
except AttributeError:
    print "Can't change c.readonly"
print "c.readonly = %s" % c.readonly

# change 'readonly' indirectly...
c.inc_readonly()
print "c.readonly = %s" % c.readonly

这输出：

$ python ./p.py
c.fullaccess = 0
c.fullaccess = 1234
c.readonly = 22
Can't change c.readonly
c.readonly = 22
c.readonly = 23

我的手指痒得能说

    @readonly
    self.readonly = 22

即，在属性上使用装饰器。会很干净...

Answer 3

就是这样：

class whatever(object):
  def __init__(self, a, b, c, ...):
    self.__foobar = 1
    self.__blahblah = 2

  foobar = property(lambda self: self.__foobar)
  blahblah = property(lambda self: self.__blahblah)

（假设foobar和blahblah是您希望只读的属性。）在属性名称前添加两个下划线可以有效地将其隐藏在类外部，因此无法从外部访问内部版本。这仅适用于从 object 继承的新型类，因为它依赖于property.

另一方面......这是一件非常愚蠢的事情。保持变量私有似乎是来自 C++ 和 Java 的一种痴迷。您的用户应该使用您的类的公共接口，因为它设计得很好，而不是因为您强迫他们这样做。

编辑：看起来凯文已经发布了类似的版本。

Answer 4

没有真正的方法可以做到这一点。有一些方法可以让它变得更“困难”，但没有完全隐藏、无法访问的类属性的概念。

如果不能信任使用您的课程的人遵循 API 文档，那么这是他们自己的问题。保护人们不做愚蠢的事情只是意味着他们会做更精细、更复杂和更具破坏性的愚蠢事情来尝试做他们一开始就不应该做的事情。

Answer 5

您可以使用元类将遵循命名约定的方法（或类属性）自动包装到属性中（无耻地取自Python 2.2 中的统一类型和类：

class autoprop(type):
    def __init__(cls, name, bases, dict):
        super(autoprop, cls).__init__(name, bases, dict)
        props = {}
        for name in dict.keys():
            if name.startswith("_get_") or name.startswith("_set_"):
                props[name[5:]] = 1
        for name in props.keys():
            fget = getattr(cls, "_get_%s" % name, None)
            fset = getattr(cls, "_set_%s" % name, None)
            setattr(cls, name, property(fget, fset))

这允许您使用：

class A:
    __metaclass__ = autosuprop
    def _readonly(self):
        return __x

Answer 6

我知道威廉凯勒是迄今为止最干净的解决方案..但这是我想出的东西..

class readonly(object):
    def __init__(self, attribute_name):
        self.attribute_name = attribute_name

    def __get__(self, instance, instance_type):
        if instance != None:
            return getattr(instance, self.attribute_name)
        else:
            raise AttributeError("class %s has no attribute %s" % 
                                 (instance_type.__name__, self.attribute_name))

    def __set__(self, instance, value):
        raise AttributeError("attribute %s is readonly" % 
                              self.attribute_name)

这是使用示例

class a(object):
    def __init__(self, x):
        self.x = x
    xval = readonly("x")

不幸的是，这个解决方案不能处理私有变量（__ 命名变量）。