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 等基础类型,还需掌握这些高频写法:

易标AI
易标AI

告别低效手工,迎接AI标书新时代!3分钟智能生成,行业唯一具备查重功能,自动避雷废标项

下载
  • 可选值:用 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)和类型提示互补:前者说明用途和边界条件,后者约束数据形态

相关专题

更多
python开发工具
python开发工具

php中文网为大家提供各种python开发工具,好的开发工具,可帮助开发者攻克编程学习中的基础障碍,理解每一行源代码在程序执行时在计算机中的过程。php中文网还为大家带来python相关课程以及相关文章等内容,供大家免费下载使用。

755

2023.06.15

python打包成可执行文件
python打包成可执行文件

本专题为大家带来python打包成可执行文件相关的文章,大家可以免费的下载体验。

636

2023.07.20

python能做什么
python能做什么

python能做的有:可用于开发基于控制台的应用程序、多媒体部分开发、用于开发基于Web的应用程序、使用python处理数据、系统编程等等。本专题为大家提供python相关的各种文章、以及下载和课程。

758

2023.07.25

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

618

2023.07.31

python教程
python教程

Python已成为一门网红语言,即使是在非编程开发者当中,也掀起了一股学习的热潮。本专题为大家带来python教程的相关文章,大家可以免费体验学习。

1262

2023.08.03

python环境变量的配置
python环境变量的配置

Python是一种流行的编程语言,被广泛用于软件开发、数据分析和科学计算等领域。在安装Python之后,我们需要配置环境变量,以便在任何位置都能够访问Python的可执行文件。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

547

2023.08.04

python eval
python eval

eval函数是Python中一个非常强大的函数,它可以将字符串作为Python代码进行执行,实现动态编程的效果。然而,由于其潜在的安全风险和性能问题,需要谨慎使用。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

577

2023.08.04

scratch和python区别
scratch和python区别

scratch和python的区别:1、scratch是一种专为初学者设计的图形化编程语言,python是一种文本编程语言;2、scratch使用的是基于积木的编程语法,python采用更加传统的文本编程语法等等。本专题为大家提供scratch和python相关的文章、下载、课程内容,供大家免费下载体验。

707

2023.08.11

Golang gRPC 服务开发与Protobuf实战
Golang gRPC 服务开发与Protobuf实战

本专题系统讲解 Golang 在 gRPC 服务开发中的完整实践,涵盖 Protobuf 定义与代码生成、gRPC 服务端与客户端实现、流式 RPC(Unary/Server/Client/Bidirectional)、错误处理、拦截器、中间件以及与 HTTP/REST 的对接方案。通过实际案例,帮助学习者掌握 使用 Go 构建高性能、强类型、可扩展的 RPC 服务体系,适用于微服务与内部系统通信场景。

8

2026.01.15

热门下载

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

精品课程

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

共4课时 | 0.9万人学习

Django 教程
Django 教程

共28课时 | 3.1万人学习

SciPy 教程
SciPy 教程

共10课时 | 1.1万人学习

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

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