pyi 文件

【PEP 484】什么是.pyi文件? 在PyCharm中查看源代码的时候,发现有些代码行有星号(*)标识,鼠标移上去会提示在某个.pyi文件中有其存根程序,点击星号会跳转到对应的存根程序处。 那什么是存根程序呢? 我第一次看到这个概念是在软件工程的书里,它主要就是用来做集成测试的。比如下图中M是实际开发出来的模块,S就是存根程序(一个临时文件,用来模拟实际的模块,向要测试的模块发送它们需要的消息)。这样的好处就是可以逐步完成整个大项目的测试。 那么在我这个例子的Python源码中,.pyi存根文件起到了什么作用呢? 在网上查.. 阅读详情

.pyi 文件是 Python 的存根文件(Stub Files),用于为 Python 模块提供类型提示信息(Type Hints),而不影响运行时的行为。它是 Python 类型系统(PEP 484、PEP 526 等)的一部分,主要用于支持静态类型检查工具如 mypy、PyCharm、VS Code 等 IDE 的智能提示和类型分析。


📌 .pyi 文件的作用

  1. 分离类型信息与实现代码

    • 可以将类型注解从运行时代码中分离出来,避免污染 .py 文件。
    • 特别适用于遗留项目或 C 扩展模块(如标准库中的 os.pyi、sys.pyi)。
  2. 支持第三方库的类型提示

    • 如果某个库本身没有提供类型提示,可以通过 .pyi 文件为其添加类型信息。
    • 例如:typeshed 项目就是 Python 官方维护的一个大型 .pyi 存储库,包含了标准库和一些内置模块的类型信息。
  3. 提高可维护性

    • 在团队开发中,使用 .pyi 文件可以更容易地管理和版本控制类型信息。

🧱 .pyi 文件的结构

.pyi 文件的语法与普通 .py 文件非常相似,但只包含函数签名、类定义、变量类型等类型信息,不包含实际的实现逻辑。

示例:

原始 .py 文件:
# my_module.py
def greet(name):
    print(f"Hello, {name}")
对应的 .pyi 文件:
# my_module.pyi
def greet(name: str) -> None: ...

注意:

  • 使用 ... 表示该函数没有实际体(即只是声明)。
  • 所有变量、函数、类都必须带有类型信息。

✅ .pyi 文件的命名和位置

  • 通常与对应的 .py 文件同名,扩展名为 .pyi。
  • 放在与 .py 文件相同目录下,或者放在特定的类型目录中(如 stubs/)。
  • 当使用类型检查器(如 mypy)时,会自动查找并加载这些文件。

🔍 示例:为类添加类型信息

.py 文件:
# person.py
class Person:
    def __init__(self, name, age):
        self.name = name
        self.age = age

    def say_hello(self):
        print(f"Hello, I'm {self.name}")
.pyi 文件:
# person.pyi
class Person:
    name: str
    age: int

    def __init__(self, name: str, age: int) -> None: ...
    def say_hello(self) -> None: ...

🛠️ 如何使用 .pyi 文件

  1. 安装类型检查工具(如 mypy)

    pip install mypy
    
  2. 运行类型检查

    mypy my_module.py
    

    mypy 会自动读取同目录下的 .pyi 文件进行类型检查。

  3. IDE 支持

    • VS Code(配合 Pylance)
    • PyCharm
    • 其他现代 Python 编辑器都支持 .pyi 文件中的类型提示。

🧩 更复杂的例子(含泛型、协议等)

# example.pyi
from typing import List, TypeVar, Protocol

T = TypeVar("T")

class HasLength(Protocol):
    def __len__(self) -> int: ...

def process(items: List[T]) -> T: ...
def get_length(obj: HasLength) -> int: ...

📅 关键时间线

时间版本事件
2014 年N/APEP 484 提案开始讨论,提出使用类型提示的标准方式,并首次提到使用 .pyi 存根文件用于分离类型信息与实现。
2015 年 9 月Python 3.5PEP 484 被接受并合入 Python 3.5,这是类型提示正式进入 Python 的起点。虽然 .pyi 不是语言特性本身的一部分,但它是 PEP 484 推荐的用法之一。
2016 年mypy 0.4.x+mypy 等静态类型检查工具开始广泛支持 .pyi 文件。
2017 年Python 3.6PEP 526 引入变量注解语法(如 x: int = 1),进一步丰富了类型系统生态,也增强了 .pyi 文件的能力。
2018 年PEP 561PEP 561 正式规范了如何为第三方库打包和分发类型信息(通过 .pyi 文件或 Typed 包标记)。这是 .pyi 文件被正式纳入生态系统标准的重要一步。

✅ 支持 .pyi 文件的 Python 版本

