请问`python stubs`的目的是什么呢，我们在开发python项目会不会使用到它呢？

Question

在Python中，我们经常听到词汇：存根python stubs

1、请问它python stubs的目的是什么呢，我们在开发python项目会不会使用到它呢？

2、它和.pyi文件有没有关系呢？

Answer 1

问题1

Python中的存根（stubs）文件，通常以.pyi为后缀，目的有这三个

1.静态类型检查

2.代码编辑器的智能提示和补全

3.文档生成

问题2

至于存根文件和.pyi文件的关系，.pyi文件就是存根文件的一种形式。它们用于在不运行代码的情况下提供对库、模块以及类的类型信息的定义。在.pyi文件中，我们可以声明函数、类以及方法的类型，并提供它们的参数和返回值的类型注解。

补充

如果你只是开发一个普通的项目，通常只需要.py文件即可。如果你需要更好的类型检查和代码补全体验，大型项目或者你在开发一个公共库，那么创建.pyi文件会比较好。