typeddjango/djangorestframework-stubs

说明与用途

**项目简介**
typeddjango/djangorestframework-stubs 为 Django REST Framework（DRF）提供 PEP‑484 类型存根（.pyi），让 IDE 与类型检查工具（mypy、pyright 等）能够对 DRF 的视图、序列化器、路由等进行静态类型推断。

**价值**

• **提升开发体验**：在编辑器中获得自动补全、跳转和即时类型错误提示，显著降低调试成本。
• **代码质量保障**：配合 mypy/pyright 等工具，能够在 CI 中捕获 API 参数、返回值以及序列化字段的不匹配，防止运行时异常。
• **无侵入式**：仅通过安装类型存根，不需要修改现有的 DRF 代码或配置，即可在项目中启用。

**典型接入方式**

1. **安装**

   pip install djangorestframework-stubs

1. **在项目的 mypy.ini（或 pyproject.toml）中启用**

   [mypy]
   plugins = pydantic.mypy
   disallow_untyped_calls = True
   disallow_untyped_defs = True
   ignore_missing_imports = True

1. **在代码中使用类型注解**

   from rest_framework.views import APIView
   from rest_framework.request import Request
   from rest_framework.response import Response

   class HelloView(APIView):
       def get(self, request: Request) -> Response:
           return Response({"msg": "hello"})

1. **在 CI 中运行类型检查**

   mypy myproject/

**生产可用性**

• **活跃度**：截至 2026‑06‑23 最近一次提交，拥有 538 ★、138 Fork，社区活跃且持续维护。
• **兼容性**：支持最新的 Django 4.x 与 DRF 3.14+，并已在多个开源项目中验证。
• **风险**：许可证为 MIT，符合企业合规；暂无已知安全漏洞。唯一需要关注的是后续 DRF 主版本升级时的存根同步情况。

综合来看，djangorestframework-stubs 已具备 **高生产就绪度**，适合作为类型安全的第一步在现有 DRF 项目中试点，随后可在全链路 CI/CD 中推广。

实际用途

typeddjango/djangorestframework-stubs may be useful when its README and activity match a concrete workflow.

限制与审查说明

High for an OSS candidate: recent activity, adoption, and ecosystem signals are strong enough for a serious pilot.