Pycharm
 
2023.3
快捷方式：Windows
获取 PyCharm
  1. Python
  2. 文档源代码
  3. 使用文档字符串指定类型

使用文档字符串指定类型

最后修改时间：2023 年 9 月 7 日

介绍

您可以永久调试代码，现在在调试过程中您还可以收集类型信息并在文档字符串中指定这些类型。

PyCharm 提供了一个意图操作，可以在运行时收集类型信息并定义类型规范。

然而，很可能在没有调试器的情况下手动指定参数的类型。

示例部分对这两种情况进行了探讨。

参数类型说明

要指定参数类型，请遵循以下一般步骤

  1. 按并转到编辑器 | 一般|智能钥匙。CtrlAlt0S

    在编辑器设置的智能键页面中选择插入类型占位符复选框。

  2. 将插入符号放在函数名称处，然后按。AltEnter

  3. 在打开的意图操作列表中，选择插入文档字符串存根。PyCharm 根据所选的文档字符串格式以及在调试器会话期间收集的类型规范创建文档存根。

请注意，reStructuredText 用于所有后续示例，但可以使用任何受支持的文档字符串格式，无论是纯文本、Epytext、Google 还是 NumPy。有关更多信息，请参阅Python 集成工具。

例子

考虑以下代码：

import math


class SimpleEquation:
    def demo(self, a, b, c):
        d = math.sqrt(abs(b ** 2 - 4 * a * c))
        root1 = (-b + d) / (2 * a)
        root2 = (-b - d) / (2 * a)
        print(root1, root2)


SimpleEquation().demo(3, 2, 1)

假设已在Python Integrated Tools页面上选择reStructuredText作为文档字符串格式。

手动指定类型

  1. 将插入符号放在函数名称处（此处为demo）。建议的意图操作是插入文档字符串存根。有关更多信息，请参阅创建文档注释。

    插入文档字符串存根
    单击此意图可生成以下格式的文档注释存根reStructuredText：

    文档示例

  2. 手动指定所需的参数类型：

    文档字符串示例

    顺便说一句，您可以使用 该函数的快速文档。如果将插入符号放在函数名称处并按，您将看到：Ctrl0Q

    快速文档窗口中的文档字符串

请注意，对于 reStructuredText，可以用两种格式指定类型：

  • :param param_type param_name: parameter description（类型描述与参数描述在同一行）。

  • :type param_name: param_type（类型描述位于单独的一行）

两种变体如下所示：

使用 reStructuredText 指定类型

借助调试器指定类型

  1. 按并转到构建、执行、部署 | Python 调试器。在“Python 调试器”页面中，选中“收集代码洞察的运行时信息”复选框。CtrlAlt0S

  2. 调试函数调用，并再次使用意图操作插入文档字符串存根。有关调试会话期间获得的参数和返回值的信息将用于在文档字符串中预填充类型注释。

    插入文档字符串存根

  3. 检查结果：

    文档示例

也可以看看

特定于语言和框架的指南