Python核心库-Literal

5 阅读1分钟

from typing import Literal 是 Python 3.8+ 的标准库导入,它引入了一个“字面量类型”(Literal)的概念,用来把类型检查精确到具体的值,而不仅仅是“str / int / bool”这类宽泛类型。

1.基础语法

from typing import Literal

Mode = Literal["auto", "none", "required"]
# 变量 Mode 只能是字符串 "auto""none""required",传别的值就报错。

2.在函数签名里怎么用

def set_tool_choice(mode: Literal["auto", "none", "required"]) -> None:
    ...
set_tool_choice("auto")      # ✅ 通过
set_tool_choice("required")  # ✅ 通过
set_tool_choice("REQUIRED")  # ❌ 大小写不一致,静态检查器会标红

3.运行时行动

Literal 本身不会在运行时拦截非法值;它的威力体现在写代码阶段就能发现拼写错误、避免“魔法字符串”满天飞。

如果你需要运行期也校验,可以搭配 pydantic 或 enum:

from pydantic import BaseModel, Field
class Request(BaseModel):
    tool_choice: Literal["auto", "none", "required"] = "auto"

4.与 Union 区别

# 旧写法,宽泛
Mode = Union[str, int]        # 任何 str / int 都合法

# 新写法,精确
Mode = Literal["auto", "none", "required"]  # 只有这三个字符串合法

一句话总结
Literal 就是“把允许的写进类型系统”,让 IDE 和静态检查器帮你提前发现手滑拼错、传错参数,写接口、写配置枚举时特别香。