Python 面向對象高級編程——使用枚舉和元類

1.1   使用枚舉

基于Enum類實現的枚舉

>>> fromenum import Enum

>>> Month = Enum('Month', ('Jan','Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'))

>>> for name, member inMonth.__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開始計數。

>>> Month.Jun

<Month.Jun: 6>

>>> Month.Jun.value

6

精確地控制枚舉類型，可以從Enum派生出自定義類

>>> from enum import Enum, unique

>>> @unique     --裝飾器檢查是否重復

... class Weekday(Enum):

...    Sun = 0

...    Mon = 1

...    Tue = 2

...    Wed = 3

...    Thu = 4

...    Fri = 5

...    Sat = 6

...

>>> Weekday(1)

<Weekday.Mon: 1>

>>> Weekday(5)

<Weekday.Fri: 5>

>>>Weekday['Sun']

<Weekday.Sun: 0>

>>> Weekday.Sun

<Weekday.Sun: 0>

>>>Weekday.Sun.value

0

>>> Weekday(7)

Traceback (most recent call last):

 File "<stdin>", line 1, in <module>

 File "/usr/local/lib/python3.5/enum.py", line 235, in __call__

   return cls.__new__(cls, value)

 File "/usr/local/lib/python3.5/enum.py", line 470, in __new__

   raise ValueError("%r is not a valid %s" % (value,cls.__name__))

ValueError: 7 is not a valid Weekday

1.2   使用元類

1.2.1   type()

動態語言和靜態語言最大的不同，就是函數和類的定義，不是編譯時定義的，而是運行時動態創建的。

定義一個hello.py的模塊

class Hello(object):

   def hello(self, name='world'):

       print('Hello, %s.' % name)

在python解釋器中調用

>>> from hello import Hello

>>> h = Hello()

>>> h.hello()

Hello, world.

>>> print(type(Hello))    --type類型

<class 'type'>

>>> print(type(h))       --class hello類型

<class 'hello.Hello'>

class的定義是運行時動態創建的，而創建class的方法就是使用type()函數。

>>> deffn(self, name = 'world'):

...     print('Hello, %s' % name)

...

>>> Hello= type('Hello', (object,), dict(hello = fn))

>>> h = Hello()

>>> h.hello()

Hello, world

>>> print(type(Hello))

<class 'type'>

>>> print(type(h))

<class '__main__.Hello'>

要創建一個class對象，type()函數依次傳入3個參數：

1.class的名稱；

2.繼承的父類集合，注意Python支持多重繼承，如果只有一個父類，別忘了tuple的單元素寫法；

>>> T = (1)

>>> type(T)

<class 'int'>

>>> T = (1,)

>>> type(T)

<class 'tuple'>

3.class的方法名稱與函數綁定，這里我們把函數fn綁定到方法名hello上。

1.2.2   metaclass

metaclass，直譯為元類，簡單的解釋就是：metaclass是類的前提。

先定義metaclass，然后創建類，最后創建實例。

正常情況下，很少使用到metaclass。

首先定義ListMetaclass

>>> class ListMetaclass(type):  #metaclass是類的模板，必須從type派生

...    def __new__(cls, name, bases, attrs):

...        attrs['add'] = lambda self, vealue:self.append(value)    --方法的定義

...        return type.__new__(cls, name, bases, attrs)

...

>>>

>>> class Mylist(list, metaclass = ListMetaclass):

...    pass

...

>>> L = Mylist()

>>> L

[]

>>> L.add(1)

>>> L

[1]

Python解釋器在創建MyList時，要通過ListMetaclass.__new__()來創建；在此我們可以修改metaclass的定義如加上新的方法達到新增功能。

__new__()方法接收到的參數依次是：

1.當前準備創建的類的對象；

2.類的名字；

3.類繼承的父類集合；

4.類的方法集合。

1.2.2.1  ORM

表示這部分內容比較難理解。

開始介紹metaclass就提到：metaclass使用的場景很少，而ORM場景便是一個典型的例子。作為DBA，我認為這個技能需要掌握。

ORM全稱“Object RelationalMapping”，即對象-關系映射，就是把關系數據庫的一行映射為一個對象，也就是一個類對應一個表，這樣，寫代碼更簡單，不用直接操作SQL語句。

要編寫一個ORM框架，所有的類都只能動態定義，因為只有使用者才能根據表的結構定義出對應的類來。

讓我們來嘗試編寫一個ORM框架。

編寫底層模塊的第一步，就是先把調用接口寫出來。比如，使用者如果使用這個ORM框架，想定義一個User類來操作對應的數據庫表User，我們期待他寫出這樣的代碼：

class User(Model):

    #定義類的屬性到列的映射：

   id = IntegerField('id')

   name = StringField('username')

   email = StringField('email')

   password = StringField('password')

# 創建一個實例：

u = User(id=12345, name='Michael',email='test@orm.org', password='my-pwd')

# 保存到數據庫：

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):

       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):

       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類的修改；

在當前類（比如User）中查找定義的類的所有屬性，如果找到一個Field屬性，就把它保存到一個__mappings__的dict中，同時從類屬性中刪除該Field屬性，否則，容易造成運行時錯誤（實例的屬性會遮蓋類的同名屬性）；

把表名保存到__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框架。