Django项目urls.py无法导入app视图的原因及部署疑问

核心原因 #

• 你的IDE/编辑器未将项目根目录识别为Python源目录：Python解释器仅在sys.path列表内的目录搜索模块。旧项目中IDE自动将根目录加入sys.path，因此from appname import views可生效；新项目未完成此配置，解释器找不到app模块，自然没有自动补全功能。
• 新项目目录结构与旧项目不一致：比如app未放在项目根目录下，而是嵌套在子文件夹中，直接from appname import会无法定位模块。

把项目目录设为源目录是不是唯一解决办法？ #

不是，还有几种实用方案：

1. 使用相对导入：若urls.py和app都在项目根目录，可写from .appname import views（注意开头的点），不过部分场景下可能存在导入层级问题。
2. 手动修改sys.path：在项目的settings.py或urls.py开头添加代码，将项目根目录加入搜索路径：

   import sys
   from pathlib import Path
   sys.path.append(str(Path(__file__).parent))
   

3. 使用Django的include路由（DRF推荐写法）：无需直接导入视图，将app的urls文件包含进项目主路由即可：

   from django.urls import path, include
   
   urlpatterns = [
       path('api/', include('appname.urls')),
   ]
   

   之后在app目录下创建urls.py，编写具体的路由与视图映射。

将项目目录设为源目录在服务器部署时会有问题吗？ #

通常不会，只要部署环境的Python解释器能正确定位项目目录：

• 使用虚拟环境时，激活环境后启动项目，Python会自动将当前工作目录加入sys.path（前提是在项目根目录启动服务）。
• 用uWSGI、Gunicorn等部署工具时，只要配置文件指定了项目根目录路径，或启动命令在项目根目录执行，就不会出现问题。
• 若部署时路径异常，可在启动脚本中手动将项目根目录加入sys.path，逻辑与本地开发一致。

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