无法在存根包中导入.pyi文件

Question

我正在尝试构建一个.pyi存根文件包，以便与类型注释一起使用。我有这样的结构：

m/
  __init__.pyi
  sub.pyi

这样做是可行的：

>>> import m

情况并非如此(包括Python 3.10中的内容)：

>>> import m.sub
ModuleNotFoundError: No module named 'm.sub'

如果我将sub.pyi重命名为sub.py，那么我可以import m.sub。对于在哪里可以使用.pyi文件，或者我是否可以制作多文件存根包，我有什么误解？

Answer 1

cf PEP 484 -类型提示：

虽然存根文件在语法上是有效的Python模块，但它们使用.pyi扩展名来将存根文件与相应的实际模块保持在同一个目录中。这也强化了一个概念，即不应该期望存根文件的运行时行为。

.pyi文件不是用于Python解释器本身，而是由类型检查工具使用。

默认情况下，Python 装载机不会查找.pyi文件，因此无法导入它们。但是您可以导入一个包(它的名称与您要导入的目录相匹配)。这就是你犯错的原因。

查看PyCharm包含的存根文件，它所做的唯一import是实际的.py文件，而不是.pyi文件。