【Python】类型注解 ① ( Python 中的代码提示问题 | 函数名提示功能 | 函数参数类型提示功能 | 类型注解概念简介 | 类型注解语法 )

一、Python 中的代码提示问题

---

1、PyCharm 函数名提示功能

创建一个 data 变量 , 为其赋值 list 列表容器类型对象 ,

在调用 data 的 clear 函数时 , 输入 cl 类型 , 会自动提示 clear 方法名称 , 代码可以自动补全 ;

如果在 函数中 , 接收一个 list 类型的 变量 , 我们心里想的这个变量是 list 容器类型 , 但是并没有标注该变量的类型 , 此时想要调用其 clear 函数 , 没有任何提示 ;

当然调用也不会报错 ;

2、PyCharm 函数参数类型提示功能

在 Python 中 , 使用官方提供的函数库 , 如随机数函数 ,

"""
类型注解 代码示例
"""

import random


random.randint()

鼠标移动到 random.randint() 函数内 , 按下 Ctrl + P 快捷键 , 可以看到参数类型提示 ;

自己定义一个 add 函数 , 将鼠标移动到 函数 括号中, 使用 Ctrl + P 快捷键 , 并不能给出参数类型提示 ;

这是因为 PyCharm 无法通过代码确定 add 函数中应该传入什么类型的参数 ;

二、类型注解

---

1、类型注解概念简介

Python 中的 " 类型注解 " 是就是 在代码中 显式地指定 变量 / 函数参数 / 返回值 的类型 ;

" 类型注解 " 可以 让团队中的其它 程序员 更好的 阅读 / 理解 / 维护 这段代码 , 对于 PyCharm 集成开发环境来说 , 可以根据 类型注解 提供 更好的 代码提示 / 代码自动补全 功能 ;

Python 3.5 以上 , 支持 " 类型注解 " 语法 , 指定 变量 和 方法参数返回值 的类型 ;

Python 类型注解 语法 与 Kotlin 语法中的类型声明类似 ;

类型注解 可以方便 静态类型检查工具 , PyCharm IDE 开发工具 的 类型检查 与 代码自动提示功能 ;

2、类型注解语法

Python 类型注解 语法 : 在 变量 / 参数 后面 , 先添加冒号 , 在 冒号 后面加上 变量 / 参数 类型 , 多个 变量 / 参数 之间使用 逗号 隔开 ;

变量名/参数名 : 类型名称

类型注解 不是 强制性的 , 只是用于提高代码可读性 , 可维护性 ;

开发时 可 使用 静态类型检查工具 检查 类型注解 是否正确 ;

代码示例 - Python 类型注解 : 在下面的代码中 ,

• 变量 a 被 指定为 int 类型 , 其初始值设置为 10 ;
• x 和 y 的形参类型被指定为 int 类型 , 返回值类型也被指定为 int 类型 ;

a: int = 10

def add_numbers(x: int, y: int) -> int:  
    return x + y