Python-元類程式設計實現ORM
阿新 • • 發佈:2018-12-16
Python實現元類程式設計主要通過兩種方法:
- type函式
- metaclass元類
動態語言和靜態語言最大的不同,就是函式和類的定義,不是編譯時定義的,而是執行時動態建立的。
(一) type()函式
type(name, bases, attrs)
name:class的名稱;
bases:繼承的父類集合,以tuple形式傳入;
attrs:class的方法名稱與函式繫結,
注:通過type()函式建立的類和直接寫class是完全一樣的。當Python直譯器遇到class定義時,檢查class定義的語法,然後也是呼叫type()函式創建出class。
(1)建立class,沒有任何屬性:
User = type('User', (), {})
user = User()
type(user) # __main__.User
(2)建立class,附帶name屬性,其中屬性是屬於類的:
User = type('User', (), {'name':'apple'})
user = User()
user.__dict__ # {}
User.__dict__ # 輸出結果見下圖:
(3)建立class,附帶name屬性和say()方法,其中屬性和方法都是屬於類的:
def say(self, content='world'):
print('Hello', content)
User = type('User', (), {'name':'apple', 'say':say})
user = User()
user.say() # Hello world
user.__dict__ # {}
User.__dict__ # 輸出見下圖:
(二) metaclass 建立類
type()可以實現動態建立類,但是要控制類的建立行為,需要使用metaclass。metaclass直譯為元類,元類是用來定義類的,metaclass必須繼承type。先定義metaclass,然後建立class,最後class類建立例項。
利用metaclass建立類,需要用到 __new__魔術方法,new魔法方法是在init方法之前呼叫的,其引數如下:
- 當前準備建立的類cls;
- 類的名字;
- 類繼承的父類集合;
- 類的方法集合
class Person(type):
def __new__(cls, name, bases, attrs, **kwargs):
return type.__new__(cls, name, bases, attrs, **kwargs)
# 此處的type,也可以用super()來代替
#return super().__new__(cls, name, bases, attrs, **kwargs)
# 使用metaclass建立類,需要引數metaclass=Person
class User(metaclass=Person):
def __init__(self, name):
self.name = name
super().__init__()
def __str__(self):
return self.name
user = User('apple')
user.name # 'apple'
使用Metaclass自定義簡單的ORM
- IntField和CharField屬於資料屬性描述符。
- ModelMetaClass是定義的元類,必須繼承type,new函式呼叫type建立並返回建立的類。
- BaseModel引數中需要使用metaclass指定ModelMetaClass元類。
- User 繼承BaseModel,執行時BaseModel和User兩個類先後根據元類ModelMetaClass被動態建立。
- new方法是在init方法之前被呼叫,new方法用於建立類,init方法使用者初始化類的物件例項。
import numbers
class Field:
"""Field類"""
pass
class IntField(Field):
"""IntField資料描述符, 內部自定義檢查條件"""
def __init__(self, db_column, max_value=None):
self._value = None
self.db_column = db_column
if max_value < 0:
raise ValueError('max_value must be a positive number')
self.max_length = max_value
def __get__(self, instance, owner):
return self._value
def __set__(self, instance, value):
if not isinstance(value, numbers.Integral):
raise ValueError("int value need")
self._value = value
class CharField(Field):
"""CharField資料描述符, 自定義檢查條件"""
def __init__(self, db_column, max_length=None):
self._value = None
self.db_column = db_column
if max_length is None:
raise ValueError('max_length is needed')
self.max_length = max_length
def __get__(self, instance, owner):
return self._value
def __set__(self, instance, value):
if not isinstance(value, str):
raise ValueError("string value need")
self._value = value
class ModelMetaClass(type):
"""MetaClass元類"""
def __new__(cls, name, bases, attrs, **kwargs):
if name == "BaseModel":
return super().__new__(cls, name, bases, attrs, **kwargs)
fields = {}
for key, value in attrs.items():
if isinstance(value, Field):
fields[key] = value
attrs_meta = attrs.get("Meta", None)
_meta = {}
db_table = name.lower()
if attrs_meta is not None:
table = getattr(attrs_meta, "db_table", None)
if table is not None:
db_table = table
_meta["db_table"] = db_table
attrs["_meta"] = _meta
attrs["fields"] = fields
del attrs["Meta"]
# 最後需要建立並返回一個物件,通過type(super())
return super().__new__(cls, name, bases, attrs, **kwargs)
class BaseModel(metaclass=ModelMetaClass):
def __init__(self, **kwargs):
for key, value in kwargs.items():
setattr(self, key, value)
super().__init__()
def save(self):
fields = []
values = []
for key, value in self.fields.items():
db_column = value.db_column
if db_column is None:
db_column = key.lower()
fields.append(db_column)
value = getattr(self, key)
values.append(str(value))
sql = "insert {db_table}({fields}) value({values})".format(db_table=self._meta["db_table"],
fields=",".join(fields), values=",".join(values))
pass
class User(BaseModel):
"""
建立User類時,首先查詢引數中是否存在Metaclass元類,如果存在Metaclass元類,那麼由Metaclass元類建立User;如果User有繼承父類(如:BaseModel),那麼會從父類中查詢Metaclass,如果存在Metaclass元類,先建立父類BaseModel,然後再建立User類;如果User類引數中既沒有metaclass='',也沒有繼承父類(BaseModel)或者父類引數中沒有元類(metaclass=''),那麼User及其父類將由type(name, bases, attrs)建立。
"""
# 類屬性同時是CharField和IntFiled的例項,被傳遞給type(name, bases, attrs)中的attrs。
name = CharField(db_column="name", max_length=10)
age = IntField(db_column="age", max_value=100)
# 類屬性,被傳遞給type(name, bases, attrs)中的attrs。
class Meta:
db_table = "user"
if __name__ == "__main__":
user = User(name="wahaha", age=18)
print(user.name)
# user.name = "wahaha"
# user.age = 18
user.save()
pass