在Python中使用元類的教程
type()
動(dòng)態(tài)語(yǔ)言和靜態(tài)語(yǔ)言最大的不同,就是函數(shù)和類的定義,不是編譯時(shí)定義的,而是運(yùn)行時(shí)動(dòng)態(tài)創(chuàng)建的。
比方說我們要定義一個(gè)Hello的class,就寫一個(gè)hello.py模塊:
class Hello(object): def hello(self, name='world'): print('Hello, %s.' % name)
當(dāng)Python解釋器載入hello模塊時(shí),就會(huì)依次執(zhí)行該模塊的所有語(yǔ)句,執(zhí)行結(jié)果就是動(dòng)態(tài)創(chuàng)建出一個(gè)Hello的class對(duì)象,測(cè)試如下:
>>> from hello import Hello >>> h = Hello() >>> h.hello() Hello, world. >>> print(type(Hello)) <type 'type'> >>> print(type(h)) <class 'hello.Hello'>
type()函數(shù)可以查看一個(gè)類型或變量的類型,Hello是一個(gè)class,它的類型就是type,而h是一個(gè)實(shí)例,它的類型就是class Hello。
我們說class的定義是運(yùn)行時(shí)動(dòng)態(tài)創(chuàng)建的,而創(chuàng)建class的方法就是使用type()函數(shù)。
type()函數(shù)既可以返回一個(gè)對(duì)象的類型,又可以創(chuàng)建出新的類型,比如,我們可以通過type()函數(shù)創(chuàng)建出Hello類,而無需通過class Hello(object)...的定義:
>>> def fn(self, name='world'): # 先定義函數(shù) ... print('Hello, %s.' % name) ... >>> Hello = type('Hello', (object,), dict(hello=fn)) # 創(chuàng)建Hello class >>> h = Hello() >>> h.hello() Hello, world. >>> print(type(Hello)) <type 'type'> >>> print(type(h)) <class '__main__.Hello'>
要?jiǎng)?chuàng)建一個(gè)class對(duì)象,type()函數(shù)依次傳入3個(gè)參數(shù):
- class的名稱;
- 繼承的父類集合,注意Python支持多重繼承,如果只有一個(gè)父類,別忘了tuple的單元素寫法;
- class的方法名稱與函數(shù)綁定,這里我們把函數(shù)fn綁定到方法名hello上。
通過type()函數(shù)創(chuàng)建的類和直接寫class是完全一樣的,因?yàn)镻ython解釋器遇到class定義時(shí),僅僅是掃描一下class定義的語(yǔ)法,然后調(diào)用type()函數(shù)創(chuàng)建出class。
正常情況下,我們都用class Xxx...來定義類,但是,type()函數(shù)也允許我們動(dòng)態(tài)創(chuàng)建出類來,也就是說,動(dòng)態(tài)語(yǔ)言本身支持運(yùn)行期動(dòng)態(tài)創(chuàng)建類,這和靜態(tài)語(yǔ)言有非常大的不同,要在靜態(tài)語(yǔ)言運(yùn)行期創(chuàng)建類,必須構(gòu)造源代碼字符串再調(diào)用編譯器,或者借助一些工具生成字節(jié)碼實(shí)現(xiàn),本質(zhì)上都是動(dòng)態(tài)編譯,會(huì)非常復(fù)雜。
metaclass
除了使用type()動(dòng)態(tài)創(chuàng)建類以外,要控制類的創(chuàng)建行為,還可以使用metaclass。
metaclass,直譯為元類,簡(jiǎn)單的解釋就是:
當(dāng)我們定義了類以后,就可以根據(jù)這個(gè)類創(chuàng)建出實(shí)例,所以:先定義類,然后創(chuàng)建實(shí)例。
但是如果我們想創(chuàng)建出類呢?那就必須根據(jù)metaclass創(chuàng)建出類,所以:先定義metaclass,然后創(chuàng)建類。
連接起來就是:先定義metaclass,就可以創(chuàng)建類,最后創(chuàng)建實(shí)例。
所以,metaclass允許你創(chuàng)建類或者修改類。換句話說,你可以把類看成是metaclass創(chuàng)建出來的“實(shí)例”。
metaclass是Python面向?qū)ο罄镒铍y理解,也是最難使用的魔術(shù)代碼。正常情況下,你不會(huì)碰到需要使用metaclass的情況,所以,以下內(nèi)容看不懂也沒關(guān)系,因?yàn)榛旧夏悴粫?huì)用到。
我們先看一個(gè)簡(jiǎn)單的例子,這個(gè)metaclass可以給我們自定義的MyList增加一個(gè)add方法:
定義ListMetaclass,按照默認(rèn)習(xí)慣,metaclass的類名總是以Metaclass結(jié)尾,以便清楚地表示這是一個(gè)metaclass:
# metaclass是創(chuàng)建類,所以必須從`type`類型派生: class ListMetaclass(type): def __new__(cls, name, bases, attrs): attrs['add'] = lambda self, value: self.append(value) return type.__new__(cls, name, bases, attrs) class MyList(list): __metaclass__ = ListMetaclass # 指示使用ListMetaclass來定制類
當(dāng)我們寫下__metaclass__ = ListMetaclass語(yǔ)句時(shí),魔術(shù)就生效了,它指示Python解釋器在創(chuàng)建MyList時(shí),要通過ListMetaclass.__new__()來創(chuàng)建,在此,我們可以修改類的定義,比如,加上新的方法,然后,返回修改后的定義。
__new__()方法接收到的參數(shù)依次是:
- 當(dāng)前準(zhǔn)備創(chuàng)建的類的對(duì)象;
- 類的名字;
- 類繼承的父類集合;
- 類的方法集合。
測(cè)試一下MyList是否可以調(diào)用add()方法:
>>> L = MyList() >>> L.add(1) >>> L [1]
而普通的list沒有add()方法:
>>> l = list() >>> l.add(1) Traceback (most recent call last): File "<stdin>", line 1, in <module> AttributeError: 'list' object has no attribute 'add'
動(dòng)態(tài)修改有什么意義?直接在MyList定義中寫上add()方法不是更簡(jiǎn)單嗎?正常情況下,確實(shí)應(yīng)該直接寫,通過metaclass修改純屬變態(tài)。
但是,總會(huì)遇到需要通過metaclass修改類定義的。ORM就是一個(gè)典型的例子。
ORM全稱“Object Relational Mapping”,即對(duì)象-關(guān)系映射,就是把關(guān)系數(shù)據(jù)庫(kù)的一行映射為一個(gè)對(duì)象,也就是一個(gè)類對(duì)應(yīng)一個(gè)表,這樣,寫代碼更簡(jiǎn)單,不用直接操作SQL語(yǔ)句。
要編寫一個(gè)ORM框架,所有的類都只能動(dòng)態(tài)定義,因?yàn)橹挥惺褂谜卟拍芨鶕?jù)表的結(jié)構(gòu)定義出對(duì)應(yīng)的類來。
讓我們來嘗試編寫一個(gè)ORM框架。
編寫底層模塊的第一步,就是先把調(diào)用接口寫出來。比如,使用者如果使用這個(gè)ORM框架,想定義一個(gè)User類來操作對(duì)應(yīng)的數(shù)據(jù)庫(kù)表User,我們期待他寫出這樣的代碼:
class User(Model): # 定義類的屬性到列的映射: id = IntegerField('id') name = StringField('username') email = StringField('email') password = StringField('password') # 創(chuàng)建一個(gè)實(shí)例: u = User(id=12345, name='Michael', email='test@orm.org', password='my-pwd') # 保存到數(shù)據(jù)庫(kù): u.save()
其中,父類Model和屬性類型StringField、IntegerField是由ORM框架提供的,剩下的魔術(shù)方法比如save()全部由metaclass自動(dòng)完成。雖然metaclass的編寫會(huì)比較復(fù)雜,但ORM的使用者用起來卻異常簡(jiǎn)單。
現(xiàn)在,我們就按上面的接口來實(shí)現(xiàn)該ORM。
首先來定義Field類,它負(fù)責(zé)保存數(shù)據(jù)庫(kù)表的字段名和字段類型:
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的基礎(chǔ)上,進(jìn)一步定義各種類型的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')
下一步,就是編寫最復(fù)雜的ModelMetaclass了:
class ModelMetaclass(type): def __new__(cls, name, bases, attrs): if name=='Model': return type.__new__(cls, name, bases, attrs) mappings = dict() for k, v in attrs.iteritems(): if isinstance(v, Field): print('Found mapping: %s==>%s' % (k, v)) mappings[k] = v for k in mappings.iterkeys(): attrs.pop(k) attrs['__table__'] = name # 假設(shè)表名和類名一致 attrs['__mappings__'] = mappings # 保存屬性和列的映射關(guān)系 return type.__new__(cls, name, bases, attrs)
以及基類Model:
class Model(dict): __metaclass__ = ModelMetaclass def __init__(self, **kw): 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__.iteritems(): 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))
當(dāng)用戶定義一個(gè)class User(Model)時(shí),Python解釋器首先在當(dāng)前類User的定義中查找__metaclass__,如果沒有找到,就繼續(xù)在父類Model中查找__metaclass__,找到了,就使用Model中定義的__metaclass__的ModelMetaclass來創(chuàng)建User類,也就是說,metaclass可以隱式地繼承到子類,但子類自己卻感覺不到。
在ModelMetaclass中,一共做了幾件事情:
- 排除掉對(duì)Model類的修改;
- 在當(dāng)前類(比如User)中查找定義的類的所有屬性,如果找到一個(gè)Field屬性,就把它保存到一個(gè)__mappings__的dict中,同時(shí)從類屬性中刪除該Field屬性,否則,容易造成運(yùn)行時(shí)錯(cuò)誤;
- 把表名保存到__table__中,這里簡(jiǎn)化為表名默認(rèn)為類名。
在Model類中,就可以定義各種操作數(shù)據(jù)庫(kù)的方法,比如save(),delete(),find(),update等等。
我們實(shí)現(xiàn)了save()方法,把一個(gè)實(shí)例保存到數(shù)據(jù)庫(kù)中。因?yàn)橛斜砻瑢傩缘阶侄蔚挠成浜蛯傩灾档募?,就可以?gòu)造出INSERT語(yǔ)句。
編寫代碼試試:
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,uid) values (?,?,?,?) ARGS: ['my-pwd', 'test@orm.org', 'Michael', 12345]
可以看到,save()方法已經(jīng)打印出了可執(zhí)行的SQL語(yǔ)句,以及參數(shù)列表,只需要真正連接到數(shù)據(jù)庫(kù),執(zhí)行該SQL語(yǔ)句,就可以完成真正的功能。
不到100行代碼,我們就通過metaclass實(shí)現(xiàn)了一個(gè)精簡(jiǎn)的ORM框架,完整的代碼從這里下載:
https://github.com/michaelliao/learn-python/blob/master/metaclass/simple_orm.py
最后解釋一下類屬性和實(shí)例屬性。直接在class中定義的是類屬性:
class Student(object): name = 'Student'
實(shí)例屬性必須通過實(shí)例來綁定,比如self.name = 'xxx'。來測(cè)試一下:
>>> # 創(chuàng)建實(shí)例s: >>> s = Student() >>> # 打印name屬性,因?yàn)閷?shí)例并沒有name屬性,所以會(huì)繼續(xù)查找class的name屬性: >>> print(s.name) Student >>> # 這和調(diào)用Student.name是一樣的: >>> print(Student.name) Student >>> # 給實(shí)例綁定name屬性: >>> s.name = 'Michael' >>> # 由于實(shí)例屬性優(yōu)先級(jí)比類屬性高,因此,它會(huì)屏蔽掉類的name屬性: >>> print(s.name) Michael >>> # 但是類屬性并未消失,用Student.name仍然可以訪問: >>> print(Student.name) Student >>> # 如果刪除實(shí)例的name屬性: >>> del s.name >>> # 再次調(diào)用s.name,由于實(shí)例的name屬性沒有找到,類的name屬性就顯示出來了: >>> print(s.name) Student
因此,在編寫程序的時(shí)候,千萬不要把實(shí)例屬性和類屬性使用相同的名字。
在我們編寫的ORM中,ModelMetaclass會(huì)刪除掉User類的所有類屬性,目的就是避免造成混淆。
相關(guān)文章
舉例詳解Python中的split()函數(shù)的使用方法
這篇文章主要介紹了舉例詳解Python中的split()函數(shù)的使用方法,split()函數(shù)的使用是Python學(xué)習(xí)當(dāng)中的基礎(chǔ)知識(shí),通常用于將字符串切片并轉(zhuǎn)換為列表,需要的朋友可以參考下2015-04-04提升Python項(xiàng)目整潔度使用import?linter實(shí)例探究
在復(fù)雜的Python項(xiàng)目中,良好的代碼組織結(jié)構(gòu)是維護(hù)性和可讀性的關(guān)鍵,本文將深入研究?import-linter?工具,它是一個(gè)強(qiáng)大的靜態(tài)分析工具,旨在優(yōu)化項(xiàng)目的模塊導(dǎo)入,提高代碼質(zhì)量和可維護(hù)性2024-01-01詳解利用django中間件django.middleware.csrf.CsrfViewMiddleware防止csrf
這篇文章主要介紹了詳解利用django中間件django.middleware.csrf.CsrfViewMiddleware防止csrf攻擊,小編覺得挺不錯(cuò)的,現(xiàn)在分享給大家,也給大家做個(gè)參考。一起跟隨小編過來看看吧2018-10-10解決PyCharm不在run輸出運(yùn)行結(jié)果而不是再Console里輸出的問題
這篇文章主要介紹了解決PyCharm不在run輸出運(yùn)行結(jié)果而不是再Console里輸出的問題,本文給大家介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值,需要的朋友可以參考下2020-09-09Python實(shí)現(xiàn)字符串逆序輸出功能示例
這篇文章主要介紹了Python實(shí)現(xiàn)字符串逆序輸出功能,結(jié)合具體實(shí)例形式分析了Python針對(duì)字符串的遍歷、翻轉(zhuǎn)、排序等相關(guān)操作技巧,需要的朋友可以參考下2017-06-06kNN算法python實(shí)現(xiàn)和簡(jiǎn)單數(shù)字識(shí)別的方法
這篇文章主要介紹了kNN算法python實(shí)現(xiàn)和簡(jiǎn)單數(shù)字識(shí)別的方法,詳細(xì)講述了kNN算法的優(yōu)缺點(diǎn)及原理,并給出了應(yīng)用實(shí)例,需要的朋友可以參考下2014-11-11Python PyQt4實(shí)現(xiàn)QQ抽屜效果
這篇文章主要為大家詳細(xì)介紹了Python PyQt4實(shí)現(xiàn)QQ抽屜效果,具有一定的參考價(jià)值,感興趣的小伙伴們可以參考一下2018-04-04python讀取測(cè)試數(shù)據(jù)的多種方式
本文主要介紹了python讀取測(cè)試數(shù)據(jù)的多種方式,文中通過示例代碼介紹的非常詳細(xì),具有一定的參考價(jià)值,感興趣的小伙伴們可以參考一下2021-08-08Python中zip()函數(shù)用法實(shí)例教程
這篇文章主要介紹了Python中zip()函數(shù)用法實(shí)例教程,對(duì)Python初學(xué)者有一定的借鑒價(jià)值,需要的朋友可以參考下2014-07-07