python利用元类和描述器实现ORM模型代码示例

本篇文章小编给大家分享一下python利用元类和描述器实现ORM模型代码示例，文章代码介绍的很详细，小编觉得挺不错的，现在分享给大家供大家参考，有需要的小伙伴们可以来看看。

ORM模型：

ORM模型对于后端开发来说肯定是不陌生的，包括很多后端框架比如django，现在都自带这个模型了

ORM（Object Relational Mapping）对象关系映射

Python中的类与数据库之间的映射，对数据的操作就不用编写SQL语言了，因为都封装好了，比如你想插入一条数据，你就直接创建一个对象即可，

类名 ------->>>> 数据库中的表名

属性 ------->>>> 数据库中的字段

对象 ------->>>> 数据库中的一行数据

大致就是上面的映射关系

ORM实现步骤：

1、利用描述器实现对数据库字段的类型、长度限制

2、实现模型类，也就是创建一张表并定义字段

3、利用元类实现映射关系

元类：

1.实例对象是通过类来创建，那类又是通过什么创建的呢？python中所有的类都是通过元类来创建类，且这个元类只有一个那就是type；

class Test:
    pass

t = Test()
print(type(Test))  #类是通过元类type创建
print(type(t))  #实例对象是通过类创建
#输出-----------------------

2.除了通过class关键字创建类，我们也可以通过元类type来创建类，type作为python的内置函数，其实他也是一个类，他有两个作用：

1.传入一个变量，返回这个变量的类型；

2.创建类时，第一个参数传入类名，第二个参数传入一个元祖，指定父类，第三个参数传入字典设置类的属性或方法；

#通过元类来创建类
test1 = type("test2",(object,),{"name":"xiaoming"})
t1 = test1()

print(type(test1))
print(type(t1))
#输出---------------

自定义元类：

1.自定义一个元类，这个元类必须继承type，用这个元类创建类时，必须使用metaclass指定他的元类；

class MetaClass(type):
    """自定义一个元类，这个元类必须继承type，用这个元类创建类时，必须使用metaclass指定他的元类"""
    def __new__(cls, name, bases, dic, *args, **kwargs):
        return super().__new__(cls, name, bases, dic)

class Test(metaclass = MetaClass):
    name = "xiaoming"

print(type(Test))
#输出----------------
  #可以看到此时这个类创建是用我们自定义的元类创建的，而不是type创建的

描述器：

1.描述器的定义，只要一个类中实现了__get__、set、__delete__中的一个或几个，这个类的实例就可以叫描述器，那描述器有神么作用呢，在我们给描述器设置属性时，一定会调用描述器里面的—set—方法，那我们在设置属性之前是不是可以在set方法里面，做一些手脚，比如校验这个属性长度，类型等等，如果不符合要求那就抛错，如果符合那就设置成功；

class Describer:
"""
这是一个描述器，描述器一般不直接实例化对象，而是在另一个类里，给他设置属性
"""

    def __set__(self, instance, value):
        print("设置属性的时候会被调用")
        self.value = value

    def __get__(self, instance, owner):
        print("获取属性的时候会被调用")
        return self.value

    def __delete__(self, instance):
        print("删除属性的时候会被调用")
        self.value = None


class Test:
    name = Describer()

t = Test()
t.name = "xiaoming"  #给描述器设置一个类属性
print(t.name)  #获取一个类属性
#输出---------------
设置属性的时候会被调用
获取属性的时候会被调用
xiaoming

利用描述器实现对数据库字段的类型、长度限制

设置属性一定会调用描述器里面的—set—方法，再设置属性之前校验这个属性长度，类型等等，如果不符合要求那就抛错，如果符合那就设置成功；

class BaseFiled:#为什么要先定义一个父类呢，一会我们改造元类的时候会用到
    pass


class CharFiled(BaseFiled):
    """定义一个字符串的类型限制"""

    def __init__(self, length=10):
        self.length = length

    def __set__(self, instance, value):
        if isinstance(value, str):
            if len(value) <= self.length:
                self.value = value
            else:
                raise ValueError("length can not exceed {}".format(self.length))
        else:
            raise TypeError("need a str")

    def __get__(self, instance, owner):
        return self.value

    def __delete__(self, instance):
        self.value = None


