PyCharm 2025.2 Help

存根

PyCharm 支持带有 Python 存根文件 .pyi 扩展名。 这些文件允许您使用 Python 3 语法为 Python 2 和 3 指定 类型提示

为您自己的实现创建一个存根文件

  1. 导航到目标实现所在的目录。 从主菜单中选择 文件|新建 ,然后选择 Python 文件 (或者使用 Alt+Insert 快捷键)。

  2. 新建 Python 文件 对话框中,选择 Python 存根 并指定文件名。 文件名应与实现文件的名称相同。

    新建存根文件

    按下 Enter 以完成操作。

为了方便,您可以创建一个单独的目录来存放您的存根及其实现。 这将帮助您将存根 复用于其他项目

为外部实现创建一个存根文件

您可以为安装在环境中的包中的某些实现创建存根文件。

  1. 为您的存根 创建一个目录。 右键点击目录,并从上下文菜单中选择 将目录标记为 | 源根

  2. 在目录中,重新创建与实现包对应的层次结构。

    创建与存根实现包对应的结构
  3. 在创建的结构中,导航到目标目录,然后从主菜单中选择 文件|新建 ,然后选择 Python 文件 (或者使用 Alt+Insert 快捷键)。 在 新建 Python 文件 对话框中,选择 Python 存根 并指定文件名。 按下 Enter ,文件将被创建。 您可以将任何其他所需文件放入存根目录。

    为外部实现创建一个存根

在存根与其实现之间导航

PyCharm 在左侧边栏中为具有存根的代码元素显示一个星号。 点击星号以在存根与其实现之间跳转:

从存根跳转到其实现

    复用存根

    您可以使您的存根对其他 PyCharm 项目可用。

    1. 点击 项目解释器 选择器,在 状态栏 中选择 解释器设置

      解释器设置菜单
    2. 项目解释器 对话框中,点击 浏览 并选择 显示全部 ,然后在打开的 项目解释器 对话框中,点击 显示所选解释器的路径

    3. 解释器路径 对话框中,点击 添加按钮 以添加新的路径记录:

      添加路径
    4. 检查您的项目:存根文件所在的目录现在已标记为库根目录。

      标记为库根目录的存根目录

    每当您使用此项目解释器处理其他项目时,您添加的路径将使此存根库可用。

    安装存根包

    为了更广泛的使用,您可以创建一个存根包并上传到 pypi 仓库。 在 Packaging Python Projects 指南 中查看更多信息。 通过 PEP-561 支持,您可以为项目解释器安装存根包。

    1. 安装包。 如有需要,点击 管理仓库 以添加存放存根包的仓库。

    2. 存根包具有预定义的名称格式,因此在搜索字段中输入 "-stubs" 以发现它们。

      安装存根包
    3. 点击 安装软件包 完成安装。

    最后修改日期: 2025年 9月 26日