Django打字提示包

django-hint的Python项目详细描述


Django_hint是一个模块,可以帮助您键入提示,提示您的django项目使用不同的ide。

Notice: Python3.6 or later is required for this module

安装

您可以使用pip来安装django_提示

pip3 install django_hint

用法

可以使用django_hint来提示以下用例类型,以帮助IDE识别变量的类型。

  1. 数据库查询集
  2. wsgirequest
  3. django rest framework令牌身份验证
  4. 模型类

另外,所有来自typing模块的本地python类型提示,如ListUnionOptional等,都可以从django_hint

数据库查询集

它用于提示变量是一个包含多个对象的QuerySet对象,我们将确定这些对象的性质。
您需要将其提示给QueryType,并在[]中传递对象类型。示例:

fromdjango_hintimportQueryTypesample_query:QueryType[SampleModel]=SampleModel.objects.filter(name='sample')

变量sample_query将被视为QuerySet。在对象之间循环时,每个对象都将被视为SampleModel

wsgirequest

它用于提示视图的request参数的性质(基于函数和类)。 request将被视为附加有user变量的HttpRequest。示例:

fromdjango_hintimportRequestTypedefsample_view(request:RequestType):ifrequest.user.is_authenticated:print(request.POST.get('data'))

django rest framework令牌身份验证

如果使用Django-Rest-Framework的令牌身份验证,则请求对象将具有user变量和rest_framework.authtoken.models.Token实例的auth变量。DRFTokenRequestType将提示这两个变量的ide。

fromdjango_hintimportDRFTokenRequestTypedefsample_view(request:DRFTokenRequestType):print(request.auth.key)

模型类

django向Model实例添加了一些属性,这些属性在models.Model中不可用,在ide中也不可用。 最显著的属性是Manager,可以通过名为objects的属性访问该属性。
要在IDE中包含这些属性,您必须将模型扩展到StandardModelType类和django_hint类,并像使用任何其他模型类一样使用它。
请注意,StandardModeltype不会对数据库产生任何影响,也不会对makemigrations命令进行新的迁移。

fromdjango.dbimportmodelsfromdjango_hintimportStandardModelTypeclassSampleModel(models.Model,StandardModelType):"""Just like any other model"""pass

欢迎加入QQ群-->: 979659372 Python中文网_新手群

推荐PyPI第三方库


热门话题
将PHP生成的公钥转换为Java公钥   java在服务中启动可取消的后台任务   java我能做这个通用的事情吗?   java Axis 1.4.1版在IBM上的部署为8.5版   java如何进行同步web服务调用   java从Spring控制器中的多个select获取值   java如何在JFrame中声明类(包含sapache Poi)的对象   jaxb反序列化XML以在Java中动态创建类   java如何为部署在Google云上的应用程序实现Google OAuth?   java我想了解libgdx的资产管理器   Java整数溢出   Windows任务管理器javaw。exe内存与Java任务控制   java如何让Android等待?