虽然 .pyi 文件不是 Python 解释器直接使用的功能(它们主要用于类型检查工具),但为了使用完整的类型提示语法,推荐使用以下版本:

功能建议最低 Python 版本
基础类型提示(函数参数、返回值)Python 3.5
变量注解(PEP 526)Python 3.6
支持 from typing import * 的完整特性Python 3.5+
支持 TypedDict、Protocol 等高级特性Python 3.8(通过 typing_extensions 可向后兼容)
PEP 561(发布类型信息包)Python 3.5+(工具支持为主)

🧩 工具对 .pyi 的支持

工具是否支持 .pyi
mypy✅ 完全支持
pyright / Pylance(VS Code)✅ 完全支持
PyCharm✅ 支持良好
pytype(Google)✅ 支持
Jedi(代码补全)⚠️ 部分支持

🔚 总结

问题回答
.pyi 是从哪个 Python 版本开始支持的?没有具体“开始支持”的版本,它是随类型提示(PEP 484)一起出现的,Python 3.5 是第一个支持完整类型提示语法的版本。
我应该使用哪个 Python 版本来配合 .pyi?推荐使用 Python 3.9 或更高版本,以获得最全面的类型系统支持。
.pyi 是官方支持的吗?是的,PEP 561 正式将其纳入 Python 生态系统标准。

📚 相关资源

python文件:py,ipynb, pyi, pyc, pyd, pyo都是什么文件? py文件是 Python 最基本的源代码文件格式,用于存储纯文本形式的 Python 代码。它是开发者编写程序的主要场所,包含函数、类、变量定义以及执行逻辑。Python 解释器直接读取并执行.py文件中的指令。例如 ,创建一个简单的hello.py")探索Python编程的多面性,从基础的.py源代码到交互式的.ipynb笔记,再到高效的.pyi类型提示文件,本文深入解析了Python文件的类型与应用。 阅读详情

相关推荐

详解Python文件: .py、.ipynb、.pyi、.pyc、​.pyd !

今天同事给我扔了一个.pyd文件,说让我跑个数据。然后我就傻了。。不知道多少粉丝小伙伴会run .pyd代码文件?如果你也懵懵的,请继续往下读吧。。今天科普下各类Python代码文件的后缀,给各位Python开发“扫扫盲”。

2201_75362610的博客 2631

Python3中.pyi文件介绍

Python3中.pyi文件介绍

网络资源是无限的 2万+

Python的pyi文件的作用.

这些文件通常被称为存根文件(stub files)或类型提示文件(type hint files),它们的主要作用是辅助类型检查和静态分析工具,以提高代码的可维护性和可读性。这段代码是一个Python类型提示(type hint)的示例,通常用于提供函数的静态类型信息。文件可以作为库的一部分分发,确保在不同项目和环境中的类型检查一致性。文件来模拟库的API,这样类型检查工具和IDE就可以使用这些存根文件来提供库的类型信息。文件中的类型信息来分析代码,从而提供更准确的重构建议、代码导航和其他代码质量检查。

zhangzhechun的专栏 1505

Python中的pyi文件浅析

在Python的PEP 484规范中有这样一段描述:这句话说的是pyi模块是为了辅助那些定义不明确的场景的。众所周知,Python是一种弱类型语言,不像C语言、Java语言以及Golang语言那样,在声明的时候必须确定类型,譬如int、string等等。弱类型语言在编写简单代码的时候确实给开发者带来了极大的方便,无需思考类型即可快速声明变量,然后随着代码的复杂程度增加,因为缺乏类型检查导致代码出问题的机率大大,弱类型语言也需要类型检测了。

m0_58477260的博客 3894

AI驱动的iOS逆向工程自动化:14阶段工作流与Ghidra集成实践

逆向工程是软件安全分析的核心技术,通过反汇编、调试等手段解析程序内部逻辑与数据流。其原理在于将编译后的二进制代码还原为可理解的逻辑结构,从而发现潜在漏洞或理解软件行为。在移动安全领域,iOS逆向工程具有重要技术价值,能够用于安全审计、漏洞挖掘与恶意软件分析。传统iOS逆向依赖ipsw、class-dump、Frida等工具链组合,存在学习曲线陡峭与流程碎片化问题。本文介绍的ios-reverse-skills项目创新性地将14阶段逆向工程方法论封装为AI可调用的标准化脚本集,通过Ghidra脚本实现Swif

weixin_27268733的博客 436

SDR 和 DDR 的区别

SDR 和 DDR 的差别,最明显提现在传输速率和频率上。DDR SDRAM与SDRAM的基本结构是相似的,最根本的区别在于DDR 支持在一个时钟周期内传输两次数据,,SDR 只能传输一次数据。

串起点滴 1961

【python】pyi文件

