存根

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

1. 导航到目标实现所在的目录。选择文件 | 从主菜单中新建，然后选择Python 文件（或者使用快捷方式）。AltInsert

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

   

   按即可完成操作。Enter

为了方便起见，您可以创建一个单独的目录来保存存根及其实现。这将帮助您在其他项目中重用该存根。

为外部实现创建存根文件

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

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

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

   

3. 在创建的结构中，导航到目标目录并选择“文件”|“ 从主菜单中新建，然后选择Python 文件（或者使用快捷方式）。在“新建 Python 文件”对话框中，选择“Python 存根”并指定文件名。按下后将创建文件。您可以将任何其他所需的文件放入存根目录中。AltInsertEnter

   

在存根及其实现之间导航

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

动图

重复使用存根

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

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

   

2. 在“项目解释器”对话框中，单击并选择“显示全部”，然后在打开的“项目解释器”对话框中单击。

3. 在解释器路径对话框中，单击以添加新的路径记录：

   

4. 检查您的项目：包含存根文件的目录现在被标记为库根目录。

   

每当您使用此项目解释器处理其他项目时，都可以通过您刚刚添加的路径访问此存根库。

安装存根包

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

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

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

   

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