Django开发服务器修改apps目录代码不自动重载是什么原因？

问题根因分析 #

你遇到的是Django 3.2版本常见的autoreload匹配异常问题：Django已经监听到文件变更，但没有将变更文件识别为已加载的Python业务模块，因此只触发了模板/翻译变更的信号处理，没有触发服务重启逻辑，常见诱因有3种：

1. 模块路径匹配异常：项目内的软链接、sys.path配置顺序不对、INSTALLED_APPS注册写法与模块实际导入路径不一致，都会导致Django的autoreload逻辑无法将变更文件和已加载的模块关联起来
2. Django 3.2.6的已知bug：该版本的autoreload对多级子目录下的Python模块识别存在缺陷，官方在后续3.2的小版本补丁中修复了该问题
3. 子目录模块未被预加载：如果apps下的模块仅在运行时动态导入，Django启动阶段没有加载对应模块，也不会触发重启

可落地的排查&解决步骤 #

1. 优先验证模块路径匹配问题
   进入项目shell执行以下命令，确认模块文件路径和你修改的路径完全一致：

   python manage.py shell
   

   import apps.app_one.models
   print(apps.app_one.models.__file__)
   

   如果打印的路径和你实际修改的文件路径不一致（比如存在软链接解析差异、相对路径/绝对路径不匹配），修改settings.py中BASE_DIR的配置，确保指向项目真实的src目录，并且sys.path插入路径时使用绝对路径：

   # settings.py开头添加
   import os
   import sys
   BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
   # 如果之前有添加apps到路径的配置，替换为下面的写法
   sys.path.insert(0, os.path.join(BASE_DIR, 'apps'))
   

2. 修复Django版本bug
   直接升级Django到3.2系列最新稳定版即可：

   pipenv install django~=3.2.0
   

   升级后重启开发服务器即可生效，大部分同场景问题升级后都会直接解决。

3. 强制配置监听规则（临时兼容方案）
   如果不想修改现有环境配置，可以在settings.py末尾添加以下代码，强制指定apps目录下所有py文件变更都触发重启：

   import os
   from django.utils.autoreload import file_changed
   from django.dispatch import receiver
   
   @receiver(file_changed)
   def force_reload_on_apps_change(sender, file_path, **kwargs):
       if os.path.abspath(file_path).startswith(os.path.join(BASE_DIR, 'apps')) and file_path.endswith('.py'):
           return True
   

   该配置会强制让所有apps目录下的py文件变更都触发服务重启逻辑。

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