Django自定义Lookup使用%取模运算符触发格式错误问题问询

问题代码 #

from django.db.models import Lookup

class NotEqual(Lookup):
    lookup_name = 'div'

    def as_sql(self, compiler, connection):
        lhs, lhs_param = self.process_lhs(compiler, connection)
        rhs, rhs_param = self.process_rhs(compiler, connection)
        params = lhs_param + rhs_param

        return "%s %% %s == 0" % (lhs, rhs), params

触发的错误 #

执行Book.objects.filter(rating__div=5)时出现：

...
File "D:\PROJECTS\Projects_Personal\django_challenges_venv_\Lib\site-packages\MySQLdb\cursors.py", line 200, in _mogrify
query = query % args
~~~~~~^~~~~~
ValueError: unsupported format character '%' (0x25) at index 272

错误原因 #

这个错误的核心是MySQLdb的参数替换机制与手动转义的%符号冲突：

1. 代码中用%%是想生成SQL里的单个%取模运算符，拼接后得到的SQL片段类似book.rating % %s == 0（其中%s是Django生成的参数占位符）。
2. 当MySQLdb的_mogrify方法执行query % args替换参数时，会把SQL中的%当成Python字符串格式化的占位符标识。此时SQL里的% %s会被解析为：第一个%是格式化起始符，后面紧跟的%不是合法的格式化字符（合法格式如%s、%d），因此触发ValueError。

而使用MOD函数时，SQL语句中没有%符号，MySQLdb的参数替换流程不会被干扰，因此能正常运行。

解决方法 #

推荐使用Django提供的数据库操作适配方法生成取模SQL，自动处理不同数据库的语法差异，同时避免转义冲突：

from django.db.models import Lookup

class DivisibleBy(Lookup):
    lookup_name = 'div'

    def as_sql(self, compiler, connection):
        lhs, lhs_param = self.process_lhs(compiler, connection)
        rhs, rhs_param = self.process_rhs(compiler, connection)
        params = lhs_param + rhs_param
        # 利用connection.ops生成适配当前数据库的取模SQL
        mod_expr = connection.ops.mod_sql(lhs, rhs)
        return f"{mod_expr} = 0", params

内容的提问来源于stack exchange，提问作者SAIFUL KHAN