class IntFiled(BaseFiled):
    """定义一个数值的类型限制"""

    def __set__(self, instance, value):
        if isinstance(value, int):

            self.value = value
        else:
            raise TypeError("need a int")

    def __get__(self, instance, owner):
        return self.value

    def __delete__(self, instance):
        self.value = None

实现模型类，也就是创建一张表并定义字段：

模型类，这些字段是通过描述器来进行长度和类型校验的

class User():
"""这是一个模型类,相当于定义了一个表名是User的表，表有三个字段name，age，love"""
    name = CharFiled()
    age = IntFiled()
    love = CharFiled(length=50)

如果是这样的话我们给这个类实例化的时候，需要这样传值：

t1 = User()
t1.name = "xiaoming"
t1.age = 18
t1.love = "single"

如果我们需要一次性传入三个值得话，那就需要一个__init__来接收，但是模型类一般里面不定义init，所以我们可以给他找个父类，然后让他继承父类的init，这样我们就可以一次传入多个值，并且参数个数也不限定，优化如下：

class BaseMode():

    def __init__(self, **kwargs):
        """
        由于每一个模型类（也就是数据库表）的属性个数不一致，所以我们需要定义一个父类来进行定义初始化的属性
        :param kwargs:
        """
        for k, v in kwargs.items():   # 遍历传进来的所有属性
            setattr(self, k, v)   # 拿到这些属性后对self（也就是类本身）进行设置属性

class User(BaseMode):
"""第一个模型类"""
    name = CharFiled()
    age = IntFiled()
    love = CharFiled(length=50)

t1 = User(name= "xiaoming",age=18,love="xxx")#现在我们就可以一次传入多个值，并且参数个数也不限定

class Oder(BaseMode):
    """第二个模型类"""
    id = CharFiled()
    count = IntFiled()
    
t2 = Oder(id ="a1",count = 123)

利用元类实现模型类和数据库映射关系：

其实就是创建模型类的时候，提取模型类的类名作为表名，提取模型类的属性作为字段名，存储在模型类的类属性里，然后备用，代码如下：

class MetaClass(type):
    """自定义一个元类，这个元类必须继承type，用这个元类创建类时，必须使用meteclass指定他的元类"""
    def __new__(cls, name, bases, dic, *args, **kwargs):
        if name == "BaseMode":   # （User，Oder，BaserMode都指定了用这个元类）我们的目的是对模型类（User，Oder）进行提取操作，不对BaserMode进行操作，所以先判断类名是否为BaseMode，如果是则直接使用元类创建类，不需要提取
            return super().__new__(cls, name, bases, dic)
        else:
            table_name = name.lower()  # 提取表名，即模型类的类名，将表名变成小写
            filed_dic = {}   # 定义一个空的列表，用来装dic中（dic中的属性就是模型类里面我们写的字段）属于BaseFiled类型的属性，因为dic中会有其他创建类时自动生成的属性（例如__开头的一些），这些属性我们没必要去建立映射关系，所以需要将其剔除掉
            for k, v in dic.items():
                if isinstance(v,BaseFiled):
                    filed_dic[k] = v
            dic["t_name"] = table_name    # 给dic新加一个t_name的属性，将表名添加到dic中，实现类名与表名的映射关系
            dic["filed_dict"] = filed_dic  # 给dic新加一个filed_dict的属性，将属于BaseFiled类型的属性给添加到dic中，实现属性与字段的映射关系
        return super().__new__(cls, name, bases,dic)

**创建模型类的时候，利用给他指定元类，提取了表名和字段名，我们具体要怎么用呢？**我们可以在模型类的父类里面定义一个save方法，然后用这些字段写sql，在我们创建模型类的实例后，就调用这个save方法，即可向数据库插入一条数据了，如下：

class BaseMode(metaclass=MetaClass):

    def __init__(self, **kwargs):
        """
        由于每一个模型类（也就是数据库表）的属性个数不一致，所以我们需要定义一个父类来进行定义初始化的属性
        :param kwargs:
        """
        for k, v in kwargs.items():   # 遍历传进来的所有属性
            setattr(self, k, v)   # 拿到这些属性后对self（也就是类本身）进行设置属性

    def save(self):
        """生成SQL语句"""
        # 获取表名
        table_name = self.t_name
        # 获取所有的属性
        fileds = self.filed_dict
        dic = {}  # 定义一个空字典，用来装属性名和属性值
        for k, v in fileds.items():
            value = getattr(self, k)
            dic[k] = value
        sql = "insert into {} values{}".format(table_name, tuple(dic.values()))
        print(sql)
        return sql

