如何在 jupyter notebook 中获取函数帮助 - Python

在 Jupyter Notebook 中，我们可以方便地获取函数的帮助文档。这个功能对于程序员在了解和使用新的函数和模块时非常有用。在本教程中，我们将学习如何在 Jupyter Notebook 中获取函数的帮助以及如何解读函数帮助文档。

获取函数帮助

在 Jupyter Notebook 中，要获取函数的帮助文档，你可以使用内置的 help() 函数或者使用问号 ?。

使用 help()

要使用 help() 函数获取函数的帮助文档，只需将函数名称作为参数传递给它即可。

help(function_name)

这将在单元格中以文本形式显示函数的帮助文档。

使用问号 ?

要获取函数的帮助文档，你也可以在函数名称后面加上问号 ?。

function_name?

这将在单元格底部的“Help”选项卡中显示函数的帮助文档。

解读函数帮助文档

函数的帮助文档提供了关于函数的描述、参数列表、返回值以及函数的用法示例等信息。在阅读函数帮助文档时，你可能会遇到一些常用的描述符号和约定：

• function_name(arg1, arg2=default_value)：这个部分会列出函数的参数及其默认值。方括号 [ ] 表示参数是可选的。
• -> return_type：在帮助文档的最后，函数的返回值类型会以箭头 -> 的形式给出。
• Raises:：这个部分列出了函数可能引发的异常。
• 示例代码块：函数帮助文档通常会包含一些使用函数的示例代码块，以帮助你理解函数的用法。

示例

让我们使用一个简单的示例来获取和解读函数的帮助文档。

def add(a, b=0):
    """
    将两个数字相加并返回结果。

    Parameters:
        a (int): 第一个数字。
        b (int, optional): 第二个数字，默认为 0。

    Returns:
        int: 两个数字的和。

    Raises:
        TypeError: 如果 `a` 或 `b` 不是整数。

    Example:
        >>> add(2, 3)
        5
        >>> add(10)
        10
    """
    return a + b

要获取函数 add() 的帮助文档，我们可以使用 help() 函数或者在函数名称后面加上问号 ?。让我们尝试一下：

help(add)

# 或者

add?

你会注意到函数的帮助文档显示在单元格中或“Help”选项卡中，包括函数的描述、参数、返回值和示例。

这样，你就学会了如何在 Jupyter Notebook 中获取函数的帮助文档。这个功能对于学习和使用 Python 中的不同函数非常有用，帮助你更好地理解函数，并将其应用到你的程序中。