Python-元类编程实现ORM

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方法之前调用的，其参数如下：

1. 当前准备创建的类cls；
2. 类的名字；
3. 类继承的父类集合；
4. 类的方法集合

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

1. IntField和CharField属于数据属性描述符。
2. ModelMetaClass是定义的元类，必须继承type，new函数调用type创建并返回创建的类。
3. BaseModel参数中需要使用metaclass指定ModelMetaClass元类。
4. User 继承BaseModel，运行时BaseModel和User两个类先后根据元类ModelMetaClass被动态创建。
5. 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