pyi文件是一个Python skeleton,具有适当的结构、调用签名和返回值,以匹配模块中定义的函数、属性、类和方法。pyi文件中允许使用"…"代替任何实现细节。它是仅包含类型信息的文件,没有运行时代码。rnorm是通过那个只有申明类型的pyi文件得到的?就是只有类型的声明 我不知道具体是怎么实现的。存根文件仅包含模块公共接口的描述,没有任何实现。pyi文件是存根文件(stub file)我想查看细节但是不知道怎么看。怎么生成pyi文件的教程在。pyi文件具体的作用在。

qq_45721997的博客 1398

Unity 面试篇|(四)Unity性能优化篇 【全面总结 | 持续更新】

Unity中,CPU准备好需要绘制的元素,对底层图形程序接口进行调用的过程,每次引擎准备数据并通知GPU的过程称为一次Draw Call。DrawCall越高对显卡的消耗就越大。降低DrawCall的方法:动态合批静态合批降低shader的等级特性场景优化策略——遮挡技术。rectMask2D替代Mask。

游戏开发小Y的博客 13万+

Pycharm查看函数源码时进入pyi文件

本教程主要是为了解决一个在使用Pycharm时常见的一个问题,这个问题虽然不会对写代码造成很大的影响,但是对于我个人而言是一件比较厌烦的事情。

m0_43402033的博客 3001

TensorRT - 使用自定义层扩展 TensorRT

TensorRT 支持通过自定义插件扩展功能。开发者可以基于 IPluginV3 接口实现插件类,并通过 IPluginCreatorV3One 创建器类注册到 TensorRT 插件注册表。插件实现需要包含核心、构建和运行时三种能力,并通过静态或动态方式注册。最后可使用 addPluginV3() 将插件实例添加到 TensorRT 网络中。这种方法允许在标准层不满足需求时,使用自定义层扩展模型功能。

1149

2026国内Claude Code保姆级教程:安装、避坑、防串台全优化

安装 Claude Code CLI + 切换 npm 国内镜像优先配置固定关闭:自动联网、自动项目扫描VSCode 内置终端直接用,不装多余插件会话隔离+指令约束,彻底解决 Rust、小程序 跨语言串台。

lpfasd123的博客 2572

Python pyi文件

当用nn.conv2d()函数的时候,发现它内部其实是调用的F.conv2d(),而F.conv2d()的定义是在__init__.pyi文件里 那么,pyi到底是什么文件呢 pyi文件是Python 的存根文件,用于代码检查时的类型提示。 pyi文件是PEP484提案规定的一种用于 Python 代码类型提示(Type Hints)的文件。PEP即Python Enhancement Proposals,是经过 Python 社区核心开发者讨论并一致同意后,对外发布的一些正式规范文档 .

hxxjxw的博客 4599

一桶令牌的时间账本:四类限流算法的边界推演与Guava RateLimiter源码精读

限流的难点不在背出算法名,而在算清每一笔账:按哪一秒计数、超额请求排队还是拒绝、空闲后能否突发、集群总量如何约束。本文在可复现的虚拟时间实验台上对比固定窗口、滑动窗口、漏桶与令牌桶,实测边界双倍突发与分桶滑动的真实上界,拆解Nginx limit_req的千分位记账与延迟机制,纠正Resilience4j常被误称漏桶的说法,并逐行精读Guava SmoothRateLimiter的预消费、懒惰补账与预热积分,复刻迷你限流器与其完成七万次零差异对账,最后给出集群配额、分层防护与参数确定的方法。

曾经“等你生日那天”都遥远得像未来,如今却可欢愉的挥手说“下个十年见” 86万+

解决问题:pycham想要查看注释,跳转到了pyi文件

想要查看pyi文件,总是突然跳到一个pyi文件 这个文件里面全是接口 def most_common(self, n: Optional[int] = ...) -> List[Tuple[_T, int]]: ... 这个东西是干啥用的呢? 是pycham自己生成的用来静态检查的文件,也没有什么性能损害。 他就是为了告诉我们python中的一个变量到底是什么类型的东西。比如你的...

qq_29134801的博客 2318

【硬件工程师面经整理18_Smith圆图】

若文中任何内容侵犯了您的合法权益,请相关权益人及时与我联系,我将立即进行核实并采取适当措施,包括但不限于删除相关内容或更新文章以消除影响。**在Smith圆图上,源阻抗表示为圆心,而负载阻抗表示为圆图上的一个点。具体来说,通过将负载阻抗在Smith圆图上移动到特定位置,使其与传输线特性阻抗形成纯电阻或纯电抗的组合,从而实现匹配。例如,反射系数表示为Smith圆图上的一个点,而驻波比则表示为圆图上两个点之间的距离。Smith圆图是用于阻抗匹配和网络分析的工具,它是一种将复阻抗表示为坐标的图形。

LeeYLong的博客 654

