讲师中心 微信公众号
AI工具推荐 视频效率加速

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

轻芳吖_2844

轻芳吖_2844

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

|

223人浏览过

|

来源于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.ini 或 pyproject.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 查询模板、格式化字符串键、枚举式字段名等。

示例:

python学习
python学习

Python 编程学习助手 skill,面向零基础用户。 当用户表达以下意图时触发: - 学习 Python 基础概念(变量、数据类型、循环、函数、类等) - 请求 Python 练习题或测验 - 请求审查或调试 Python 代码 - 请求 Python 项目实战指导(爬虫、数据分析、Web 开发等入门项目) - 泛化表述如"教我 Python""我想学编程""Python 怎么写""帮我学 Python" 此 skill

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

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

典型误用:

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

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

热门AI工具

更多
音述AI
音述AI Hot

一款AI音频处理工具,主要用于音述AI是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区,适合需要提升相关任务效率的用户。

Atoms
Atoms Hot

Atoms是一款AI智能体工具,第一支自动构建真实业务的 AI 团队。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

咔片AIPPT

一款在线AI演示文稿制作工具,可根据主题和内容需求辅助生成PPT结构与页面,提高演示材料制作效率。

火山引擎

火山引擎是一款面向企业的云计算与AI服务平台。

UpDream
UpDream Hot

一款AI视频创作工具,主要用于哔哩哔哩推出的自研AI视频创作工具,适合需要提升相关任务效率的用户。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

VibeKnow
VibeKnow Hot

一款AI视频创作工具,主要用于全球首个AI知识视频创作平台,文档、文章、网页,一键生成视频,适合需要提升相关任务效率的用户。

相关专题

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

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

4563

2023.10.12

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

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

951

2023.10.27

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

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

1189

2024.02.23

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

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

6541

2024.03.06

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

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

3303

2024.03.06

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

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

6500

2024.04.07

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

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

8921

2024.04.29

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

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

1210

2024.04.29

Gradle插件开发入门教程
Gradle插件开发入门教程

本专题介绍Gradle插件开发的基本流程,涵盖插件类编写、自定义任务注册、扩展参数设计和插件应用方法,帮助你理解插件如何组织构建逻辑,减少多个项目之间的重复配置。

100

2026.10.22

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Uvicorn官方安装与入门手册
Uvicorn官方安装与入门手册

共0课时 | 0人学习

Python uv官方项目管理指南
Python uv官方项目管理指南

共0课时 | 0人学习

Python uv官方安装与入门文档
Python uv官方安装与入门文档

共0课时 | 0人学习

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn