Python 中的“公共”或“私有”属性？什么是最好的方法？

Question

在 Python 中，我有以下示例类：

class Foo:
    self._attr = 0

    @property
    def attr(self):
        return self._attr

    @attr.setter
    def attr(self, value):
        self._attr = value

    @attr.deleter
    def attr(self):
        del self._attr

如您所见，我有一个简单的“私有”属性“_attr”和一个可以访问它的属性。有很多代码来声明一个简单的私有属性，我认为这样声明所有属性是不尊重“KISS”理念的。

那么，如果我不需要特定的 getter/setter/deleter，为什么不将我的所有属性声明为公共属性呢？

我的答案是： 因为封装原理（OOP）另有规定！

最好的方法是什么？

Answer 1

Python 没有公共或私有属性。所有代码都可以访问所有属性。

self.attr = 0 #Done

您的方法不会以任何方式将 _attr 设为私有，它只是有点混淆。

Answer 2

通常，Python 代码会努力遵守Uniform Access Principle。具体来说，接受的方法是：

• 直接公开您的实例变量，例如允许foo.x = 0，而不是foo.set_x(0)
• 如果您需要将访问封装在方法中，无论出于何种原因，请使用@property，它保留了访问语义。也就是说，foo.x = 0 现在调用 foo.set_x(0)。

这种方法的主要优点是调用者可以这样做：

foo.x += 1

即使代码可能真的在做：

foo.set_x(foo.get_x() + 1)

第一个语句的可读性大大提高。然而，通过属性，您可以（在开始时或稍后）添加通过第二种方法获得的访问控制。

还要注意，以单个下划线开头的实例变量通常是私有的。也就是说，下划线向其他开发人员发出信号，表明您认为该值是私有的，他们不应该直接混淆它；但是，语言中的任何内容都阻止他们直接使用它。

如果您使用双前导下划线（例如，__x），Python 会稍微混淆名称。但是，该变量仍然可以通过其混淆名称从类外部访问。这不是真正的私人。它只是有点……更不透明。并且有反对使用双下划线的有效论据；一方面，它会使调试变得更加困难。

Answer 3

在 Python 中，除非您需要属性的特殊行为，否则无需将其隐藏在访问器方法后面。如果属性仅供内部使用，请在其前面加上下划线。

Answer 4

属性的好处是它们为您提供了一个非常酷的界面来使用。有时根据其他一些属性推导出一个属性是很方便的（即 BMI 由体重和身高定义）。界面的用户当然不必知道这一点。

我更喜欢这种方式，而不是像 Java ie 那样具有显式的 getter 和 setter。好多了:)

Answer 5

很简单，OOP 原则是错误的。为什么这是一个很长的讨论，会导致激烈的争吵，并且可能与本网站无关。 :-)

在 Python 中没有私有属性，您无法保护它们，这从来都不是真正的问题。所以不要。简单！ :)

那么问题来了：你是否应该有一个前导下划线。在您在这里的示例中，您绝对不应该这样做。 Python 中的前导下划线是一种约定，表明某些东西是内部的，而不是 API 的一部分，您应该自担风险使用它。这显然不是这里的情况，但它是一种常见且有用的约定。

Answer 6

正如其他人所说，Python 中的私有属性只是一种约定。在绑定、修改或删除属性时，应使用property 语法进行特殊处理。 Python 的美妙之处在于，您可以从使用普通属性绑定开始，例如，self.attr = 0，如果以后您决定将 attr 的值限制为 0 <= attr <=100，则可以设置为 attr一个属性并定义一个方法来确保此条件为真，而无需更改任何用户代码。

Answer 7

要将属性设为私有，您只需 self.__attr

class Foo:
    self.__attr = 0

    @property
    def attr(self):
        return self._attr

    @attr.setter
    def attr(self, value):
        self._attr = value

    @attr.deleter
    def attr(self):
        del self._attr

Answer 8

“dunder”（双下划线，__）前缀阻止访问属性，除非通过访问器。

class Foo():
    def __init__(self):
        self.__attr = 0

    @property
    def attr(self):  
        return self.__attr

    @attr.setter
    def attr(self, value):
        self.__attr = value

    @attr.deleter
    def attr(self):
        del self.__attr

一些例子：

>>> f = Foo()
>>> f.__attr                          # Not directly accessible.
Traceback (most recent call last):
    File "<input>", line 1, in <module>
AttributeError: 'Foo' object has no attribute '__attr'
>>> '__attr' in f.__dir__()           # Not listed by __dir__()
False
>>> f.__getattribute__('__attr')      # Not listed by __getattribute__()
Traceback (most recent call last):
    File "<input>", line 1, in <module>
AttributeError: 'Foo' object has no attribute '__attr'
>>> f.attr                            # Accessible by implemented getter.
0
>>> f.attr = 'Presto'                 # Can be set by implemented setter.
>>> f.attr
'Presto'
>>> f.__attr = 'Tricky?'              # Can we set it explicitly?
>>> f.attr                            # No. By doing that we have created a 
'Presto'                              # new but unrelated attribute, same name.

但是，您可以通过 name mangling (_classname__attribute) 访问此类属性，Python 在后台执行此操作：

>>> f._Foo__attr
0
>>> f.__getattribute__('_Foo__attr')
0

Answer 9

查看此链接：https://docs.python.org/2/tutorial/classes.html

9.6。私有变量和类局部引用

在 Python 中不存在只能从对象内部访问的“私有”实例变量。但是，大多数 Python 代码都遵循一个约定：前缀为下划线的名称（例如 _spam）应被视为 API 的非公共部分（无论是函数、方法还是数据成员） .它应被视为实现细节，如有更改，恕不另行通知。

由于类私有成员有一个有效的用例（即避免名称与子类定义的名称发生名称冲突），因此对这种称为名称修饰的机制的支持有限。 __spam 形式的任何标识符（至少两个前导下划线，最多一个尾随下划线）在文本上被替换为 _classname__spam，其中类名是当前类名，前导下划线被去除。只要它出现在类的定义中，就可以在不考虑标识符的句法位置的情况下完成这种修饰。