如何为返回多值的函数正确添加类型提示

老宇吖_3483

老宇吖_3483

2026-03-25

470人浏览

原创

如何为返回多值的函数正确添加类型提示

本文详解在 Python 中为数据库查询等场景下返回多种潜在类型的函数设置准确类型提示的方法,重点解决 mypy 报错、Union 类型推断不准、以及 Optional[str] 误用等问题,并提供安全的类型转换与类型声明实践。

本文详解在 python 中为数据库查询等场景下返回多种潜在类型的函数设置准确类型提示的方法,重点解决 `mypy` 报错、`union` 类型推断不准、以及 `optional[str]` 误用等问题,并提供安全的类型转换与类型声明实践。

在实际开发中,尤其是与数据库交互的函数(如执行 MySQL 查询并提取结果),其返回值常被 cursor.fetchall() 返回为包含混合类型的元组列表(例如 List[Tuple[Union[str, int, Decimal, None], ...]])。此时若仅按业务逻辑“主观认定”某个字段恒为 str,直接标注 -> List[str] 或 -> List[Optional[str]] 会导致 mypy 类型检查失败——正如问题中所示:

List comprehension has incompatible type List[Union[float, int, Decimal, str, bytes, date, timedelta, Set[str], None, Any]]; expected List[str]

这是因为 cursor.fetchall() 的返回类型在 mysql-connector-python 或 PyMySQL 等驱动中通常被定义为泛型 List[Tuple[Any, ...]],静态类型检查器无法推断出 value 的具体子类型。

✅ 正确做法:显式类型转换 + 精准类型注解

你不应依赖“我确定它是 str”这种运行时假设,而应通过 typing.cast 或显式转换向类型检查器传达意图,并确保代码具备健壮性:

from typing import List, cast
from decimal import Decimal
from datetime import date, timedelta

def my_function(
    self,
    param1: List[str],
    param2: date,
    param3: int,
    param4: List[str],
    param5: List[int],
    param6: List[str],
    param7: int,
) -> List[str]:  # ✅ 若业务保证非空字符串,用 List[str];若可能为 NULL,则用 List[Optional[str]]
    cnx = self.mysql
    cursor = cnx.cursor()

    query = files(sql).joinpath("ready_batches.sql").read_text()

    param1_str = ",".join([f"'{lob}'" for lob in param1])
    param4_str = ",".join([f"'{clm_type}'" for clm_type in param4])
    param5_str = ",".join([f"{client_id}" for client_id in param5])
    param6_str = ",".join([f"{module_id}" for module_id in param6])

    with cnx, cursor:
        cursor.execute(
            query,
            {
                "lob": param1_str,
                "clm_type": param4_str,
                "client_id": param5_str,
                "param7": param7,
                "module_id": param6_str,
                "param3": param3,
                "param2": param2,
            },
        )

        result = cursor.fetchall()
        # ✅ 方案一:使用 cast(推荐用于已充分验证的场景)
        # mypy 将信任该声明,不进行运行时开销
        return [cast(str, value) for value, _ in result]

        # ✅ 方案二:更安全的显式转换(带校验,适合不确定环境)
        # return [str(value) if value is not None else "" for value, _ in result]

⚠️ 关键注意事项

  • Optional[str] ≠ str | None 的语义滥用:Optional[str] 表示“单个值可能是 str 或 None”,适用于返回单个可空字符串的函数(如 -> Optional[str])。而本例返回的是字符串列表,若数据库字段允许 NULL,应标注为 List[Optional[str]];若业务层已过滤或数据库约束非空,则 List[str] 更准确且语义清晰。

  • 避免 # type: ignore:临时压制错误会掩盖真实类型风险,应优先通过 cast 或重构逻辑解决。

  • SQL 注入风险提醒:当前代码中通过字符串拼接构造 param1_str 等变量,存在严重 SQL 注入漏洞。务必改用参数化查询(即把所有动态值作为 execute() 的第二个参数传入,而非嵌入 SQL 字符串)。类型提示不能弥补安全缺陷。

  • 驱动类型支持:部分现代 MySQL 驱动(如 mysqlclient 配合 mypy-mysql 插件,或 aiomysql + types-aiomysql)可提供更精确的 fetchall() 类型定义。建议在项目中引入对应 stub 包以提升类型精度。

✅ 总结

为返回多类型数据的函数添加类型提示,核心原则是:类型声明需与实际行为一致,类型转换需明确且可验证。优先使用 cast() 向类型检查器声明意图;对可能为空的字段,合理选用 Optional[str] 并作用于元素层级(如 List[Optional[str]]);永远将类型安全与运行时安全(如 SQL 参数化)同步保障。如此,才能真正发挥类型提示在大型项目中的可维护性与可靠性价值。

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

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

下载

相关标签:

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

相关专题

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

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

2023.07.20

1811

4

python能做什么
python能做什么

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

2023.07.25

4864

7

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

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

2023.07.31

1769

3

python教程
python教程

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

2023.08.03

28997

23

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

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

2023.08.04

3467

5

python eval
python eval

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

2023.08.04

3487

5

scratch和python区别
scratch和python区别

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

2023.08.11

1223

5

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

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

2023.08.10

616

4

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

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

2023.08.11

2703

5

热门下载

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

精品课程

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

共6课时 | 54.7万人学习

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

共89课时 | 134.1万人学习