在Django中使用simple_history包注册User模型时遇到问题

我之前也踩过这个坑！用simple_history.register追踪第三方模型（比如Django自带的User模型）时，代码放的位置和时机不对很容易出问题，咱们来一步步解决：

正确的注册位置：AppConfig的ready方法 #

别把注册代码放在models.py或admin.py里，这两个文件的加载时机不合适，容易导致模型未初始化或循环导入问题。正确的做法是利用Django的AppConfig初始化钩子：

1. 打开你项目中任意一个自定义app的apps.py文件（比如我的app叫account），修改ready()方法：

from django.apps import AppConfig
from django.contrib.auth.models import User
import simple_history

class AccountConfig(AppConfig):
    default_auto_field = 'django.db.models.BigAutoField'
    name = 'account'

    def ready(self):
        # 在这里注册第三方模型的历史追踪
        simple_history.register(User)

2. 确保在settings.py的INSTALLED_APPS中，用这个自定义的AppConfig替换原来的app名称：

INSTALLED_APPS = [
    # ... 其他内置/第三方app
    'account.apps.AccountConfig',  # 替换成你的AppConfig路径
    # ...
]

为什么之前的位置不行？ #

• 放在models.py：Django加载模型时，第三方模型可能还未完成初始化，会导致注册失败；如果你的模型依赖User，还可能触发循环导入错误。
• 放在admin.py：admin的加载时机虽然稍晚，但仍可能早于历史表的创建流程，而且admin.py的职责是配置后台展示逻辑，不是做模型注册的合适场所。

额外注意事项 #

• 注册完成后，必须执行迁移命令生成历史表：

python manage.py makemigrations
python manage.py migrate

这会自动创建auth_user_history表来存储User模型的历史记录。

• 检查版本兼容性：确保你的simple_history版本和Django版本匹配（比如Django 4.x需要simple_history>=3.0）。
• 自定义历史记录：如果需要调整追踪规则，可以给register方法传参数，比如禁用历史用户关联：

simple_history.register(User, history_user_field=None)

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