Django3 中遇到django.core.exceptions.ImproperlyConfigured mysqlclient 1.3.13 or newer is required; you

Posted 2021-03-08 aliensky

转自：https://yuntianti.com/posts/fix-django3-mysqlclient-import-error/

 

Django 近期发布了3.0版本，其中首度支持了asyncio让人兴奋, 为此引入了新的网关接口协议ASGI。
按异步IO的实现原理，即使使用ASGI替代WSGI部署Web应用，如果使用了一些同步库，肯定还是会阻塞IOLoop的，使应用失去异步特性。
但是Django的应用场景很多是有状态的，不得不使用一些带状态的库和函数。比如在mysql中执行事务，或一些前后状态依赖的逻辑，就不太可能异步出去。
个人觉得可以用Django路由对同步/异步部分逻辑做划分，部署时启动多个端口或部署到多个节点上，再用nginx基于path把同步/异步请求反向代理到不同的upstream上，避免同步逻辑阻塞异步逻辑，以此发挥ASGI的异步高并发特性。

---

下面进入正题:
安装Django3后不想折腾mysqlclient那堆库文件，直接装了pymysql替代mysqlclient。还是老办法，__init__.py 中patch一下:

import pymysql
pymysql.install_as_MySQLdb()

启动项目出现以下异常:

raise ImproperlyConfigured(‘mysqlclient 1.3.13 or newer is required; you have %s.‘ % Database.__version__)
django.core.exceptions.ImproperlyConfigured: mysqlclient 1.3.13 or newer is required; you have 0.9.3.

看来是Django3对mysqlclient的要求提高了: 1.3.13. 但pymysql的版本没有跟上。
看了下tracelog指向的异常抛出处的代码, 发现如下代码片段:

果然是有个版本判断并raise了异常，而且校验的是Database库的version_info属性。
那pymysql中的version_onfo属性是怎么返回的呢？找到pymysql源码，发现如下片段:

实际上pymysql版本号是 0.9.3，却明目张胆篡改version_info欺骗Django??。这样一来就简单了，patch一下这个属性就行了嘛， 修改__init__.py，多插入一行代码:

import pymysql
pymysql.version_info = (1, 3, 13, "final", 0)
pymysql.install_as_MySQLdb()

保存后启动项目成功。
该方案只是个兼容方案，不确定Django3是否依赖mysqlclient的新特性，因此生产环境还是建议部署mysqlclient，而非pymysql。

• mysqlclient与pymysql区别是什么？
  • mysqlclient是mysql官方提供的Python SDK，安装时依赖mysql-dev与python-dev相关的库函数完成当前系统平台的编译，因为使用大量C库，性能会比pymysql优秀得多。SDK更新和维护也有官方保障。
  • pymysql是第三方在MySQL通信协议上实现的SDK，所有与数据库的交互都是通过MySQL独有的通信协议完成，性能上会比mysqlclient有劣势。且版本更新可能滞后，且维护不一定到位。但好处就是pip install安装很容易，不像mysqlclient先要把编译依赖的C库装好，在一些建档任务和开发环境快速搭建上有优势。