class User(BaseMode):
    name = CharFiled()
    age = IntFiled()
    love = CharFiled(length=50)


class Oder(BaseMode):
    """第二个模型类"""
    id = CharFiled()
    count = IntFiled()

t2 = Oder(id ="a1",count = 123)#实例化模型类，并调用save方法，即可向数据库插入数据
t2.save()

t1 = User(name= "xiaoming",age=18,love="xxx")
t1.save()
#输出-----------------------
insert into oder values('a1', 123)
insert into user values('xiaoming', 18, 'xxx')

至此我们的一个简单的ORM模型就定义好了，我们只需要理解原理即可，因为一个成熟的后端框架都有现成的ORM模型，例如django和flask都自带的有，最后再附上全部代码，如果有帮到你，能点个赞吗，谢谢咯~~~

class MetaClass(type):
    """自定义一个元类，这个元类必须继承type，用这个元类创建类时，必须使用meteclass指定他的元类"""
    def __new__(cls, name, bases, dic, *args, **kwargs):
        if name == "BaseMode":   # （User，Oder，BaserMode都指定了用这个元类）我们的目的是对模型类（User，Oder）进行提取操作，不对BaserMode进行操作，所以先判断类名是否为BaseMode，如果是则直接使用元类创建类，不需要提取
            return super().__new__(cls, name, bases, dic)
        else:
            table_name = name.lower()  # 提取表名，即模型类的类名，将表名变成小写
            filed_dic = {}   # 定义一个空的列表，用来装dic中（dic中的属性就是模型类里面我们写的字段）属于BaseFiled类型的属性，因为dic中会有其他创建类时自动生成的属性（例如__开头的一些），这些属性我们没必要去建立映射关系，所以需要将其剔除掉
            for k, v in dic.items():
                if isinstance(v,BaseFiled):
                    filed_dic[k] = v
            dic["t_name"] = table_name    # 给dic新加一个t_name的属性，将表名添加到dic中，实现类名与表名的映射关系
            dic["filed_dict"] = filed_dic  # 给dic新加一个filed_dict的属性，将属于BaseFiled类型的属性给添加到dic中，实现属性与字段的映射关系
        return super().__new__(cls, name, bases,dic)


class BaseFiled:
    pass


class CharFiled(BaseFiled):
    """定义一个字符串的类型限制"""

    def __init__(self, length=10):
        self.length = length

    def __set__(self, instance, value):
        if isinstance(value, str):
            if len(value) <= self.length:
                self.value = value
            else:
                raise ValueError("length can not exceed {}".format(self.length))
        else:
            raise TypeError("need a str")

    def __get__(self, instance, owner):
        return self.value

    def __delete__(self, instance):
        self.value = None


class IntFiled(BaseFiled):
    """定义一个数值的类型限制"""

    def __set__(self, instance, value):
        if isinstance(value, int):

            self.value = value
        else:
            raise TypeError("need a int")

    def __get__(self, instance, owner):
        return self.value

    def __delete__(self, instance):
        self.value = None

class BaseMode(metaclass=MetaClass):

    def __init__(self, **kwargs):
        """
        由于每一个模型类（也就是数据库表）的属性个数不一致，所以我们需要定义一个父类来进行定义初始化的属性
        :param kwargs:
        """
        for k, v in kwargs.items():   # 遍历传进来的所有属性
            setattr(self, k, v)   # 拿到这些属性后对self（也就是类本身）进行设置属性

    def save(self):
        """生成SQL语句"""
        # 获取表名
        table_name = self.t_name
        # 获取所有的属性
        fileds = self.filed_dict
        dic = {}  # 定义一个空字典，用来装属性名和属性值
        for k, v in fileds.items():
            value = getattr(self, k)
            dic[k] = value
        sql = "insert into {} values{}".format(table_name, tuple(dic.values()))
        print(sql)
        return sql

class User(BaseMode):
    name = CharFiled()
    age = IntFiled()
    love = CharFiled(length=50)


class Oder(BaseMode):
    """第二个模型类"""
    id = CharFiled()
    count = IntFiled()

t2 = Oder(id ="a1",count = 123)
t2.save()

t1 = User(name= "xiaoming",age=18,love="xxx")
t1.save()