如何为真正可选的参数正确使用类型提示与重载

风涛姑娘_5825

风涛姑娘_5825

2026-05-18

977人浏览

原创

如何为真正可选的参数正确使用类型提示与重载

在 Python 类型提示中,Optional[T] 表示“可能是 None”,而非“可省略”;要表达参数可省略但不可为 None,必须通过额外的 @overload 声明来显式支持无该参数的调用形式。

在 python 类型提示中,`optional[t]` 表示“可能是 `none`”,而非“可省略”;要表达参数**可省略但不可为 `none`**,必须通过额外的 `@overload` 声明来显式支持无该参数的调用形式。

当使用 @overload 实现多态类型签名时,类型检查器(如 mypy)仅依据调用时传入的实参个数和类型匹配最精确的 overload,而不考虑运行时默认参数的存在。因此,即使你在实现函数中为 expected_output_type 设置了默认值 HDF5DataTypes.UNKNOWN,若没有对应「两参数」的 overload,mypy 仍会报错:No overloads match the provided arguments。

✅ 正确做法是:显式添加一个不带 expected_output_type 参数的 overload,其返回类型应与 UNKNOWN 分支一致(即联合类型 Union[npt.NDArray, np.float_]),并确保其实现逻辑兼容该签名:

from typing import Union, List, overload, cast
import numpy as np
import numpy.typing as npt
import h5py
from enum import Enum

class HDF5DataTypes(Enum):
    SCALAR = "scalar"
    ARRAY = "array"
    UNKNOWN = "unknown"

# ✅ 新增:两参数 overload(参数真正可省略)
@overload
def index_hdf5_to_value(
    file_or_group: Union[h5py.File, h5py.Group],
    indexes: List[str]
) -> Union[npt.NDArray, np.float_]:
    ...

# ✅ 保持原有三参数 overload(含默认值的 Literal 重载更精准)
@overload
def index_hdf5_to_value(
    file_or_group: Union[h5py.File, h5py.Group],
    indexes: List[str],
    expected_output_type: Literal[HDF5DataTypes.SCALAR]
) -> np.float_:
    ...

@overload
def index_hdf5_to_value(
    file_or_group: Union[h5py.File, h5py.Group],
    indexes: List[str],
    expected_output_type: Literal[HDF5DataTypes.ARRAY]
) -> npt.NDArray:
    ...

@overload
def index_hdf5_to_value(
    file_or_group: Union[h5py.File, h5py.Group],
    indexes: List[str],
    expected_output_type: Literal[HDF5DataTypes.UNKNOWN] = HDF5DataTypes.UNKNOWN
) -> Union[npt.NDArray, np.float_]:
    ...

# 实现体(无类型注解,仅含逻辑)
def index_hdf5_to_value(
    file_or_group: Union[h5py.File, h5py.Group],
    indexes: List[str],
    expected_output_type: HDF5DataTypes = HDF5DataTypes.UNKNOWN
) -> Union[npt.NDArray, np.float_]:
    dataset = index_hdf5(file_or_group, indexes, h5py.Dataset)
    if len(dataset.shape) == 0:
        if expected_output_type == HDF5DataTypes.ARRAY:
            raise ValueError("Expected output to be an array, but it was a scalar")
        return cast(np.float_, dataset[()])
    else:
        if expected_output_type == HDF5DataTypes.SCALAR:
            raise ValueError("Expected output to be a scalar, but it was an array")
        return cast(npt.NDArray, dataset[:])

? 关键注意事项:

  • 所有 @overload 声明必须严格位于实现函数之前,且实现函数本身不能有类型注解(否则 mypy 会报错);
  • 新增的两参数 overload 必须放在最上方(或至少在更具体的 overload 之前),以保证类型检查器优先匹配最宽泛但合法的调用形式;
  • expected_output_type 的默认值 = HDF5DataTypes.UNKNOWN 应保留在实现函数和对应的 overload 中,确保运行时行为一致;
  • ❌ 不要使用 expected_output_type: Optional[HDF5DataTypes] —— 这会错误地允许 None,违背设计意图,且无法解决“参数省略”问题。

这样,用户即可安全调用 index_hdf5_to_value(hdf5_file, ["key1", "key2"]),享受完整的静态类型检查,同时保持接口语义清晰:该参数是可选的(omittable),而非可为空的(nullable)。

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

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

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

2023.07.20

1771

4

python能做什么
python能做什么

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

2023.07.25

4564

7

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

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

2023.07.31

1729

3

python教程
python教程

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

2023.08.03

26957

23

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

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

2023.08.04

3267

5

python eval
python eval

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

2023.08.04

3267

5

scratch和python区别
scratch和python区别

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

2023.08.11

1203

5

python合并两个列表
python合并两个列表

Python是一种强大的编程语言,具有许多方便的功能和工具。在Python中,有多种方法可以合并两个列表。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.10

596

4

python是前端还是后端
python是前端还是后端

Python属于前端也属于后端,其灵活性和丰富的生态系统使得开发人员能够在不同的领域中灵活运用。本专题为大家提供python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

2543

5

热门下载

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

精品课程

更多
热门推荐
/
最新课程
phpStudy极速入门视频教程
phpStudy极速入门视频教程

共6课时 | 54.7万人学习

独孤九贱(4)_PHP视频教程
独孤九贱(4)_PHP视频教程

共89课时 | 133.8万人学习