Python __slots__:限制类实例动态添加属性和方法

通过学习《Python类变量和实例变量》一节,了解了如何动态的为单个实例对象添加属性,甚至如果必要的话,还可以为所有的类实例对象统一添加属性(通过给类添加属性)。

那么,Python 是否也允许动态地为类或实例对象添加方法呢?答案是肯定的。我们知道,类方法又可细分为实例方法、静态方法和类方法,Python 语言允许为类动态地添加这 3 种方法;但对于实例对象,则只允许动态地添加实例方法,不能添加类方法和静态方法。

为单个实例对象添加方法,不会影响该类的其它实例对象;而如果为类动态地添加方法,则所有的实例对象都可以使用。

举个例子:
class CLanguage:
    pass
#下面定义了一个实例方法
def info(self):
    print("正在调用实例方法")
#下面定义了一个类方法
@classmethod
def info2(cls):
    print("正在调用类方法")
#下面定义个静态方法
@staticmethod
def info3():
    print("正在调用静态方法")

#类可以动态添加以上 3 种方法,会影响所有实例对象
CLanguage.info = info
CLanguage.info2 = info2
CLanguage.info3 = info3

clang = CLanguage()
#如今,clang 具有以上 3 种方法
clang.info()
clang.info2()
clang.info3()

#类实例对象只能动态添加实例方法,不会影响其它实例对象
clang1 = CLanguage()
clang1.info = info
#必须手动为 self 传值
clang1.info(clang1)
程序输出结果为:

正在调用实例方法
正在调用类方法
正在调用静态方法
正在调用实例方法

显然,动态给类或者实例对象添加属性或方法,是非常灵活的。但与此同时,如果胡乱地使用,也会给程序带来一定的隐患,即程序中已经定义好的类,如果不做任何限制,是可以做动态的修改的。

庆幸的是,Python 提供了 __slots__ 属性,通过它可以避免用户频繁的给实例对象动态地添加属性或方法。

再次声明,__slots__ 只能限制为实例对象动态添加属性和方法,而无法限制动态地为类添加属性和方法。

__slots__ 属性值其实就是一个元组,只有其中指定的元素,才可以作为动态添加的属性或者方法的名称。举个例子:
class CLanguage:
    __slots__ = ('name','add','info')
可以看到, CLanguage 类中指定了 __slots__ 属性,这意味着,该类的实例对象仅限于动态添加 name、add、info 这 3 个属性以及 name()、add() 和 info() 这 3 个方法。

注意,对于动态添加的方法,__slots__ 限制的是其方法名,并不限制参数的个数。

比如,在 CLanguage 类的基础上,添加如下代码并运行:
def info(self,name):
    print("正在调用实例方法",self.name)
clang = CLanguage()
clang.name = "新宝库"
#为 clang 对象动态添加 info 实例方法
clang.info = info
clang.info(clang,"Python教程")
程序运行结果为:

正在调用实例方法 新宝库


还是在 CLanguage 类的基础上,添加如下代码并运行:
def info(self,name):
    print("正在调用实例方法",self.name)
clang = CLanguage()
clang.name = "新宝库"
clang.say = info
clang.say(clang,"Python教程")
运行程序,显示如下信息:

Traceback (most recent call last):
  File "D:\python3.6\1.py", line 9, in <module>
    clang.say = info
AttributeError: 'CLanguage' object has no attribute 'say'

显然,根据 __slots__ 属性的设置,CLanguage 类的实例对象是不能动态添加以 say 为名称的方法的。

另外本节前面提到,__slots__ 属性限制的对象是类的实例对象,而不是类,因此下面的代码是合法的:
def info(self):
    print("正在调用实例方法")

CLanguage.say = info
clang = CLanguage()
clang.say()
程序运行结果为:

正在调用实例方法

当然,还可以为类动态添加类方法和静态方法,这里不再给出具体实例,读者可自行编写代码尝试。


此外,__slots__ 属性对由该类派生出来的子类,也是不起作用的。例如如下代码:
class CLanguage:
    __slots__ = ('name','add','info')
#Clanguage 的空子类
class CLangs(CLanguage):
    pass
#定义的实例方法
def info(self):
    print("正在调用实例方法")
clang = CLangs()
#为子类对象动态添加 say() 方法
clang.say = info
clang.say(clang)
运行结果为:

正在调用实例方法

显然,__slots__ 属性只对当前所在的类起限制作用。

因此,如果子类也要限制外界为其实例对象动态地添加属性和方法,必须在子类中设置 __slots__ 属性。

注意,如果为子类也设置有 __slots__ 属性,那么子类实例对象允许动态添加的属性和方法,是子类中 __slots__ 属性和父类 __slots__ 属性的和。