科研项目数据抓取:Python爬虫实现与分析

本文详细介绍了如何使用Python爬虫抓取科研项目的数据,涵盖了从目标数据源选择到数据存储与分析的整个过程。通过使用。

2201_76125261的博客 1712

pycham想要查看注释,跳转到了pyi文件

在文件——设置——编辑器——文件类型————忽略的文件和文件夹 添加 *.pyi 暂时未知在使用 .pyi 文件时会出现什么问题

qq_36743284的博客 2910

Devexpress16.2.6破解工具

Devexpress16.2.6破解工具Devexpress16.2.6破解工具Devexpress16.2.6破解工具Devexpress16.2.6破解工具

Python3中.pyi文件

Python3中.pyi文件

m0_46829545的博客 479

ssm框架搭建

这个是一个在idea上成功跑起来的ssm框架项目,保存在这里方便以后使用直接下载

Data-Structures-and-Algorithm-Analysis-in-Java.pdf

作者: Weiss, Mark A. 出版社: Addison Wesley Data Structures and Algorithm Analysis in Java is an “advanced algorithms” book that fits between traditional CS2 and Algorithms Analysis courses. In the old ACM Curriculum Guidelines, this course was known as CS7. This text is for readers who want to learn good programming and algorithm analysis skills simultaneously so that they can develop such programs with the maximum amo...

import .pyi 文件无法导入

在服务器中运行别人的代码时用到了.pyi文件,但是显示no module。服务器版本:Ubuntu 22.04.3 LTS \n \l。python环境已安装:Python 3.10.12。请问是需要安装什么编辑器吗?

lishuang1999的博客 914

华为的C语言编程规范.pdf

华为技术有限公司内部技术规范。本规范制定了编写C语言程序的基本原则、规则和建议。从代码的清晰、简洁、可测试、安全、程序效率、可移植各个方面对C语言编程作出了具体指导。

Pyd文件和Pyi文件-动态链接库-动态链接-动态信息

pyd文件是Python的动态链接库(Dynamic Link Library,DLL)文件,它是一种特定类型的.dll文件,专门用于Python。.pyd文件通常包含由C、C++或其他语言编写的编译代码,可以被Python程序导入和使用。.pyi文件是Python的类型提示存根文件(Type Hint Stub File),它包含了Python模块的类型信息,但不包含具体的实现代码。.pyi文件用于为已有的Python模块或.pyd文件������类型提示,以便于静态类型检查和代码补全。.pyd。

远方雪的专栏 1719

【PEP 484】.pyi文件

在PyCharm中查看源代码的时候,发现有些代码行有星号(*)标识,鼠标移上去会提示在某个.pyi文件中有其存根程序,点击星号会跳转到对应的存根程序处。 那什么是存根程序呢?我第一次看到这个概念是在软件工程的书里,它主要就是用来做集成测试的。比如下图中M是实际开发出来的模块,S就是存根程序(一个临时文件,用来模拟实际的模块,向要测试的模块发送它们需要的消息)。这样的好处就是可以逐步完成整个大项目的测试。 那么在我这个例子的Python源码中,.pyi存根文件起到了什么作用呢?在网上查询的时候,有人推荐了PE

eli的博客 909

python 存根_pyi文件是干吗的?(一文读懂Python的存根文件和类型检查)

参考资料:html写这篇文章的缘由是我在网上下载的项目中看到了.pyi文件,可是寻找了不少资料才对这些个概念(存根文件、类型检查)有了一个直观的印象。这篇随笔的目的是用最短的篇幅让你理解这些概念!测试首先我介绍几个论断:this1. PEP484spa首先PEP是Python社区使用的规范化文档(就好像IETF用的rtf),PEP484这个文档是对type hint做规范化的文档!它规范化了typ...

weixin_35917052的博客 4014

pyi文件是干嘛的?(一文读懂Python的存根文件和类型检查)

  参考资料:   https://blog.youkuaiyun.com/weixin_40908748/article/details/106252884   https://www.python.org/dev/peps/pep-0484/   https://www.jetbrains.com/help/pycharm/stubs.html   写这篇文章的原因是我在网上下载的项目中看到了....

思念殇千寻的博客 8062

PyTorch中的pyi檔案生成機制

在PyTorch中如果查找python函數的定義,十有八九會跳轉到torch/_C/_VariableFunctions.pyi這個檔案。但是如果去PyTorch的github repo上尋找這個檔案,只能找到一個跟它名字類似的torch/_C/_VariableFunctions.pyi.in,卻找不到torch/_C/_VariableFunctions.pyi這個檔案本身。

keineahnung2345的博客 1802
上一篇: xtp+ctp 交易系统接口简介
下一篇: cpp 绑定方案大比拼
旷野说
博客等级 码龄9年 361粉丝 86原创
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付:10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值