Django ORM 查询管理器源码解析


Posted in Python onAugust 05, 2019

ORM 查询管理器

对于 ORM 定义: 对象关系映射, Object Relational Mapping, ORM, 是一种程序设计技术,用于实现面向对象编程语言里不同类型系统的数据之间的转换。从效果上说,它其实是创建了一个可在编程语言里使用的“虚拟对象数据库”。ORM 能大大简化并抽象数据库的操作.

假设 django 的一个工程中包含一个名为 Book 的模块(model), 在 views.py 的函数中可能会写出查询语句:

# views.py
def index(request):
  book_set = Book.objects.filter(id=1)
  或者
  book_set = Book.objects.all()
  ......

ORM 的作用就是这样, 并不需要写更复杂的 SQL 语句, 所有的的事情都被 ORM 代劳了.

上面中, Book 实际上是一个 Model 实例, 但先是从 Book.objects 开始说起. Book.objects 实际上是一个 Manager 类实例, 每个 Model 都会有一个, 用户的查询操作几乎是从这里开始的. 万万可以将 Model 实例理解为关系表中的一个表项数据, 而 Manager 实例可以理解数据库查询的入口.

实际上, 无论如何都在 Model 类的源码中找到任何 objects 属性的字眼, 因此它肯定是在某个时间点上增加的. 可以在 django.db.models.manager.py 中找到下面的函数:

这个函数确保每一个 model 都有一个管理器 objects

def ensure_default_manager(sender, **kwargs):
  ......
  if not getattr(cls, '_default_manager', None):
    # Create the default manager, if needed.
    try:
      cls._meta.get_field('objects')
      raise ValueError("Model %s must specify a custom Manager, because it has a field named 'objects'" % cls.__name__)
    except FieldDoesNotExist:
      pass
    """
    关键的一步, 将一个 Manager 实例挂钩到 cls.objects, 将 model.add_to_class() 方法罗列如下;
    def add_to_class(cls, name, value):
      if hasattr(value, 'contribute_to_class'):
        value.contribute_to_class(cls, name)
      else:
        setattr(cls, name, value)
    关键是 Manager 有 contribute_to_class() 方法, 由此看来, model.objects 并不是一个 Manager 实例, 实际上他是一个 ManagerDescriptor 实例.
    """
    cls.add_to_class('objects', Manager())
    cls._base_manager = cls.objects
  elif not getattr(cls, '_base_manager', None):
    default_mgr = cls._default_manager.__class__
    if (default_mgr is Manager or
        getattr(default_mgr, "use_for_related_fields", False)):
      cls._base_manager = cls._default_manager
    else:
      # Default manager isn't a plain Manager class, or a suitable
      # replacement, so we walk up the base class hierarchy until we hit
      # something appropriate.
      for base_class in default_mgr.mro()[1:]:
        if (base_class is Manager or
            getattr(base_class, "use_for_related_fields", False)):
          cls.add_to_class('_base_manager', base_class())
          return

由此可以发现, Model.objects 在这个时候被添加了. 因此用户可以在代码中使用 Book.objects. 至于这个函数在何时被调用, 待后面会详述 django 内部的信号机制. 暂且你可以将其理解为在 django 服务器启动的时候, 这些会被自动调用就好了.

Manager 实现

Manager 保护技法

如果可以在 book_set = Book.objects.filter(id=1) 这一句上设置断点, 并 step into 的时候, 发现 Book.objects 实际上的实际上不是一个 Manager 实例, 而是一个 ManagerDescriptor 实例, 这是 django 特意为 Manager 做的一层包装. 为什么要这么做 ?

django 规定, 只有 Model 类可以使用 objects, Model 类实例不可以. 请注意区分类和类实例之间的区别.

我认为这样做是有道理的. Book.objects.filter(id=1) 返回的是 QuerySet 对象, 而 QuerySet 对象可以看成是 Model 实例的集合, 也就是 book_set 是 Model 实例的集合. 假使 「Model 类的实例可以使用 objects 属性」, 即「从一本书中查询书」这在语意上不通过. 只能是「从书的集合(Book)中查询书」.

所以 django 用 ManagerDescriptor 特意为 Manager 做的一层包装. 可以在 django.db.models.manager.py 中找到

ManagerDescriptor 的实现:

class ManagerDescriptor(object):
  """

很经典的掩饰, 为 Manager 特殊设定 Descriptor, 从而, 只能让类访问, 而不能让类的实例来访问. 具体是靠 __get__(self, instance, type=None) 方法来实现来的: 第二个参数 instance, 当 class.attr 的时候, instance 为 None; 当 obj.attr 的时候, instance 为 obj.

"""
  # This class ensures managers aren't accessible via model instances.
  # For example, Poll.objects works, but poll_obj.objects raises AttributeError.

  def __init__(self, manager):
    self.manager = manager
  def __get__(self, instance, type=None):
    if instance != None:
      raise AttributeError("Manager isn't accessible via %s instances" % type.__name__)
    return self.manager

所要详述的是 __get__() 函数. python 的语法里有修饰器(descriptor)这么一说, 而 python 的属性类型就是这么实现的. descriptor 实现 __get__(), __set__(), 接着将其添加到一个类中. 譬如下面的例子:

