0

0

如何为函数返回值精确标注单例实例类型(而非其所属类型)

心靈之曲

心靈之曲

发布时间:2026-01-19 14:39:18

|

682人浏览过

|

来源于php中文网

原创

如何为函数返回值精确标注单例实例类型(而非其所属类型)

python 类型检查器(如 mypy)默认不支持直接用运行时实例作为类型注解,但可通过 `literal` 结合 `enum` 成员实现对单例对象的精确类型标注,并在 `is` 判断后自动完成类型窄化。

在 Python 类型提示中,函数返回类型必须是类型表达式(如 int、str、Literal["x"]),而不能是运行时变量(如 my_marker)。你希望当函数返回一个特定单例对象(例如某个唯一字符串或类实例)时,类型检查器能识别该具体值,并在后续 if a_var is not my_marker: 语句中,将 a_var 的类型从联合类型(如 int | MyMarker.MARKER)精确窄化为 int——这正是类型系统中“值级类型窄化”(value-based narrowing)的关键需求。

直接使用 Literal[my_marker] 会失败,因为 my_marker 是变量而非编译期常量;而 type[my_marker] 或 Type[MyClass] 表示的是“类型本身”,不是该类型的某个具体实例,无法触发基于 is 的窄化逻辑。

✅ 正确解法:将单例对象定义为 Enum 成员,并用 Literal[EnumMember] 注解:

Glimmer Ai
Glimmer Ai

基于GPT-3和DALL·E2的PPT制作工具

下载
from typing import Literal, Union
from enum import Enum
from random import random

class MyMarker(Enum):
    # 使用枚举成员承载单例语义,其值在类型检查期可被静态解析
    SINGLETON = "This is very singletony, I promise!"

def get_object_or_a_singleton_marker() -> Union[int, Literal[MyMarker.SINGLETON]]:
    if random() < 0.5:
        return 42
    else:
        return MyMarker.SINGLETON

a_var = get_object_or_a_singleton_marker()

if a_var is not MyMarker.SINGLETON:
    # ✅ 此处 mypy 能正确推断 a_var: int
    reveal_type(a_var)  # → Revealed type is "builtins.int"
    result = a_var + 10  # 类型安全:int 支持加法
? 为什么 Enum 成员可行?Enum 成员(如 MyMarker.SINGLETON)在类型检查期被视为字面量常量(literal constant),Literal[MyMarker.SINGLETON] 等价于 Literal["This is very singletony, I promise!"],且保留了唯一性语义。mypy 和 Pyright 均支持对 Enum 成员的 is/is not 判断进行类型窄化。

⚠️ 注意事项:

  • 不要使用 @unique 强制枚举唯一性——此处我们依赖的是单个成员的值唯一性,而非枚举项名唯一;
  • 若单例是自定义类实例(如 class Sentinel: pass; SENTINEL = Sentinel()),推荐改用 enum.Enum 或 enum.Flag 封装,避免 object() 等无意义实例带来的类型歧义;
  • Literal[...] 中仅支持编译期可确定的字面量(str, int, bool, None, Enum 成员),不支持普通变量或动态构造值;
  • 该方案完全兼容 if ... is not ... 语法,无需额外 TypeGuard 函数或运行时装饰器,零运行时开销。

总结:通过 Enum + Literal[EnumMember] 的组合,你既能保持简洁直观的 is 判断风格,又能获得精准的静态类型窄化能力——这是目前在标准类型系统中实现“实例级类型标注”的最实用、最广泛支持的模式。

热门AI工具

更多
DeepSeek
DeepSeek

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

豆包大模型
豆包大模型

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

WorkBuddy
WorkBuddy

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

腾讯元宝
腾讯元宝

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

文心一言
文心一言

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

讯飞写作
讯飞写作

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

即梦AI
即梦AI

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

ChatGPT
ChatGPT

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

相关专题

更多
java基础知识汇总
java基础知识汇总

java基础知识有Java的历史和特点、Java的开发环境、Java的基本数据类型、变量和常量、运算符和表达式、控制语句、数组和字符串等等知识点。想要知道更多关于java基础知识的朋友,请阅读本专题下面的的有关文章,欢迎大家来php中文网学习。

1567

2023.10.24

if什么意思
if什么意思

if的意思是“如果”的条件。它是一个用于引导条件语句的关键词,用于根据特定条件的真假情况来执行不同的代码块。本专题提供if什么意思的相关文章,供大家免费阅读。

847

2023.08.22

js 字符串转数组
js 字符串转数组

js字符串转数组的方法:1、使用“split()”方法;2、使用“Array.from()”方法;3、使用for循环遍历;4、使用“Array.split()”方法。本专题为大家提供js字符串转数组的相关的文章、下载、课程内容,供大家免费下载体验。

760

2023.08.03

js截取字符串的方法
js截取字符串的方法

js截取字符串的方法有substring()方法、substr()方法、slice()方法、split()方法和slice()方法。本专题为大家提供字符串相关的文章、下载、课程内容,供大家免费下载体验。

221

2023.09.04

java基础知识汇总
java基础知识汇总

java基础知识有Java的历史和特点、Java的开发环境、Java的基本数据类型、变量和常量、运算符和表达式、控制语句、数组和字符串等等知识点。想要知道更多关于java基础知识的朋友,请阅读本专题下面的的有关文章,欢迎大家来php中文网学习。

1567

2023.10.24

字符串介绍
字符串介绍

字符串是一种数据类型,它可以是任何文本,包括字母、数字、符号等。字符串可以由不同的字符组成,例如空格、标点符号、数字等。在编程中,字符串通常用引号括起来,如单引号、双引号或反引号。想了解更多字符串的相关内容,可以阅读本专题下面的文章。

649

2023.11.24

java读取文件转成字符串的方法
java读取文件转成字符串的方法

Java8引入了新的文件I/O API,使用java.nio.file.Files类读取文件内容更加方便。对于较旧版本的Java,可以使用java.io.FileReader和java.io.BufferedReader来读取文件。在这些方法中,你需要将文件路径替换为你的实际文件路径,并且可能需要处理可能的IOException异常。想了解更多java的相关内容,可以阅读本专题下面的文章。

1228

2024.03.22

php中定义字符串的方式
php中定义字符串的方式

php中定义字符串的方式:单引号;双引号;heredoc语法等等。想了解更多字符串的相关内容,可以阅读本专题下面的文章。

1204

2024.04.29

C# ASP.NET Core微服务架构与API网关实践
C# ASP.NET Core微服务架构与API网关实践

本专题围绕 C# 在现代后端架构中的微服务实践展开,系统讲解基于 ASP.NET Core 构建可扩展服务体系的核心方法。内容涵盖服务拆分策略、RESTful API 设计、服务间通信、API 网关统一入口管理以及服务治理机制。通过真实项目案例,帮助开发者掌握构建高可用微服务系统的关键技术,提高系统的可扩展性与维护效率。

76

2026.03.11

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
最新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号