Django inspectdb反向生成模型时丢失字段help_text注释如何解决

Django原生的inspectdb命令默认不会读取数据库中存储的字段注释来填充模型的help_text属性，核心原因是原生命令的设计仅生成满足基础ORM映射的最小字段定义，没有对接字段注释的读取逻辑。你可以通过自定义扩展inspectdb命令实现需求，具体操作如下：

• 首先在任意一个已注册的Django app下创建如下目录结构，确保每个目录下都存在空的__init__.py文件以被Python识别为合法包：

  你的app目录/
  └── management/
      ├── __init__.py
      └── commands/
          ├── __init__.py
          └── inspectdb.py
  

• 在新建的inspectdb.py中写入以下自定义逻辑，重写原生命令的字段生成方法，在生成字段参数时主动从MySQL拉取对应字段的注释，填充到help_text参数中：

  from django.core.management.commands.inspectdb import Command as BaseInspectCommand
  from django.db import connections
  
  
  class Command(BaseInspectCommand):
      def get_field_type(self, connection, table_name, row):
          field_type, field_params, field_notes = super().get_field_type(connection, table_name, row)
          field_name = row.name
          # 查询MySQL中存储的字段注释
          with connections[connection.alias].cursor() as cursor:
              cursor.execute(
                  """
                  SELECT COLUMN_COMMENT
                  FROM information_schema.COLUMNS
                  WHERE TABLE_SCHEMA = DATABASE()
                    AND TABLE_NAME = %s
                    AND COLUMN_NAME = %s
                  """,
                  [table_name, field_name]
              )
              col_comment = cursor.fetchone()[0]
          if col_comment:
              # 转义注释中的单引号，避免生成的Python代码语法错误
              field_params["help_text"] = col_comment.replace("'", "\\'")
          return field_type, field_params, field_notes
  

• 编写完成后直接按照原有方式执行python manage.py inspectdb命令即可，生成的模型代码会自动把数据库中存储的字段注释填充为对应字段的help_text属性，和之前通过django_comment_migrate写入的注释完全适配。

注意事项 #

• 如果后续切换到PostgreSQL、SQLite等其他数据库，只需要修改上述代码中查询字段注释的SQL语句，适配对应数据库的系统表结构即可，其余逻辑无需改动
• 生成模型代码后建议快速检查字段注释的转义情况，如果注释中存在反斜杠、三引号等特殊字符，可手动微调避免语法报错
• 该自定义命令完全兼容原生inspectdb的所有参数，指定输出表、指定数据库连接等参数都可以正常使用

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