0

0

Python函数注解怎么写_类型提示实战解析【教程】

冰川箭仙

冰川箭仙

发布时间:2025-12-23 22:36:11

|

565人浏览过

|

来源于php中文网

原创

python函数注解是为开发者和工具提供类型信息的语法,不改变运行行为;基础写法为参数后加冒号类型、函数后加箭头返回类型;支持optional、联合类型、泛型容器、自定义别名与typeddict;建议新函数优先添加、api函数必须完整标注,并配合mypy和ide进行静态检查。

python函数注解怎么写_类型提示实战解析【教程】

Python函数注解(即类型提示)不是装饰器,也不是运行时强制检查的语法,而是为开发者和工具(如IDE、mypy、pyright)提供可读、可校验的类型信息。写得清楚,能显著提升代码可维护性、减少参数误用,还能让自动补全更准。

基础语法:用 ->: 标注返回值与参数

在函数定义中,参数名后加冒号 + 类型,函数括号后加箭头 + 返回类型:

def greet(name: str, age: int) -> str:
    return f"Hello {name}, you are {age} years old"
  • name: str 表示 name 参数应为字符串
  • age: int 表示 age 应为整数
  • -> str 表示函数返回值预期是字符串
  • 类型提示不改变运行行为——Python仍会照常执行,哪怕传入 float 或 None

常用内置类型与组合写法

除了 intstrboolfloat 等基础类型,还需掌握这些高频写法:

LibLib AI
LibLib AI

中国领先原创AI模型分享社区,拥有LibLib等于拥有了超多模型的模型库、免费的在线生图工具,不考虑配置的模型训练工具

下载
  • 可选值:用 Optional[str] 或简写 str | None(Python 3.10+)
  • 联合类型:如 int | str 表示“可以是整数或字符串”
  • 列表/字典:用 list[int]dict[str, float](注意大小写,需从 typing 导入或使用内置泛型,Python 3.9+ 支持内置)
  • 可变参数*args: tuple[int, ...] 表示任意多个整数;**kwargs: dict[str, Any] 需导入 Any

自定义类型与别名,让提示更语义化

避免重复写冗长类型,也便于统一修改:

立即学习Python免费学习笔记(深入)”;

from typing import Dict, List, TypedDict

UserId = int
UserName = str
UserRecord = Dict[UserId, UserName]

class User(TypedDict):
    id: int
    name: str
    active: bool

def get_users() -> List[User]:
    ...
  • UserId 是类型别名,提升可读性,也方便后续改成 str(如 UUID)时批量替换
  • TypedDict 适合结构固定、字段明确的字典,支持 IDE 精准提示字段名
  • 避免用 dictlist 这类裸类型——它们不带元素类型信息,工具无法校验

真实项目中的实用建议

  • 从新函数开始加注解,老代码可逐步补,不必一步到位
  • 对 public API 函数(导出给其他模块调用的)务必标注完整,这是接口契约
  • mypy 做静态检查:安装后运行 mypy your_script.py,它会指出类型不匹配处
  • VS Code + Pylance 默认支持类型提示,写错参数类型时会红色波浪线提醒
  • 函数文档字符串(docstring)和类型提示互补:前者说明用途和边界条件,后者约束数据形态

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
css中float用法
css中float用法

css中float属性允许元素脱离文档流并沿其父元素边缘排列,用于创建并排列、对齐文本图像、浮动菜单边栏和重叠元素。想了解更多float的相关内容,可以阅读本专题下面的文章。

593

2024.04.28

C++中int、float和double的区别
C++中int、float和double的区别

本专题整合了c++中int和double的区别,阅读专题下面的文章了解更多详细内容。

105

2025.10.23

js 字符串转数组
js 字符串转数组

js字符串转数组的方法:1、使用“split()”方法;2、使用“Array.from()”方法;3、使用for循环遍历;4、使用“Array.split()”方法。本专题为大家提供js字符串转数组的相关的文章、下载、课程内容,供大家免费下载体验。

678

2023.08.03

js截取字符串的方法
js截取字符串的方法

js截取字符串的方法有substring()方法、substr()方法、slice()方法、split()方法和slice()方法。本专题为大家提供字符串相关的文章、下载、课程内容,供大家免费下载体验。

219

2023.09.04

java基础知识汇总
java基础知识汇总

java基础知识有Java的历史和特点、Java的开发环境、Java的基本数据类型、变量和常量、运算符和表达式、控制语句、数组和字符串等等知识点。想要知道更多关于java基础知识的朋友,请阅读本专题下面的的有关文章,欢迎大家来php中文网学习。

1561

2023.10.24

字符串介绍
字符串介绍

字符串是一种数据类型,它可以是任何文本,包括字母、数字、符号等。字符串可以由不同的字符组成,例如空格、标点符号、数字等。在编程中,字符串通常用引号括起来,如单引号、双引号或反引号。想了解更多字符串的相关内容,可以阅读本专题下面的文章。

645

2023.11.24

java读取文件转成字符串的方法
java读取文件转成字符串的方法

Java8引入了新的文件I/O API,使用java.nio.file.Files类读取文件内容更加方便。对于较旧版本的Java,可以使用java.io.FileReader和java.io.BufferedReader来读取文件。在这些方法中,你需要将文件路径替换为你的实际文件路径,并且可能需要处理可能的IOException异常。想了解更多java的相关内容,可以阅读本专题下面的文章。

1108

2024.03.22

php中定义字符串的方式
php中定义字符串的方式

php中定义字符串的方式:单引号;双引号;heredoc语法等等。想了解更多字符串的相关内容,可以阅读本专题下面的文章。

1082

2024.04.29

Swift iOS架构设计与MVVM模式实战
Swift iOS架构设计与MVVM模式实战

本专题聚焦 Swift 在 iOS 应用架构设计中的实践,系统讲解 MVVM 模式的核心思想、数据绑定机制、模块拆分策略以及组件化开发方法。内容涵盖网络层封装、状态管理、依赖注入与性能优化技巧。通过完整项目案例,帮助开发者构建结构清晰、可维护性强的 iOS 应用架构体系。

0

2026.03.03

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
最新Python教程 从入门到精通
最新Python教程 从入门到精通

共4课时 | 22.5万人学习

Django 教程
Django 教程

共28课时 | 4.7万人学习

SciPy 教程
SciPy 教程

共10课时 | 1.8万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号