跳转到主要内容

PEP-484 stubs for django-rest-framework

项目描述

mypy logo

pep484 stubs for Django REST framework

Build Status Checked with mypy Gitter

Mypy stubs for Django REST Framework. Supports Python 3.8 and up.

安装

pip install djangorestframework-stubs[compatible-mypy]

要让mypy识别插件,您需要在

[mypy]
plugins =
    mypy_drf_plugin.main

您的 mypy.ini 文件中添加以下内容。

常见问题解答(FAQ)

模型实例被推断为 Any 而不是我的 Model

当子类化 ModelSerializer 时,为相关模型类添加一个 类型参数 以进行类型提示,例如

class MyModelSerializer(serializers.ModelSerializer[MyModel]):
    class Meta:
        model = MyModel
        fields = ("id", "example")

这意味着在传递模型的方法中,将知道模型的实际类型而不是 Any。上面序列化器的 instance 属性将是 Union[MyModel, typing.Sequence[MyModel], None]

获取帮助

我们在这里有Gitter:https://gitter.im/mypy-django/Lobby 如果您认为您有更通用的类型问题,请参阅 https://github.com/python/mypy 以及他们的Gitter。

贡献

此项目是开源的,由社区驱动。因此,我们鼓励大小贡献。您可以通过以下方式之一进行贡献

  1. 贡献代码(例如,改进存根,添加插件功能,编写测试等) - 请遵循 贡献指南
  2. 协助代码审查和问题讨论。
  3. 识别错误和问题并向这些报告

您也可以在gitter上联系以讨论您的贡献!

项目详细信息


下载文件

下载您平台上的文件。如果您不确定要选择哪个,请了解更多关于 安装包 的信息。

源代码分发

djangorestframework_stubs-3.15.1.tar.gz (35.2 kB 查看哈希值)

上传时间 源代码

构建分发

djangorestframework_stubs-3.15.1-py3-none-any.whl (54.4 kB 查看哈希值)

上传时间 Python 3

由以下组织支持