LiteralString仅接受字符串字面量,拒绝变量、拼接或运行时构造的字符串;需mypy≥1.0.0并启用literal错误码,用于保障输入来源可信,不替代Literal[...]的精确枚举约束。
typing.LiteralString 是 Python 3.11+ 引入的类型提示工具,它的核心约束是:**仅允许在调用时传入真正的字符串字面量(如 "hello"、f"world"、r"raw"),拒绝任何运行时构造的字符串**。它不是对值内容的校验,而是对 AST 层面“是否为字面量”的静态检查。
常见错误现象包括:
s = "abc"; func(s) → 类型检查器报错func("a" + "b") 或 func(f"{x}")(即使 x 是字面量)→ 多数检查器(如 mypy)仍拒绝str(...) 转换:func(str(42)) → 不合法默认情况下,mypy 不启用 LiteralString 检查。必须显式启用相关标志,否则所有 LiteralString 注解都会被静默忽略。
实操建议:
mypy.ini 或 pyproject.toml 中添加:[mypy] enable_error_code = "literal" strict = true
mypy --enable-error-code literal your_file.py
mypy >= 1.0.0 支持该特性;Pyright / Pylance 当前(v2025)对 LiteralString 的支持较弱,基本不报错声明函数时,把参数类型设为 LiteralString 即可触发检查。它通常用于需要确保输入“不可被用户动态控制”的场景,比如 SQL 查询模板、格式化字符串键、枚举式字段名等。
示例:
from typing import LiteralStringdef select_by_field(table: str, field: LiteralString) -> list:
field 必须是字面量,防止注入或拼错
return db.query(f"SELECT * FROM {table} WHERE {field} = ?")select_by_field("users", "email") # ✅ 合法 select_by_field("users", field_name) # ❌ field_name 是变量 select_byfield("users", "user" + "id") # ❌ 拼接不被接受(mypy 默认行为)
注意:
LiteralString本身不携带具体值信息,所以不能替代Literal["a", "b"]做精确枚举限制;它只管“是不是字面量”,不管“是哪个字面量”。和 Literal[...] 的关键区别与误用风险
容易混淆的是:
LiteralString≠Literal["foo", "bar"]。前者宽泛(任意字面量都行),后者严格(只接受指定几个)。
典型误用:
"name" 或 "age",却写了 field: LiteralString → 实际放行所有字面量,失去约束力Union[LiteralString, str] → 失效,因为 str 会绕过所有字面量检查isinstance(x, str) 判断 LiteralString → 无意义,它只是类型提示,运行时完全擦除真正需要值级约束时,必须用 Literal[...];需要“来源可信”保障(如防注入、保编译期可见性)时,才用 LiteralString。两者解决的问题不在同一层。