Python

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

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

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

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

    新的存根文件

    Enter完成操作。

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

为外部实现创建存根文件

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

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

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

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

    为外部实现创建存根

在存根及其实现之间导航

PyCharm 在左侧装订线中为那些具有存根的代码元素显示一个星号。单击星号可在存根及其实现之间跳转:

从存根跳转到它的实现

    重用存根

    您可以让其他 PyCharm 项目可以访问您的存根。

    1. 单击状态栏中的项目解释器选择器,然后选择解释器设置

      翻译设置菜单
    2. Project Interpreter对话框中,单击浏览并选择Show All,然后在打开的Project Interpreter对话框中,单击显示所选解释器的路径

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

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

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

    任何时候您将使用此项目解释器来处理其他项目,都可以通过您刚刚添加的路径访问此存根库。

    安装存根包

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

    1. 安装包。如果需要,单击管理存储库以添加存根包所在的存储库。

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

      安装存根包
    3. 单击安装包完成安装。

    最后修改时间:2021 年 3 月 8 日