在 Docstring 中为 Python 模块添加帮助文本

【问题标题】：Adding help text for Python module in Docstring在 Docstring 中为 Python 模块添加帮助文本
【发布时间】：2015-02-25 03:51:42
【问题描述】：

我正在尝试添加帮助文本以在我的 python 脚本中运行，类似于为 input() 或 print() 打开括号时。 Docstrings 做了类似的事情，但在编写代码时没有用。

看下图我想要什么。用于打印的黄色弹出文本是我也想为 pythagorus() 函数或类似的东西打开的东西。

我也希望把这个应用到这个以外的功能上。

【问题讨论】：

首先pythagorus()是一个函数，而不是一个模块。之后，此弹出窗口将向您显示函数的可用参数，而不是文档字符串。尝试创建一个带有一些参数的函数，看看它们是否会出现在这个弹出窗口中。
顺便说一句，它拼写为 Pythagoras，以 -as 结尾，而不是 -us。

【解决方案1】：

看起来您正在使用空闲。您看到的黄色弹出窗口实际上是print 文档字符串的第一行。通常 idle 显示方法签名（除了像 print 这样的内置函数）和文档字符串的第一行，所以如果你想在那里显示一些有用的东西，那么使用有用的文档字符串。

在 python3 中，您还可以使用function annotations 来提示您的函数的正确用法。

如果你的示例函数接受两个参数并返回一个值，它实际上会更有意义。然后它可能看起来像这样：

def pythagorus(a: int, b: int) -> int:
    """ calculate a**2 + b**2

    ... usage example, etc ...
    """
    return math.sqrt(a**2 + b**2)

这会像这样显示在空闲状态：

【讨论】：