python实现静态变量

2023-01-31 05:01:37 python 变量 静态

在类中定义在函数外面的变量是类变量,不属于类的实例。利用它可以实现静态变量。

1. 意料之外的静态变量

在使用类变量的时候一定要小心,否则会得到意料之外的结果。看下面的代码:

class Foo(object):
    count = 0

f1 = Foo()
f2 = Foo()
f1.count = 1
print(f1.count, f2.count)
# 结果:
1 0

之所以结果不相同,原因在于第6行赋值的时候,并没有把类变量count变为1,而是f1对象自己生成了一个变量count,并初始化为1。而此时f2.count指向的仍然是类Foo的变量count,其值仍为0。

2. python动态语言特性

我们来看以下代码就明白了:

class test(object):
    pass

t = test()
print(t.count) # 会出错,因为count不存在
t.count = 1
print(t.count) # 不会出错,因为新创建了一个count

3. 通过类名来引用类变量

所以要把最开始的代码改成这样才不会出问题:

class Foo(object):
    count = 0

f1 = Foo()
f2 = Foo()
Foo.count = 1
print(f1.count, f2.count)
# 结果:
1 1

可以用getter和setter来进行包装:

class Foo(object):
    count = 0

    def get_count(self):
        return Foo.count

    def set_count(self, num):
        Foo.count = num

f1 = Foo()
f2 = Foo()
Foo.set_count(1)
print(f1.get_count(), f2.get_count())
# 结果:
1 1

为了支持在类的实例中操作静态变量,我们可以借助@property装饰器来这样写:

class Foo(object):
    _count = 0 # 不要直接操作这个变量,也尽量避免访问它

    @property
    def count(self):
        return Foo._count

    @count.setter
    def count(self, num):
        Foo._count = num


f1 = Foo()
f2 = Foo()
print f1.count, f1._count, f2.count, f2._count

f1.count = 1
print f1.count, f1._count, f2.count, f2._count
# 结果:
0 0 0 0
1 1 1 1

4. 类变量的封装

为了避免直接在外部对类变量进行操作,我们可以再进行封装,把类变量加双下划线__变成私有的,再使用@claSSMethod来实现:

class Foo(object):
    __count = 0 # 私有变量,无法在外部访问,Foo.__count会出错

    @classmethod
    def get_count(cls):
        return cls.__count

    @classmethod
    def set_count(cls, num):
        cls.__count = num

f1 = Foo()
f2 = Foo()
Foo.set_count(1)
print(f1.get_count(), f2.get_count())
# 结果:
1 1

值得注意的是,此时__count是属于类Foo的私有变量,在类的外部无法访问私有变量__count,即使在类的内部也无法通过普通函数访问,甚至无法通过Foo.__count访问, 只能通过@classmethod来访问

5. 扩展问题:如何将classmethod变成property?

直接在@classmethod前面加@property会报错:

TypeError: ‘classmethod’ object is not callable

实现起来比较复杂,目前来看有两种思路。

一种是实现一个property的子类,然后修改其 __get__ 方法。
另一种方式是使用元类 (__metaclass__)。

关于这一问题的讨论参见stackoverflow:

  • using-property-on-classmethods
  • how-to-make-a-class-property

相关文章