0

0

typing.overload 如何为同一个函数定义多种类型签名

冰川箭仙

冰川箭仙

发布时间:2026-01-19 14:26:02

|

653人浏览过

|

来源于php中文网

原创

typing.overload 是用于为同一函数名声明多个类型签名的装饰器,仅供类型检查器使用,不执行逻辑;真实实现由后续未装饰的同名函数承担,且必须严格遵循先重载声明、后具体实现的结构。

typing.overload 如何为同一个函数定义多种类型签名

typing.overload 是 Python 中用于为**同一个函数名**声明多个**类型签名(type signatures)** 的装饰器,它本身**不实现逻辑**,只供类型检查器(如 mypy、PyCharm、VS Code 的 Pylance)使用。真正的运行时逻辑仍由一个**未装饰的、具体的实现函数**承担。

核心机制:重载声明 + 单一实现

必须严格遵循“先声明、后实现”的结构:

  • @overload 装饰多个函数定义(仅含 ...pass,无实际代码);
  • 这些声明必须连续排列,中间不能插入其他语句;
  • 最后必须有一个**未被 @overload 装饰的同名函数**,它包含真实逻辑;
  • 类型检查器会根据调用时的参数类型,从重载声明中选择最匹配的一个进行校验。

基本写法示例

比如实现一个支持 strbytes 输入、返回对应类型的大写函数:

scala中文手册 scala入门与进阶
scala中文手册 scala入门与进阶

Scala也是一种函数式语言,其函数也能当成值来使用。Scala提供了轻量级的语法用以定义匿名函数,支持高阶函数,允许嵌套多层函数,并支持柯里化 。Scala的Case Class及其内置的模式匹配相当于函数式编程语言中常用的代数类型(Algebraic Type)。 Scala课堂是Twitter启动的一系列讲座,用来帮助有经验的工程师成为高效的Scala 程序员。Scala是一种相对较新的语言,但借鉴了许多熟悉的概念。因此,课程中的讲座假设听众知道这些概念,并展示了如何在Scala中使用它们。我们发现

下载
from typing import overload

@overload def uppercase(s: str) -> str: ...

@overload def uppercase(s: bytes) -> bytes: ...

def uppercase(s: str | bytes) -> str | bytes: if isinstance(s, str): return s.upper() else: return s.upper()

调用时:

  • uppercase("hello") → 类型检查器推断返回 str
  • uppercase(b"hello") → 推断返回 bytes
  • 传入 int 会报错,因为没有匹配的重载签名。

常见使用场景

  • 可选参数组合不同导致返回类型不同:例如 json.loads(s, *, parse_float=None),当 parse_floatCallable[[str], float] 时,可能影响返回中数字的类型表现(虽实际中较少严格建模,但原理类似);
  • 泛型参数影响返回类型:配合 TypeVar,让输入容器类型决定输出类型(如 def first[T](lst: list[T]) -> T);
  • 区分就地修改与返回副本:例如 pandas.DataFrame.copy()deep=True 时返回新对象,deep=False 可能返回视图(类型上可建模为不同返回类型)。

注意事项

  • 重载声明本身在运行时不生效,help(uppercase)uppercase.__doc__ 只显示最终实现函数的文档;
  • 所有重载签名必须能被最终实现函数的类型所“覆盖”(即实现函数的参数和返回类型需是所有重载签名的并集或超集);
  • 不要在重载声明里写 docstring 或逻辑,否则类型检查器可能报错或忽略;
  • Python 3.12+ 支持更简洁的 case 语法(PEP 692),但 @overload 仍是主流兼容方式。

相关专题

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

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

760

2023.06.15

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

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

639

2023.07.20

python能做什么
python能做什么

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

762

2023.07.25

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

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

619

2023.07.31

python教程
python教程

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

1285

2023.08.03

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

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

549

2023.08.04

python eval
python eval

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

579

2023.08.04

scratch和python区别
scratch和python区别

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

709

2023.08.11

PHP WebSocket 实时通信开发
PHP WebSocket 实时通信开发

本专题系统讲解 PHP 在实时通信与长连接场景中的应用实践,涵盖 WebSocket 协议原理、服务端连接管理、消息推送机制、心跳检测、断线重连以及与前端的实时交互实现。通过聊天系统、实时通知等案例,帮助开发者掌握 使用 PHP 构建实时通信与推送服务的完整开发流程,适用于即时消息与高互动性应用场景。

3

2026.01.19

热门下载

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

精品课程

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

共4课时 | 4.8万人学习

Django 教程
Django 教程

共28课时 | 3.2万人学习

SciPy 教程
SciPy 教程

共10课时 | 1.2万人学习

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

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