class Celsius(object):
  def __init__(self, value=0.0):
    self.value = float(value)
  def __get__(self, instance, owner):
    print instance,owner
    return self.value
  def __set__(self, instance, value):
    print instance,value
    self.value = float(value)

class Temperature(object):
  celsius = Celsius()

t = Temperature()
t.celsius
Temperature.celsius

当对 descriptor 赋值的时候, 其本身 __set__ 会被调用, 取值的时候 __get__() 会被调用. __set__,__get__ 函数的 instance 参数即为类实例(所以, t.cellsius 调用 __get__() 的时候, instance 参数是 t, Temperature.celsius 调用 __get__() 的时候, instance 参数是 Temperature).

所以, 可以通过判断 instance 来判断调用者是否是类实例. 也就由此可以拒绝类实例的访问, 发现 ManagerDescriptor 就是这么实现的.

总结

Book.objects 实际上是一个 Manager, 实际上的实际上却是一个 ManagerDescriptor, 但真正起作用的还是 Manager, ManagerDescriptor 是修饰器, 是 django 的保护技法.

从 Manager 的实现来看, 它的多数函数会返回 QuerySet 对象, 而且透漏了一个重点: QuerySet 对象可以看成是 Model 实例的集合.

我已经在 github 备份了 Django 源码的注释: Decode-Django, 有兴趣的童鞋 fork 吧.

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持三水点靠木。

Python 相关文章推荐
在Python程序中操作文件之flush()方法的使用教程
May 24 Python
Python实现霍夫圆和椭圆变换代码详解
Jan 12 Python
TensorFlow的权值更新方法
Jun 14 Python
Python 字符串换行的多种方式
Sep 06 Python
Python最小二乘法矩阵
Jan 02 Python
python使用Plotly绘图工具绘制水平条形图
Mar 25 Python
python__new__内置静态方法使用解析
Jan 07 Python
python 8种必备的gui库
Aug 27 Python
Python进行特征提取的示例代码
Oct 15 Python
python如何写个俄罗斯方块
Nov 06 Python
用Python提取PDF表格的方法
Apr 11 Python
python获取带有返回值的多线程
May 02 Python
python实现车牌识别的示例代码
Aug 05 #Python
使用python实现滑动验证码功能
Aug 05 #Python
Django 源码WSGI剖析过程详解
Aug 05 #Python
Python使用itchat 功能分析微信好友性别和位置
Aug 05 #Python
Python队列RabbitMQ 使用方法实例记录
Aug 05 #Python
Python 通过微信控制实现app定位发送到个人服务器再转发微信服务器接收位置信息
Aug 05 #Python
基于python框架Scrapy爬取自己的博客内容过程详解
Aug 05 #Python
You might like
短波问题解答
2021/02/28 无线电
php allow_url_include的应用和解释
2010/04/22 PHP
php urlencode()与urldecode()函数字符编码原理详解
2011/12/06 PHP
关于尾递归的使用详解
2013/05/02 PHP
PHP实现的各类hash算法长度及性能测试实例
2017/08/27 PHP
PHP实现递归的三种方法
2020/07/04 PHP
window.addeventjs事件驱动函数集合addEvent等
2008/02/19 Javascript
Jquery Ajax学习实例6 向WebService发出请求,返回DataSet(XML) 异步调用
2010/03/18 Javascript
浅谈jQuery异步对象(XMLHttpRequest)
2014/11/17 Javascript
使用jQuery管理选择结果
2015/01/20 Javascript
异步JavaScript编程中的Promise使用方法
2015/07/28 Javascript
jquery关于事件冒泡和事件委托的技巧及阻止与允许事件冒泡的三种实现方法
2015/11/27 Javascript
Javascript实现跑马灯效果的简单实例
2016/05/31 Javascript
全面了解函数声明与函数表达式、变量提升
2016/08/09 Javascript
js 轮播效果实例分享
2016/12/28 Javascript
webpack4之SplitChunksPlugin使用指南
2018/06/12 Javascript
浅析vue插槽和作用域插槽的理解
2019/04/22 Javascript
解决一个微信号同时支持多个环境网页授权问题
2019/08/07 Javascript
vue 数据操作相关总结
2020/12/17 Vue.js
Python中Collections模块的Counter容器类使用教程
2016/05/31 Python
python利用正则表达式提取字符串
2016/12/08 Python
详解python中的文件与目录操作
2017/07/11 Python
深入浅析Python中的yield关键字
2018/01/24 Python
python通过zabbix api获取主机
2018/09/17 Python
python中的句柄操作的方法示例
2019/06/20 Python
Tensorflow实现部分参数梯度更新操作
2020/01/23 Python
Python终端输出彩色字符方法详解
2020/02/11 Python
解决pyPdf和pyPdf2在合并pdf时出现异常的问题
2020/04/03 Python
python右对齐的实例方法
2020/07/05 Python
python3实现简单飞机大战
2020/11/29 Python
pycharm实现猜数游戏
2020/12/07 Python
波兰最大的儿童服装连锁店之一:5.10.15.
2018/02/11 全球购物
军训生自我鉴定范文
2013/12/27 职场文书
党员一句话承诺大全
2014/03/28 职场文书
大学毕业生求职自荐书
2014/06/05 职场文书
大学生求职信例文
2014/06/29 职场文书