原文地址:
进一步阅读资料,了解关于 Metaclass 的相关细节:
Python 是动态语言,因此创建了一个class
的实例后,可以给该实例绑定任何属性和方法。但是,给一个实例绑定的方法,对另一个实例是不起作用的。为了给所有实例都绑定方法,可以给class
绑定方法,之后该方法所有实例均可调用。
定制类
slots - 限制实例可以添加的属性和方法
试图绑定不允许的属性将得到AttributeError
的错误。但要注意,__slots__
定义的属性仅对当前类实例起作用,对继承的子类是不起作用的,除非在子类中也定义__slots__
,这样,子类实例允许定义的属性就是自身的__slots__
加上父类的__slots__
。
class Student(object):
__slots__ = ('name', 'age') # 用tuple定义允许绑定的属性名称
__str__(), __repr__() - 结果看上去更人性化
__str__()
:print()
类的实例时结果看上去更人性化;__repr__()
:直接访问类实例,不print()
时的结果更人性化。
class Student(object):
def __init__(self, name):
self.name = name
def __str__(self):
return 'Student object (name=%s)' % self.name
__repr__ = __str__
__iter__() - 类似 list 或 tuple 那样可以 for… in
class Fib(object):
def __init__(self):
self.a, self.b = 0, 1 # 初始化两个计数器a,b
def __iter__(self):
return self # 实例本身就是迭代对象,故返回自己
def __next__(self):
self.a, self.b = self.b, self.a + self.b # 计算下一个值
if self.a > 100000: # 退出循环的条件
raise StopIteration()
return self.a # 返回下一个值
__getitem__() - 更像 list 下标、切片访问
class Fib(object):
def __getitem__(self, n):
a, b = 1, 1
for x in range(n):
a, b = b, a + b
return a
>>> f = Fib()
>>> f[0]
1
>>> f[1]
切片访问
class Fib(object):
def __getitem__(self, n):
if isinstance(n, int): # n是索引
a, b = 1, 1
for x in range(n):
a, b = b, a + b
return a
if isinstance(n, slice): # n是切片
start = n.start
stop = n.stop
if start is None:
start = 0
a, b = 1, 1
L = []
for x in range(stop):
if x >= start:
L.append(a)
a, b = b, a + b
return L
切片的step
功能,即f[:10:2]
中的2
,负数处理等都需要额外的代码实现。所以,要正确实现一个__getitem__()
还是有很多工作要做的。
此外,如果把对象看成dict
,__getitem__()
的参数也可能是一个可以作key
的object
,例如str
。
与之对应的是__setitem__()
方法,把对象视作list
或dict
来对集合赋值。最后,还有一个__delitem__()
方法,用于删除某个元素。
总之,通过上面的方法,我们自己定义的类表现得和 Python 自带的list
、tuple
、dict
没什么区别,这完全归功于动态语言的“鸭子类型”,不需要强制继承某个接口。
理解:可能直接继承自
list()
,然后将返回值变成一个list
值的对象可能更容易达到目的。
__getattr__() - 动态返回一个不存在的属性或函数
注意与getattr()
函数区分开:c = getattr(m, 'myclass')
。前者是返回指定类属性的取值,后者是访问不存在的属性时动态返回一个属性或函数。
class Student(object):
def __init__(self):
self.name = 'Michael'
def __getattr__(self, attr):
if attr=='score':
return 99
>>> s = Student()
>>> s.name
'Michael'
>>> s.score
99
# 返回函数
class Student(object):
def __getattr__(self, attr):
if attr=='age':
return lambda: 25
只是调用方式要变为:
>>> s.age() # 注意调用方法
25
注意到任意调用如s.abc
都会返回None
,这是因为我们定义的__getattr__()
默认返回就是None
。要让class
只响应特定的几个属性,我们就要按照约定,抛出AttributeError
的错误:
class Student(object):
def __getattr__(self, attr):
if attr=='age':
return lambda: 25
raise AttributeError('\'Student\' object has no attribute \'%s\'' % attr)
理解:理解教程中 REST 的关键就在于,一个 URL 对应一个功能接口,所以在链式方式调用某个功能时,利用__getattr__()
可以动态实现一个特定的 URL 字符串,这样就不必要针对每个功能的 URL 专门定义一个方法或属性,而是动态生成即可。
class Chain(object):
def __init__(self, path='GET '):
self._path = path
def __getattr__(self, path):
return Chain('%s/%s' % (self._path, path))
def __call__(self,path):
return Chain('%s/%s' % (self._path, path))
def __str__(self):
return self._path
__repr__ = __str__
print(Chain().users('lidu').repos)
Chain() -> init
得到'GET '
,.user()
没有这个方法,所以走__getattr__()
,这时,self._path
是GET
,path
是user
,然后在传给Chain
时,被连接了起来GET /user
,然后又调用了Chain -> init
,这时,path
为GET /user
, 因为Chain()
将生成一个实例,而这个实例后面跟着('lidu')
,所以将调用__call__()
,把lidu
与_path
连接起来,然后__call__()
中又调用Chain()
,继续走init
, 把GET /user/lidu
给了_path
,后面又跟了一个.repos
,没有这个属性,走__getatter__()
,就如一开始那样,把repos
也连接起来了。
最后,外面是一个print
,里面是一个Chain
的实例,所以会调用str
,类中定义str
返回_path
,就是上面一连串过程后,生成的字符串:GET /user/lidu/repos
。
__call__() - 让实例像函数一样 callable
这部分可以参考Python 中 __init__ 和 __call__ 的区别z。
一个对象实例可以有自己的属性和方法,当我们调用实例方法时,我们用instance.method()
来调用。能不能直接在实例本身上调用呢?在 Python 中,答案是肯定的。
任何类,只需要定义一个__call__()
方法,就可以直接对实例进行调用。请看示例:
class Student(object):
def __init__(self, name):
self.name = name
def __call__(self):
print('My name is %s.' % self.name)
调用方式如下:
>>> s = Student('Michael')
>>> s() # self参数不要传入
My name is Michael.
__call__()
还可以定义参数。对实例进行直接调用就好比对一个函数进行调用一样,所以你完全可以把对象看成函数,把函数看成对象,因为这两者之间本来就没啥根本的区别。
如果你把对象看成函数,那么函数本身其实也可以在运行期动态创建出来,因为类的实例都是运行期创建出来的,这么一来,我们就模糊了对象和函数的界限。
那么,怎么判断一个变量是对象还是函数呢?其实,更多的时候,我们需要判断一个对象是否能被调用,能被调用的对象就是一个 Callable 对象,比如函数和我们上面定义的带有__call__()
的类实例:
>>> callable(Student())
True
>>> callable(max)
True
>>> callable([1, 2, 3])
False
>>> callable(None)
False
>>> callable('str')
False
通过callable()
函数,我们就可以判断一个对象是否是可调用
对象。
@property - 方便的 set(), get()
在绑定属性时,如果我们直接把属性暴露出去,虽然写起来很简单,但是,没办法检查参数。为解决这一缺陷,初级方法中的解决方案是将属性设定为私有类型,然后提供相应的set(), get()
方法来访问属性。但是,上面的调用方法又略显复杂,没有直接用属性这么直接简单。有没有既能检查参数,又可以用类似属性这样简单的方式来访问类的变量呢?Python内置的@property
装饰器就是负责把一个方法变成属性调用的。
class Student(object):
@property
def score(self):
return self._score
@score.setter
def score(self, value):
if not isinstance(value, int):
raise ValueError('score must be an integer!')
if value < 0 or value > 100:
raise ValueError('score must between 0 ~ 100!')
self._score = value
@property
的实现比较复杂,我们先考察如何使用。
用法:把一个
getter()
方法变成属性,只需要加上@property
就可以了,此时,@property
本身又创建了另一个装饰器@score.setter
,负责把一个setter()
方法变成属性赋值,于是,我们就拥有一个可控的属性操作:
>>> s = Student()
>>> s.score = 60 # OK,实际转化为s.set_score(60)
>>> s.score # OK,实际转化为s.get_score()
60
>>> s.score = 9999
Traceback (most recent call last):
...
ValueError: score must between 0 ~ 100!
注意到这个神奇的@property
,我们在对实例属性操作的时候,就知道该属性很可能不是直接暴露的,而是通过getter()
和setter()
方法来实现的。还可以定义只读属性,只定义getter()方法,不定义
setter()方法就是一个只读属性:
class Student(object):
@property
def birth(self):
return self._birth
@birth.setter
def birth(self, value):
self._birth = value
@property
def age(self):
return 2015 - self._birth
多重继承, MixIn
通过多重继承,一个子类就可以同时获得多个父类的所有功能。
在设计类的继承关系时,通常,主线都是单一
继承下来的,例如,Ostrich
继承自Bird
。但是,如果需要“混入”额外的功能,通过多重继承就可以实现,比如,让Ostrich
除了继承自Bird
外,再同时继承Runnable
。这种设计通常称之为MixIn。
为了更好地看出继承关系,我们把Runnable
和Flyable
改为RunnableMixIn
和FlyableMixIn
。类似的,你还可以定义出肉食动物CarnivorousMixIn
和植食动物HerbivoresMixIn
,让某个动物同时拥有好几个MixIn
:
class Dog(Mammal, RunnableMixIn, CarnivorousMixIn):
pass
MixIn 的目的就是给一个类增加多个功能,这样,在设计类的时候,我们优先考虑通过多重继承来组合多个 MixIn 的功能,而不是设计的复杂的继承关系1。多层次
理解:MixIn 本身在语法上和主线上的继承类没有区别,但是在名称上加了
MixIn
以后,可以更清晰的看到继承的主与次?
Python 自带的很多库也使用了 MixIn。举个例子,Python 自带了TCPServer
和UDPServer
这两类网络服务,而要同时服务多个用户就必须使用多进程或多线程模型,这两种模型由ForkingMixIn
和ThreadingMixIn
提供。通过组合,我们就可以创造出合适的服务来。
比如,编写一个多进程模式的 TCP 服务,定义如下:
class MyTCPServer(TCPServer, ForkingMixIn):
pass
编写一个多线程模式的 UDP 服务,定义如下:
class MyUDPServer(UDPServer, ThreadingMixIn):
pass
如果你打算搞一个更先进的协程模型,可以编写一个CoroutineMixIn
:
class MyTCPServer(TCPServer, CoroutineMixIn):
pass
这样一来,我们不需要复杂而庞大的继承链,只要选择组合不同的类的功能,就可以快速构造出所需的子类。
枚举
Python提供了Enum
类来实现这个功能:
from enum import Enum
Month = Enum('Month', ('Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'))
这样我们就获得了Month
类型的枚举类,可以直接使用Month.Jan
来引用一个常量,或者枚举它的所有成员:
for name, member in Month.__members__.items():
print(name, '=>', member, ',', member.value)
Jan => Month.Jan , 1
Feb => Month.Feb , 2
Mar => Month.Mar , 3
Apr => Month.Apr , 4
May => Month.May , 5
Jun => Month.Jun , 6
Jul => Month.Jul , 7
Aug => Month.Aug , 8
Sep => Month.Sep , 9
Oct => Month.Oct , 10
Nov => Month.Nov , 11
Dec => Month.Dec , 12
value
属性则是自动赋给成员的int
常量,默认从1
开始计数。
如果需要更精确地控制枚举类型,可以从Enum
派生出自定义类:
from enum import Enum, unique
@unique
class Weekday(Enum):
Sun = 0 # Sun的value被设定为0
Mon = 1
Tue = 2
Wed = 3
Thu = 4
Fri = 5
Sat = 6
@unique
装饰器可以帮助我们检查保证没有重复值。
访问这些枚举类型可以有若干种方法:
>>> day1 = Weekday.Mon
>>> print(day1)
Weekday.Mon
>>> print(Weekday.Tue)
Weekday.Tue
>>> print(Weekday['Tue'])
Weekday.Tue
>>> print(Weekday.Tue.value)
2
>>> print(day1 == Weekday.Mon)
True
>>> print(day1 == Weekday.Tue)
False
>>> print(Weekday(1))
Weekday.Mon
>>> print(day1 == Weekday(1))
True
>>> Weekday(7)
Traceback (most recent call last):
...
ValueError: 7 is not a valid Weekday
>>> for name, member in Weekday.__members__.items():
... print(name, '=>', member)
...
Sun => Weekday.Sun
Mon => Weekday.Mon
Tue => Weekday.Tue
Wed => Weekday.Wed
Thu => Weekday.Thu
Fri => Weekday.Fri
Sat => Weekday.Sat
可见,既可以用成员名称引用枚举常量,又可以直接根据value
的值获得枚举常量。
元类
type
类是一切之祖,是 Python 的内建 Metaclass,type()
函数可以查看类型;type()
函数既可以返回一个对象的类型,又可以创建出新的类型,比如,我们可以通过type()
函数创建出Hello
类,而无需通过class Hello(object)...
的定义:
>>> def fn(self, name='world'): # 先定义函数
... print('Hello, %s.' % name)
...
>>> Hello = type('Hello', (object,), dict(hello=fn)) # 创建Hello class
>>> h = Hello()
>>> h.hello()
Hello, world.
>>> print(type(Hello))
<class 'type'>
>>> print(type(h))
<class '__main__.Hello'>
要创建一个class
对象,type()
函数依次传入 3 个参数:
class
的名称;- 继承的父类集合,注意 Python 支持多重继承,如果只有一个父类,别忘了
tuple
的单元素写法; class
的方法名称与函数绑定,这里我们把函数fn
绑定到方法名hello
上。
通过type()
函数创建的类和直接写 class 是完全一样的,因为 Python 解释器遇到 class 定义时,仅仅是扫描一下 class 定义的语法,然后调用type()
函数创建出class
。
正常情况下,我们都用class Xxx...
来定义类,但是,type()
函数也允许我们动态创建出类来,也就是说,动态语言本身支持运行期动态创建类,这和静态语言有非常大的不同,要在静态语言运行期创建类,必须构造源代码字符串再调用编译器,或者借助一些工具生成字节码实现,本质上都是动态编译,会非常复杂。
理解:教程中关于 Metaclass 的内容不好理解,一是例子本身比较深奥,二是讲解也不到位。但需要注意的是普通的 class 不仅是一个类,而且也是一个 object,这是 Python 的一个非常特殊的概念。而所有 class 的祖先就是 type,但 type 的实现又用了一些特殊的技巧,
class
这个关键词实际上就是告诉 Python 在创建一个 class 的时候,也会创建一个对应的 classObject。
type
就是 Python 的内建元类,当然了,你也可以创建自己的元类。除了一些代码中不能理解的东西外,还不好理解的是为什么 ORM 适合用 Metaclass 来实现,这一部分教程写的非常不够。https://stackoverflow.com/questions/100003/what-is-a-metaclass-in-python 的讲解虽然好(中文版),但这一问题仍然感觉不到位。
对于教程中的代码:
# metaclass是类的模板,所以必须从`type`类型派生:
class ListMetaclass(type):
def __new__(cls, name, bases, attrs): // cls 是固定写法,new 阶段还没有 self,也就无法用 self 为参数
attrs['add'] = lambda self, value: self.append(value)
return type.__new__(cls, name, bases, attrs)
现在难以理解的是这里的ListMetaclass
中的name
和bases
究竟是什么。
Metaclass
除了使用type()
动态创建类以外,要控制类的创建行为,还可以使用Metaclass
。Metaclass
,直译为元类,简单的解释就是:
- 当我们定义了类以后,就可以根据这个类创建出实例,所以:
先定义类,然后创建实例
。 - 但是如果我们想创建出类呢?那就必须根据
Metaclass
创建出类,所以:先定义 Metaclass,然后创建类
。 - 连接起来就是:
先定义 Metaclass,就可以创建类,最后创建实例
。
所以,Metaclass允许你创建类或者修改类。换句话说,你可以把类看成是 Metaclass 创建出来的实例,也就是前面总结的,普通的类不仅是一个 class,同时还是一个由 Metaclass 而来的 object,。
Metaclass 是 Python 面向对象里最难理解,也是最难使用的魔术代码。正常情况下,你不会碰到需要使用 Metaclass 的情况,所以,以下内容看不懂也没关系,因为基本上你不会用到。
我们先看一个简单的例子,这个 Metaclass 可以给我们自定义的MyList
增加一个add
方法:
定义ListMetaclass
,按照默认习惯,Metaclass 的类名总是以 Metaclass 结尾,以便清楚地表示这是一个 Metaclass:
# Metaclass 是类的模板,所以必须从`type`类型派生:
class ListMetaclass(type):
def __new__(cls, name, bases, attrs):
// new 的时候还没有 object,到 init 时才有,所以不能是 self,只能是 cls
attrs['add'] = lambda self, value: self.append(value)
return type.__new__(cls, name, bases, attrs)
有了ListMetaclass
,我们在定义类的时候还要指示使用ListMetaclass
来定制类,传入关键字参数metaclass
:
class MyList(list, metaclass=ListMetaclass):
pass
当我们传入关键字参数metaclass
时,魔术就生效了,它指示 Python 解释器在创建MyList
时,要通过ListMetaclass.__new__()
来创建,在此,我们可以修改类的定义,比如,加上新的方法,然后,返回修改后的定义。
__new__()
方法接收到的参数依次是:
- 当前准备创建的类的对象;
- 类的名字;
- 类继承的父类集合;
- 类的方法集合。
测试一下MyList
是否可以调用add()
方法:
>>> L = MyList()
>>> L.add(1)
>> L
[1]
而普通的list
没有add()
方法:
>>> L2 = list()
>>> L2.add(1)
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
AttributeError: 'list' object has no attribute 'add'
动态修改有什么意义?直接在MyList
定义中写上add()
方法不是更简单吗?正常情况下,确实应该直接写,通过 Metaclass 修改纯属变态。但是,总会遇到需要通过 Metaclass 修改类定义的。ORM 就是一个典型的例子。
Metaclass - ORM 实例
ORM 全称Object Relational Mapping
,即对象-关系映射
,就是把关系数据库的一行映射为一个对象2,也就是一个类User-Class
对应一个表User-Table
,这样,写代码更简单,不用直接操作 SQL 语句。
不理解:要编写一个 ORM 框架,所有的类都只能动态定义,因为只有使用者才能根据表的结构定义出对应的类来。
让我们来尝试编写一个 ORM 框架。
编写底层模块的第一步,就是先把调用接口写出来。比如,使用者如果使用这个 ORM 框架,想定义一个User
类来操作对应的数据库表User
,我们期待他写出这样的代码:
class User(Model):
# 定义类的属性到列的映射:
id = IntegerField('id')
name = StringField('username')
email = StringField('email')
password = StringField('password')
// 这部分的语法用于指定 User 的属性,但实际上最终被 Metaclass `pop` 了
# 创建一个实例:
u = User(id=12345, name='Michael', email='test@orm.org', password='my-pwd')
// User 的 __init__() 可以直接用 Model 的 __init()?
# 保存到数据库:
u.save()
其中,父类Model
和属性类型StringField
、IntegerField
是由 ORM 框架提供的,剩下的魔术方法比如save()
全部由metaclass
自动完成。虽然metaclass
的编写会比较复杂,但 ORM 的使用者用起来却异常简单。
现在,我们就按上面的接口来实现该 ORM。
首先来定义Field
类,它负责保存数据库表的字段名和字段类型:
class Field(object):
def __init__(self, name, column_type):
self.name = name
self.column_type = column_type
def __str__(self):
return '<%s:%s>' % (self.__class__.__name__, self.name)
在Field
的基础上,进一步定义各种类型的Field
,比如StringField
,IntegerField
等等:
class StringField(Field):
def __init__(self, name):
super(StringField, self).__init__(name, 'varchar(100)')
class IntegerField(Field):
def __init__(self, name):
super(IntegerField, self).__init__(name, 'bigint')
下一步,就是编写最复杂的ModelMetaclass
了:
class ModelMetaclass(type):
def __new__(cls, name, bases, attrs):
# cls 固定;name, bases, attrs 对应为将来准备使用的参数,来自 User,走向新 User
# 参考《深刻理解Python中的元类(metaclass)》可知是未来的
if name=='Model':
return type.__new__(cls, name, bases, attrs)
print('Found model: %s' % name)
mappings = dict()
for k, v in attrs.items():
if isinstance(v, Field):
print('Found mapping: %s ==> %s' % (k, v))
mappings[k] = v
for k in mappings.keys():
attrs.pop(k)
attrs['__mappings__'] = mappings # 保存属性和列的映射关系
attrs['__table__'] = name # 假设表名和类名一致
return type.__new__(cls, name, bases, attrs)
以及基类Model
:
class Model(dict, metaclass=ModelMetaclass):
def __init__(self, **kw):
# **kw 在初始化 User 时用到
super(Model, self).__init__(**kw)
def __getattr__(self, key):
try:
return self[key]
except KeyError:
raise AttributeError(r"'Model' object has no attribute '%s'" % key)
def __setattr__(self, key, value):
self[key] = value
def save(self):
fields = []
params = []
args = []
for k, v in self.__mappings__.items():
fields.append(v.name)
params.append('?')
args.append(getattr(self, k, None))
sql = 'insert into %s (%s) values (%s)' % (self.__table__, ','.join(fields), ','.join(params))
print('SQL: %s' % sql)
print('ARGS: %s' % str(args))
当用户定义一个class User(Model)
时,Python 解释器首先在当前类User
的定义中查找metaclass
,如果没有找到,就继续在父类Model
中查找metaclass
,找到了,就使用Model
中定义的metaclass
的ModelMetaclass
来创建User
类,也就是说,metaclass
可以隐式地继承到子类,但子类自己却感觉不到。
在ModelMetaclass
中,一共做了几件事情:
- 排除掉对
Model
类的修改3; - 在当前类(比如
User
)中查找定义的类的所有属性,如果找到一个Field
属性,就把它保存到一个__mappings__
的dict
中,同时从类属性中删除该Field
属性,否则,容易造成运行时错误(实例的属性会遮盖类的同名属性4; - 把表名保存到
__table__
中,这里简化为表名默认为类名。 - 在
Model
类中,就可以定义各种操作数据库的方法,比如save()
,delete()
,find()
,update()
等等。 - 我们实现了
save()
方法,把一个实例保存到数据库中。因为有表名,属性到字段的映射和属性值的集合,就可以构造出INSERT
语句。
编写代码试试:
u = User(id=12345, name='Michael', email='test@orm.org', password='my-pwd')
u.save()
输出如下:
Found model: User
Found mapping: email ==> <StringField:email>
Found mapping: password ==> <StringField:password>
Found mapping: id ==> <IntegerField:uid>
Found mapping: name ==> <StringField:username>
SQL: insert into User (password,email,username,id) values (?,?,?,?)
ARGS: ['my-pwd', 'test@orm.org', 'Michael', 12345]
可以看到,save()
方法已经打印出了可执行的 SQL 语句,以及参数列表,只需要真正连接到数据库,执行该 SQL 语句,就可以完成真正的功能。
不到 100 行代码,我们就通过metaclass
实现了一个精简的 ORM 框架。