23

假设我有一个具有一些属性的类。如何最好（在 Pythonic-OOP 中）访问这些属性？就像obj.attr？或者也许写 get 访问器？这些东西的公认命名风格是什么？

编辑： 您能否详细说明使用单下划线或双下划线命名属性的最佳实践？我在大多数模块中看到使用单个下划线。

如果这个问题已经被问过（我有预感，虽然搜索没有带来结果），请指出它 - 我将关闭这个问题。

4

7 回答 7

57

关于单下划线和双下划线：两者都表示“隐私”的相同概念。也就是说，人们会知道属性（无论是方法还是“普通”数据属性或其他任何东西）不是对象的公共 API 的一部分。人们会知道，直接触摸它会招来灾难。

最重要的是，双前导下划线属性（但不是单前导下划线属性）经过名称修改，以减少从子类或当前类之外的任何其他地方意外访问它们的可能性。您仍然可以访问它们，但不是那么简单。例如：

>>> class ClassA:
...     def __init__(self):
...         self._single = "Single"
...         self.__double = "Double"
...     def getSingle(self):
...         return self._single
...     def getDouble(self):
...         return self.__double
... 
>>> class ClassB(ClassA):
...     def getSingle_B(self):
...         return self._single
...     def getDouble_B(self):
...         return self.__double
... 
>>> a = ClassA()
>>> b = ClassB()

您现在可以轻松访问a._single并b._single获取由以下内容_single创建的属性ClassA：

>>> a._single, b._single
('Single', 'Single')
>>> a.getSingle(), b.getSingle(), b.getSingle_B()
('Single', 'Single', 'Single')

但是尝试直接访问or实例__double上的属性是行不通的：ab

>>> a.__double
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
AttributeError: ClassA instance has no attribute '__double'
>>> b.__double
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
AttributeError: ClassB instance has no attribute '__double'

尽管在中定义的方法ClassA可以直接获取它（在任一实例上调用时）：

>>> a.getDouble(), b.getDouble()
('Double', 'Double')

上定义的方法ClassB不能：

>>> b.getDouble_B()
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "<stdin>", line 5, in getDouble_B
AttributeError: ClassB instance has no attribute '_ClassB__double'

就在那个错误中，您会得到有关正在发生的事情的提示。属性名称，当__double在一个类中访问时，被命名为包含它正在被访问的类的名称。当ClassA尝试访问self.__double时，它实际上在编译时变成了对 的访问self._ClassA__double，同样是 for ClassB。（如果一个方法ClassB要分配给__double，为简洁起见，没有包含在代码中，因此它不会触及ClassA，__double而是创建一个新属性。）这个属性没有其他保护，所以如果你仍然可以直接访问它知道正确的名字：

>>> a._ClassA__double, b._ClassA__double
('Double', 'Double')

那么为什么这是一个问题呢？

好吧，任何时候你想继承和改变任何处理这个属性的代码的行为都是一个问题。您要么必须重新实现直接触及此双下划线属性的所有内容，要么必须猜测类名并手动修改名称。当这个双下划线属性实际上是一个方法时，问题会变得更糟：覆盖该方法或在子类中调用该方法意味着手动进行名称修改，或者重新实现调用该方法的所有代码以不使用双下划线名称. 更不用说动态访问属性了，使用getattr(): 你也必须在那里手动修改。

另一方面，因为属性只是简单地重写，它只提供表面的“保护”。任何代码仍然可以通过手动修改来获取属性，尽管这会使它们的代码依赖于你的类的名称，并且你会努力重构你的代码或重命名你的类（同时仍然保持相同的用户可见名称，Python 中的一种常见做法）会不必要地破坏他们的代码。他们还可以通过将它们的类命名为与您的相同来“欺骗”Python 为它们进行名称修改：注意在修改的属性名称中没有包含模块名称。最后，双下划线属性在所有属性列表和所有形式的内省中仍然可见单) 下划线。

因此，如果您使用双下划线名称，请非常谨慎地使用它们，因为它们会变得非常不方便，并且永远不要将它们用于方法或子类可能想要重新实现、覆盖或直接访问的任何其他内容。并意识到双前导下划线名称修饰没有提供真正的保护。最后，使用单个前导下划线会赢得同样多的收益，并减少（潜在的、未来的）痛苦。使用单个前导下划线。

于 2008-10-03T09:37:51.120 回答
23

普遍接受的做事方式只是使用简单的属性，就像这样

>>> class MyClass:
...     myAttribute = 0
... 
>>> c = MyClass()
>>> c.myAttribute 
0
>>> c.myAttribute = 1
>>> c.myAttribute
1

如果您确实发现自己需要能够编写 getter 和 setter，那么您要寻找的是“python 类属性”，Ryan Tomayko 关于 Getters/Setters/Fuxors 的文章是一个很好的起点（虽然有点长）

于 2008-10-03T06:35:37.007 回答
8

编辑：您能否详细说明使用单下划线或双下划线命名属性的最佳实践？我在大多数模块中看到使用单个下划线。

单下划线对 python 没有任何特殊意义，这只是最佳实践，告诉“嘿，除非你知道自己在做什么，否则你可能不想访问它”。然而，双下划线使 python 在内部修改名称，使其只能从定义它的类访问。

双前导和尾随下划线表示特殊函数，例如__add__在使用 + 运算符时调用。

阅读PEP 8中的更多内容，尤其是“命名约定”部分。

于 2008-10-03T09:23:40.087 回答
3

我认为大多数人只是直接访问它们，不需要 get/set 方法。

>>> class myclass:
...     x = 'hello'
...
>>>
>>> class_inst = myclass()
>>> class_inst.x
'hello'
>>> class_inst.x = 'world'
>>> class_inst.x
'world'

顺便说一句，您可以使用 dir() 函数查看附加到您的实例的属性/方法：

>>> dir(class_inst)
['__doc__', '__module__', 'x']

两个前导下划线“__”用于将属性或函数设为私有。有关其他约定，请参阅 PEP 08： http: //www.python.org/dev/peps/pep-0008/

于 2008-10-03T06:24:01.590 回答
1

Python 不需要从一开始就定义访问器，因为将属性转换为属性是快速而轻松的。请看以下生动的演示：

从成瘾中恢复

于 2008-10-03T06:26:39.477 回答
0

在 python 中做 getter/setter 并没有真正的意义，无论如何你都不能保护东西，如果你在获取/设置属性时需要执行一些额外的代码，请查看内置的 property() (python -c 'help(property )')

于 2008-10-03T06:43:09.500 回答
-2

有些人使用 getter 和 setter。根据您使用的编码风格，您可以将它们命名为 getSpam 和 seteggs。但是您也可以使您的属性只读或仅分配。这样做有点尴尬。一种方法是覆盖

> __getattr__

和

> __setattr__

方法。

编辑：

虽然我的回答仍然正确，但我意识到这是不对的。在python中有更好的方法来制作访问器并且不是很尴尬。

于 2008-10-03T06:29:22.043 回答