码迷,mamicode.com
首页 > 其他好文 > 详细

pycahrm使用docstrings来指定变量类型、返回值类型、函数参数类型

时间:2017-11-16 14:07:51      阅读:190      评论:0      收藏:0      [点我收藏+]

标签:requests   dcos   弊端   本地   动态   xxx   ima   ict   fun   

py里面不需要显示声明类型,这和java c这些静态语言不同,虽然python这样做少了一些代码和写代码的困难度,但还是非常多的弊端的,运行速度 代码安全, 这些都是语言本身带来的本的弊端,这些没办法没办法弥补(说用c扩展和加入大量if isinstance来判断类型的,这是不好的不方便的)。但下面这两种却是可以通过docstrings来弥补的。

1.没有类型就给函数(或者方法)调用者带来麻烦,这个函数怎么用,这个参数代表什么,需要传一个什么样的参数来调用这个函数,函数返回什么东西,这都对代码阅读者和函数使用者带来很大麻烦。

2.没有类型就得不到第三方编辑器的有力提示和自动补全补全,pycharm不知道这个变量是个什么类型的对象,还咋能通过 点号 来补全呢,代码不能补全和智能提示,那用第三方ide工具和使用vim 记事本有什么区别。除了内置的int  float str list什么的对象,可能会比较熟悉他们的一些方法,当大量使用自定义的calss类型时候,不能补全和提示是个灾难。至于有些qq群友说用一直vim写几千行代码的文件,说什么自己是大牛,不屑使用第三方ide工具,对这种纯粹的装逼犯我就不想说什么了。

 

在python3.6里面可以使用新的语法格式来指明函数的参数和返回类型

例如

def  func(x: int )  -> str:

      psss

 

这样做了不仅有利于阅读传什么返回什么,更是有利于编辑器自动推断类型达到代码补全的目的,这里的指定类型可以是python自带的内置类型 int  dict list什么的,也可以是第三方库的类的类型,也可以是自己定义的类的类型。

 

在py3.6中这么使用如图,但除了函数参数和返回类型外,本地变量可以借助docstring来完成。

技术分享

 

在py2里面不能使用上面的语法,可以使用dcostings来解决。

def func(x,y):
    """
    :type x: list         ##参数类型
    :type y: str
    :rtype :dict           ###返回值类型
    """
    z = funxxxxxxxxxxxxxx()  
    """:type :set"""              ###指定本地变量的类型
 
    z.add()

    x.append()

func([2,3],4).popitem()     ###此处也是自动补全的

 这样做了以后,就更清晰了,那么调用这个func时候,就会知道要传什么类型的参数了,返回什么类型的结果。更为有利的是只需要敲入一个x.a就能自动补全成x.append了。同理y z func的结果都可以补全。

 

包括自定义的类也是可以指定的,下图这个cu参数是一个Chinaunicome的类的实例,如果不指定类型,很多很长的方法要手写。一旦方法拼错了,这个对象压根就没这个方法,点击运行,python也不能很快报错,只能到运行到那一行的时候才报错,这个报错太迟了,老是这样反复通过运行来测试很影响效率和心情。对于静态语言,很多错误是提前还没运行就在编译时候给你报错了,即使拼写错误也无所谓了,马上改就行。动态语言是当运行到那段代码才报错,这样对于拼写错误造成的代码错误实在是太坑了。

 

技术分享

 

 

处理一个requests的response对象。

技术分享

 

pycahrm使用docstrings来指定变量类型、返回值类型、函数参数类型

标签:requests   dcos   弊端   本地   动态   xxx   ima   ict   fun   

原文地址:http://www.cnblogs.com/ydf0509/p/7843721.html

(0)
(0)
   
举报
评论 一句话评论(0
登录后才能评论!
© 2014 mamicode.com 版权所有  联系我们:gaon5@hotmail.com
迷上了代码!