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 驱动的智能语音笔记,随时随地用语音记录你的每一个想法。

下载
from typing import LiteralString
<p>def select_by_field(table: str, field: LiteralString) -> list:</p><h1>field 必须是字面量,防止注入或拼错</h1><pre class='brush:python;toolbar:false;'>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

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

豆包大模型
豆包大模型

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

WorkBuddy
WorkBuddy

腾讯云推出的AI原生桌面智能体工作台

腾讯元宝
腾讯元宝

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

文心一言
文心一言

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

讯飞写作
讯飞写作

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

即梦AI
即梦AI

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

ChatGPT
ChatGPT

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

相关专题

更多
数据分析工具有哪些
数据分析工具有哪些

数据分析工具有Excel、SQL、Python、R、Tableau、Power BI、SAS、SPSS和MATLAB等。详细介绍:1、Excel,具有强大的计算和数据处理功能;2、SQL,可以进行数据查询、过滤、排序、聚合等操作;3、Python,拥有丰富的数据分析库;4、R,拥有丰富的统计分析库和图形库;5、Tableau,提供了直观易用的用户界面等等。

1135

2023.10.12

SQL中distinct的用法
SQL中distinct的用法

SQL中distinct的语法是“SELECT DISTINCT column1, column2,...,FROM table_name;”。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

340

2023.10.27

SQL中months_between使用方法
SQL中months_between使用方法

在SQL中,MONTHS_BETWEEN 是一个常见的函数,用于计算两个日期之间的月份差。想了解更多SQL的相关内容,可以阅读本专题下面的文章。

381

2024.02.23

SQL出现5120错误解决方法
SQL出现5120错误解决方法

SQL Server错误5120是由于没有足够的权限来访问或操作指定的数据库或文件引起的。想了解更多sql错误的相关内容,可以阅读本专题下面的文章。

2194

2024.03.06

sql procedure语法错误解决方法
sql procedure语法错误解决方法

sql procedure语法错误解决办法:1、仔细检查错误消息;2、检查语法规则;3、检查括号和引号;4、检查变量和参数;5、检查关键字和函数;6、逐步调试;7、参考文档和示例。想了解更多语法错误的相关内容,可以阅读本专题下面的文章。

380

2024.03.06

oracle数据库运行sql方法
oracle数据库运行sql方法

运行sql步骤包括:打开sql plus工具并连接到数据库。在提示符下输入sql语句。按enter键运行该语句。查看结果,错误消息或退出sql plus。想了解更多oracle数据库的相关内容,可以阅读本专题下面的文章。

1703

2024.04.07

sql中where的含义
sql中where的含义

sql中where子句用于从表中过滤数据,它基于指定条件选择特定的行。想了解更多where的相关内容,可以阅读本专题下面的文章。

586

2024.04.29

sql中删除表的语句是什么
sql中删除表的语句是什么

sql中用于删除表的语句是drop table。语法为drop table table_name;该语句将永久删除指定表的表和数据。想了解更多sql的相关内容,可以阅读本专题下面的文章。

440

2024.04.29

TypeScript类型系统进阶与大型前端项目实践
TypeScript类型系统进阶与大型前端项目实践

本专题围绕 TypeScript 在大型前端项目中的应用展开,深入讲解类型系统设计与工程化开发方法。内容包括泛型与高级类型、类型推断机制、声明文件编写、模块化结构设计以及代码规范管理。通过真实项目案例分析,帮助开发者构建类型安全、结构清晰、易维护的前端工程体系,提高团队协作效率与代码质量。

26

2026.03.13

热门下载

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

精品课程

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

共4课时 | 22.5万人学习

Django 教程
Django 教程

共28课时 | 5万人学习

SciPy 教程
SciPy 教程

共10课时 | 1.9万人学习

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

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