Python中的实例变量与类变量

120

我有Python类，在运行时我只需要一个实例，因此每个类仅一个属性，而每个实例仅具有一个属性就足够了。如果将有多个实例（不会发生），则所有实例都应具有相同的配置。我不知道以下哪个选项会更好或更“惯用” Python。

类变量：

class MyController(Controller):

  path = "something/"
  children = [AController, BController]

  def action(self, request):
    pass

实例变量：

class MyController(Controller):

  def __init__(self):
    self.path = "something/"
    self.children = [AController, BController]

  def action(self, request):
    pass

— 恶魔
source

4

阅读此问题并看到答案后，我的第一个问题是：“那么我如何访问类变量？” -那是因为到目前为止，我只使用了实例变量。为了回答我自己的问题，您可以通过类名本身来完成，尽管从技术上讲您也可以通过实例来完成。这是供其他有相同问题的人阅读的链接：stackoverflow.com/a/3434596/4561887

— Gabriel Staples

158

如果您仍然只有一个实例，那么最好每个实例都设置所有变量，这仅仅是因为它们的访问速度（稍微快一点）（由于类与实例之间的“继承性”，因此“查找”的级别降低了），而且没有不利的一面来抵消这一小优势。

— 亚历克斯·马特利
source

7

从未听说过博格模式吗？首先只有一个实例是错误的方式。

— Devin Jeanpierre 2010年

434

@Devin，是的，我听说过Borg模式，因为我是介绍它的人（2001年，cfrcode.activestate.com/recipes/… ;-）。但是，在简单的情况下，仅具有一个实例而无需执行就没有错。

— 亚历克斯·

2

@ user1767754，很容易让他们自己使用python -mtimeit-但是在python3.4中刚刚这样做，我注意到访问int类变量实际上比在旧工作站上访问实例变量大约快 5到11纳秒-不知道是什么代码路径使之成为现实。

— Alex Martelli

45

进一步呼应Mike和Alex的建议，并添加我自己的颜色...

使用实例属性是典型的……更加惯用的Python。由于类属性的用例是特定的，因此未使用过多的类属性。静态方法和类方法与“普通”方法一样。它们是解决特定用例的特殊结构，否则它是由异常的程序员创建的代码，目的是炫耀他们知道Python编程的一些晦涩之处。

Alex在他的答复中提到，由于查找级别降低了，访问将（稍微快一些）……让我进一步澄清那些还不知道如何工作的人。它与变量访问非常相似-搜索顺序为：

当地人
非本地人
全球
内建

对于属性访问，顺序为：

实例
类
由MRO确定的基本类（方法解析顺序）

两种技术都以“由内而外”的方式工作，这意味着首先检查大多数局部对象，然后依次检查外层。

在上面的示例中，假设您正在查找path属性。当遇到“ self.path”之类的引用时，Python将首先查看实例属性以进行匹配。如果失败，它将检查实例化对象的类。最后，它将搜索基类。如Alex所述，如果在实例中找到您的属性，则无需在其他地方查找，因此节省了一点时间。

但是，如果您坚持使用类属性，则需要进行额外的查找。或者，您的另一种选择是通过类而不是实例来引用对象，例如，MyController.path代替self.path。这是一个直接查找，可以绕开延迟查找，但是正如alex在下面提到的那样，它是一个全局变量，因此您丢失了原本想保存的那一部分（除非您创建对[global]类名的本地引用））。

最重要的是，您应该在大多数时间使用实例属性。但是，在某些情况下，类属性是适合该工作的工具。同时使用这两个代码将需要最大的努力，因为使用self只会使您获得实例属性对象，并且可以通过影子访问相同名称的class属性。在这种情况下，必须使用通过类名访问属性，以便对其进行引用。

— 韦斯皮
source

@wescpy，但MyController在全局抬头，所以总成本高于self.path其中path是一个实例变量（因为self是本地的方法==超快速查找）。

— 亚历克斯·马丁里

啊，是的。接得好。我猜唯一的解决方法是创建一个本地引用...在这一点上，这真的不值得。

— wescpy

24

如有疑问，您可能需要实例属性。

类属性最好保留给有意义的特殊情况。唯一非常常见的用例是方法。对实例需要知道的只读常量使用类属性并不罕见（尽管这样做的唯一好处是，如果您还希望从类外部进行访问），但是对于在其中存储任何状态，您一定要谨慎，这很少是您想要的。即使您只有一个实例，也应该像编写其他实例一样编写类，这通常意味着使用实例属性。

— 迈克·格雷厄姆
source

1

类变量是一种只读常量。如果Python让我定义常量，我会把它写成常量。

— deamon 2010年

1

@deamon，我更可能将常量完全放在类定义之外，并用大写字母命名。将它们放入课堂也很好。使它们成为实例属性不会有任何伤害，但可能有点奇怪。我认为社区不会过多地选择其中一个选项，这不是一个问题。

— Mike Graham 2010年

Google的Python样式指南 @MikeGraham FWIW 建议避免使用全局变量，而建议使用类变量。但是也有例外。

— 丹尼斯

这是Google的Python样式指南的新链接。现在简单地写：avoid global variables它们的定义是，全局变量也是声明为类属性的变量。但是，Python自己的样式指南（PEP-8）应该是处理此类问题的第一位。然后，您的想法应该成为选择的工具（例如，当然您也可以从Google那里获得想法）。

— colidyre '18

4

关于在Python中访问类变量的性能存在相同的问题-此处的代码改编自@Edward Loper

局部变量是访问最快的，与模块变量，类变量，实例变量密切相关。

您可以从以下四个范围访问变量：

实例变量（self.varname）
类变量（Classname.varname）
模块变量（VARNAME）
局部变量（变量名）

考试：

import timeit

setup='''
XGLOBAL= 5
class A:
    xclass = 5
    def __init__(self):
        self.xinstance = 5
    def f1(self):
        xlocal = 5
        x = self.xinstance
    def f2(self):
        xlocal = 5
        x = A.xclass
    def f3(self):
        xlocal = 5
        x = XGLOBAL
    def f4(self):
        xlocal = 5
        x = xlocal
a = A()
'''
print('access via instance variable: %.3f' % timeit.timeit('a.f1()', setup=setup, number=300000000) )
print('access via class variable: %.3f' % timeit.timeit('a.f2()', setup=setup, number=300000000) )
print('access via module variable: %.3f' % timeit.timeit('a.f3()', setup=setup, number=300000000) )
print('access via local variable: %.3f' % timeit.timeit('a.f4()', setup=setup, number=300000000) )

结果：

access via instance variable: 93.456
access via class variable: 82.169
access via module variable: 72.634
access via local variable: 72.199

— robertcollier4
source