Django open_note视图报缺失必需位置参数docid的问题排查

所有报错本质都是Django路由、视图、模板的参数传递链路完全不匹配，没有把需要传递的docid从地址正确传到视图函数里：

• 你当前的open_note视图定义要求必须接收一个来自路由捕获的docid位置参数，但urls.py里的路由path('open-notes/', views.open_note, name='open-notes')没有配置任何路径捕获规则，Django调用视图时根本没有参数可以传给docid，直接触发open_note() missing 1 required positional argument: 'docid'报错。
• 你之前把docid放在URL的?后面当查询参数，这类参数本身就不是靠路由捕获传给视图的，需要在视图内部通过request.GET.get()手动读取，和路由传参的逻辑完全是两套。
• 你之前尝试把路由改成带路径参数的形式时，两个操作不一致：一方面路由里捕获的参数名是<int:id>，和视图要求的docid不匹配；另一方面模板里的{% url 'open-notes' %}没有给路由传需要的路径参数值，Django反向生成URL时找不到匹配规则，触发Reverse for 'open-notes' with no arguments not found报错。
• 视图内部还有隐藏逻辑bug：原来你写的docid = get_object_or_404(Document, pk=docid)会把原本的数字docid替换成Document模型实例，下一行Document.objects.all(pk=docid)传了个模型实例当主键查询值，后续运行还会继续报错。

你可以根据自己想使用的URL形式二选一即可，不需要两套逻辑混用。

方案1：适配你当前使用的「查询参数带docid」URL形式 #

也就是继续使用http://localhost:8000/notes/open-notes/?docid=1这类地址，不需要改现有路由规则：

• 保持urls.py原有路由不变，不需要修改：

  urlpatterns = [
      path('', views.view_notes, name='notes'),
      path('add-notes/', views.add_note, name='add-notes'),
      path('open-notes/', views.open_note, name='open-notes'),
      path('edit-note/', views.update_note, name='edit-note'),
      path('delete-note/', views.delete_note, name='delete-note'),
  ]
  

• 修改open_note视图函数，去掉需要路由传参的docid形参，改成从查询参数读取docid，同时修正原有的查询逻辑：

  def open_note(request):
      """ A view to show the currently open document """
      # 从URL查询参数里读取docid
      docid = request.GET.get('docid')
      # 没带docid时直接跳回笔记列表，避免报错
      if not docid:
          return redirect('notes')
      # 直接查出需要展示的单条文档，不用再把全表数据传给模板做循环匹配
      current_doc = get_object_or_404(Document, pk=docid)
      context = {
          'current_doc': current_doc,
      }
      return render(request, 'open-notes.html', context)
  

• 简化open-notes.html模板，去掉循环全表判断的逻辑，直接用传入的current_doc渲染内容。

方案2：改用REST风格的「路径带docid」URL形式 #

也就是把docid直接写在路径里（类似http://localhost:8000/notes/open-notes/1/），这也是Django更推荐的参数传递方式：

• 修改urls.py的open-notes路由，保证路径捕获的参数名和视图函数要求的docid完全一致：

  urlpatterns = [
      # 其他路由保持不变
      path('open-notes/<int:docid>/', views.open_note, name='open-notes'),
  ]
  

• 修改open_note视图函数，保留路由传参的形参，同时修正原有的查询逻辑：

  def open_note(request, docid):
      """ A view to show the currently open document """
      # 路由会自动把路径里的docid值传给视图函数
      current_doc = get_object_or_404(Document, pk=docid)
      context = {
          'current_doc': current_doc,
      }
      return render(request, 'open-notes.html', context)
  

• 修改notes.html里的笔记链接，把doc.id作为参数传给url标签做反向生成，不需要再手动拼?docid=查询参数：

  <!-- 原来的写法是 <a href="{% url 'open-notes' %}?docid={{ doc.id }}" class="..."> -->
  <a href="{% url 'open-notes' doc.id %}" class="logo-font font-weight-bold nav-link text-warning mr-5">
      {{ doc.title }}
  </a>
  

• 模板里"New document"的链接现在写的?docid={{ doc.id }}，因为doc变量是外层for循环内的临时变量，循环结束后这个变量就失效了，生成的链接里docid会是空值，需要后续调整。
• 编辑、删除页面的参数传递逻辑和open-notes完全一致，修好open-notes的逻辑后，照同样的方式调整另外两个页面即可。

内容的提问来源于stack exchange，提问作者daniel-mctighe