在Python中如何使用typing.Literal限制函数参数仅接受固定常量?

云敏君_3038

云敏君_3038

2026-09-04

962人浏览

原创

literal是python 3.8+引入的类型提示工具,用于限定变量或参数只能取指定字面量值(如字符串、数字、布尔值),仅在静态类型检查(如mypy)时生效,不提供运行时校验。

在python中如何使用typing.literal限制函数参数仅接受固定常量?

Literal 是什么,什么时候该用它

typing.Literal 不是运行时校验工具,它只在类型检查阶段起作用(比如用 mypy 或 IDE 的静态分析)。如果你希望函数调用时“报错阻止传入非法值”,Literal 本身做不到——它不会抛异常,也不会拦截参数。它的价值在于:提前暴露错误、增强 IDE 补全、明确接口契约。

怎么写一个带 Literal 参数的函数

直接在参数注解里用 Literal[...] 列出允许的字面量值即可。支持字符串、数字、布尔、None,但不能是变量或表达式。

示例:

from typing import Literal
<p>def set_mode(mode: Literal["fast", "safe", "debug"]) -> None:
print(f"Mode set to {mode}")</p><p>set_mode("fast")   # ✅ 类型检查通过
set_mode("slow")   # ❌ mypy 报错:Argument 1 has incompatible type "str"
set_mode(42)       # ❌ 同样报错:Expected "fast" | "safe" | "debug"
</p>

注意:Literal 中的每个值必须是 Python 字面量,不能写成 Literal[MODE_FAST](除非 MODE_FAST 是 Final[str] 且被 mypy 识别为常量)。

Python Testing
Python Testing

Python 测试速查:运行 pytest、使用 mock/patch、参数化、fixtures、异步、覆盖率测试。

下载

常见坑:字符串 vs 变量、Union 写法、与 str 混用

容易误以为加了 Literal 就能防止运行时乱传——其实只要绕过类型检查(比如不跑 mypy、用 exec、动态构造字符串),照样能调用成功。

  • ❌ 错误写法:mode: Literal[MY_CONST],其中 MY_CONST = "prod" —— mypy 默认不推导这种变量为字面量,需加 Final
  • ✅ 正确写法:from typing import Final; MY_CONST: Final = "prod",再写 Literal[MY_CONST]
  • ❌ 混用 str 和 Literal:如 mode: str | Literal["auto"],这等价于 str,失去限制意义
  • ✅ 真正需要扩展时,用 Union[Literal["a", "b"], Literal["c"]] 或简写为 Literal["a", "b", "c"]

和 enum 对比:选哪个更合适

如果常量有语义分组、可能附带方法或需要迭代,优先用 Enum;如果只是简单标记、追求轻量、且 IDE 补全体验更重要,Literal 更直接。

关键区别:

  • Enum 是运行时对象,可 is 判断、可遍历、可带属性;Literal 在运行时完全消失,只剩普通值
  • Literal["red", "blue"] 的参数接收的是普通字符串,而 Color.RED 是枚举成员,类型更重
  • mypy 对 Enum 成员的检查更严格,但补全不如 Literal 直观(尤其 VS Code 对 Literal 字符串补全很友好)

别指望 Literal 替代枚举逻辑,也别用它做运行时校验——那是 if mode not in ("a", "b") 或 Pydantic 的事。

Python免费学习笔记(深入):立即使用
在学习笔记中,你将探索 Python 的核心概念和高级技巧!

相关文章

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

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

下载

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

相关专题

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

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

2023.07.20

1571

4

python能做什么
python能做什么

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

2023.07.25

3764

7

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

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

2023.07.31

1589

3

python教程
python教程

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

2023.08.03

21617

23

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

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

2023.08.04

2667

5

python eval
python eval

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

2023.08.04

2727

5

scratch和python区别
scratch和python区别

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

2023.08.11

1103

5

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

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

2023.08.10

576

4

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

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

2023.08.11

2103

5

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程