解读python中的类型提示(type hint)

python类型提示(type hint)

在刷leetcode或者一些官方源码的时候，经常看到如下字样：

class Solution:
    def sortList(self, head: ListNode) -> ListNode:

这就是类型提示(type hint)，下面来个简单的例子，

def greeting(name: str) -> str:
    return 'Hello ' + name

如上，其中name是传入的参数，而:右边的str则是name期望的类型即str，而->则指向期望函数的返回类型。

如果不期望有返回值可以直接指向None，如下：

def feeder(get_next_item: Callable[[], str]) -> None:

Type Hints是鸡肋还是最佳实践？

定义一个这样的函数：

def add(a, b): print(a + b)

看签名应该不难猜出，这是做加法的，把参数a和b加起来。a和b应该是两个数字，或者两个字符串。但不能一个数字一个字符串。

如果我们的目的就是为了加数字，最好能给一些说明。

为了实现这个目的，有两种做法：

一种是加注释：

#把参数a和b相加，a和b必须都是数字。
def add(a, b):
 print(a + b)

更好一点的做法是用docstring来写：

def add(a, b):
  '''把参数a和b相加，a和b必须都是数字。'''
 print(a + b)

Type Hint

还有一种写法就是用Type Hint，直接声明参数的类型：

#为了简单，这里假设只能处理整数
def add(a:int, b:int) -> int:
 print(a + b)

Type Hint是Python3.6开始引入的一种特性。

• 通过变量名：变量类型的写法指定参数的类型
• 通过**->返回值类型**的写法指定返回值的数据类型。

除了可以用在方法中，也可以用在普通的变量上：

a:int #定义变量a，并指定a是int类型
a = 5
print(a)

Type Hint的作用

有了Type Hint，就可以做到类型安全了吗？

并不是的，下面的代码仍然能够成功运行：

a:int 

a = 5
print(a)

a = 'hello' #把字符串赋值给a，并不会有运行时错误
print(a)

结合我前面讲add函数的脉络，Type Hint的作用和注释是一样的，就是另外一种注释手法而已，并不会Python解释器产生任何影响。

如果是这样，要它有何用？它有两个用处：

1.给代码的阅读者更明确的类型提示，调用代码的时候传入错误类型的可能性会降低，但完全靠自觉。

2.有了Type Hints，IDE可以在写代码的过程中就给你一些类型提示，这样可以更顺畅的写出安全的代码。

我应该用吗？

我的建议：

• 大部分情况下没必要使用。知道就好。
• 如果写共用的类库，可以考虑使用。仅仅是考虑，也不一定要用。

我的理由是：

• 人生苦短，我用Python！如果非要夹(Java)里夹气的，你去用Java或者其他的强类型语言好了。
• 毕竟用了Type Hint之后，代码看起来啰嗦多了，而且也失去了Python动态类型的一些优势。
• 还有一个理由，不加Type Hint，也可以使用Mypy实现类似的效果。

我们来看几个常用的类库，看看它们用不用。

• 小海龟turtle - NO：

• Pandas - NO

• Openpyxl - YES

所以啊，有的用了，有的没用。

总结

以上为个人经验，希望能给大家一个参考，也希望大家多多支持。