0

0

typing.LiteralString 如何限制字符串参数为字面量

冷炫風刃

冷炫風刃

发布时间:2026-01-26 18:27:10

|

183人浏览过

|

来源于php中文网

原创

LiteralString仅接受字符串字面量,拒绝变量、拼接或运行时构造的字符串;需mypy≥1.0.0并启用literal错误码,用于保障输入来源可信,不替代Literal[...]的精确枚举约束。

typing.literalstring 如何限制字符串参数为字面量

LiteralString 只接受字符串字面量,不接受变量或拼接结果

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 的支持需开启 strict 模式

默认情况下,mypy 不启用 LiteralString 检查。必须显式启用相关标志,否则所有 LiteralString 注解都会被静默忽略。

实操建议:

  • mypy.inipyproject.toml 中添加:
    [mypy]
    enable_error_code = "literal"
    strict = true
  • 或命令行运行:mypy --enable-error-code literal your_file.py
  • 注意:仅 mypy >= 1.0.0 支持该特性;Pyright / Pylance 当前(v2024)对 LiteralString 的支持较弱,基本不报错

函数签名中正确使用 LiteralString 参数

声明函数时,把参数类型设为 LiteralString 即可触发检查。它通常用于需要确保输入“不可被用户动态控制”的场景,比如 SQL 查询模板、格式化字符串键、枚举式字段名等。

示例:

绘蛙AI商品图
绘蛙AI商品图

电商场景的AI创作平台,无需高薪聘请商拍和文案团队,使用绘蛙即可低成本、批量创作优质的商拍图、种草文案

下载
from typing import LiteralString

def 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[...] 的关键区别与误用风险

容易混淆的是:LiteralStringLiteral["foo", "bar"]。前者宽泛(任意字面量都行),后者严格(只接受指定几个)。

典型误用:

  • 想限制只能传 "name""age",却写了 field: LiteralString → 实际放行所有字面量,失去约束力
  • 想防止拼接但又接受变量,试图用 Union[LiteralString, str] → 失效,因为 str 会绕过所有字面量检查
  • 在运行时试图用 isinstance(x, str) 判断 LiteralString → 无意义,它只是类型提示,运行时完全擦除

真正需要值级约束时,必须用 Literal[...];需要“来源可信”保障(如防注入、保编译期可见性)时,才用 LiteralString。两者解决的问题不在同一层。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
python开发工具
python开发工具

php中文网为大家提供各种python开发工具,好的开发工具,可帮助开发者攻克编程学习中的基础障碍,理解每一行源代码在程序执行时在计算机中的过程。php中文网还为大家带来python相关课程以及相关文章等内容,供大家免费下载使用。

778

2023.06.15

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

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

685

2023.07.20

python能做什么
python能做什么

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

769

2023.07.25

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

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

740

2023.07.31

python教程
python教程

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

1445

2023.08.03

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

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

571

2023.08.04

python eval
python eval

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

580

2023.08.04

scratch和python区别
scratch和python区别

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

752

2023.08.11

拼多多赚钱的5种方法 拼多多赚钱的5种方法
拼多多赚钱的5种方法 拼多多赚钱的5种方法

在拼多多上赚钱主要可以通过无货源模式一件代发、精细化运营特色店铺、参与官方高流量活动、利用拼团机制社交裂变,以及成为多多进宝推广员这5种方法实现。核心策略在于通过低成本、高效率的供应链管理与营销,利用平台社交电商红利实现盈利。

31

2026.01.26

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
最新Python教程 从入门到精通
最新Python教程 从入门到精通

共4课时 | 22万人学习

Django 教程
Django 教程

共28课时 | 3.5万人学习

SciPy 教程
SciPy 教程

共10课时 | 1.3万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号