写出更现代化的Python代码:聊聊 Type Hint

本文介绍了Python的Type Hint特性,旨在提升代码可读性和利用编辑器的自动提示功能。通过实例展示了如何标注函数参数及返回类型,讨论了mypy工具在静态类型检查中的作用,以及更复杂的类型标注技巧,帮助开发者写出更易维护的代码。

Type Hint是 Python 3.5 新增的支持,中文可以译为 类型提示。屏幕前的你或许听过,又或许没有。所以今天,让我们一起了解了解。
本文基于 Python 3.10.4,部分代码需要在 Python 3.10.0 及以上运行,原因在后续文章中会有说明
本文的代码编辑器为 VS Code ,您可以选择其他现代编辑器/IDE以体验

为什么需要 Type Hint

简而言之,按我的理解,type hint的目的是写给“别人”看。这个“别人”,就包括代码编辑器其他阅读代码的人几天后的你自己
废话不多说,Show You My Code!

开始写代码

现在我们假设,你想写一个函数,用处是统计给定字符串中某个字符出现的次数,于是你大手一挥,写下了这样的代码:

def count_char(text, char):
    return text.啥来着???

尴尬的是,你记得str类有这个方法,但却忘记了这个方法叫啥了,看看编辑器的自动提示?

image.png 遗憾的是,编辑器不知道你的text是啥类型的,自然没法帮你补全。那我们能不能告诉它:这是个str呢?可以,给参数名后面加个: str就好了 (这个空格不是必须的,只是为了好看)

image.png 这就是Type Hint的作用,通过显示指明类型告诉调用者和编辑器:我需要什么类型。这能帮助你充分利用现代编辑器的自动提示功能,并让你写出的代码更加易于阅读和维护。

一个注意点

在继续下面内容之前,我们得明确一件事:Type Hint只是手动指明我们需要的类型,但它不是强制的。举个栗子,对于这个函数,正确的使用如下:

def count_char(text: str, char):
    return text.count(char)

# text 参数为 str
print(count_char("Hello World", "e"))

但如果我们给text传了个别的类型,比如int,会发生什么?答案是仍然能编译通过,只是执行时报错而已。

编辑器并不报错 这就是为什么它叫Type Hint:只是提示,并非强制。
当然,我们也可以借助其他手段来实现强制的类型限定,比如借助 mypy

mypy

安装mypy很容易,只需要pip install mypy即可。之后就可以用mypy filename.py检测此类错误

image.png 当然,能在vscode中直接用更好。我们可以按ctrl+shift+p打开设置(工作区or全局,看你想法) image.png

配置如下:

{
    "python.linting.mypyEnabled": true
}

即可在vscode中实时用mypy检查

image.png

评论 1
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值