在Python3中,.pyi****文件是存根文件(stub file)。这个"pyi"中的"i"代表接口即interface,作为公共接口。在Python中不存在"interface",只是提供一个特殊的扩展。它是一个普通的Python文件,除了文件中的所有的方法都是空的。
存根文件仅包含模块公共接口的描述,没有任何实现。
.pyi文件中允许使用"..."代替任何实现细节。它是仅包含类型信息的文件,没有运行时代码。
.pyi文件是一个Python skeleton,具有适当的结构、调用签名和返回值,以匹配模块中定义的函数、属性、类和方法。
创建存根文件:
(1).为模块编写一个存根文件,并将其作为.pyi文件存储在与模块相同的目录中;
(2).或者将.pyi文件单独存放在为存根保留的目录中,在这种情况下,需要设置环境变量MYPYPATH。
参考: