📜  在 jupyter notebook 中显示有关函数方法的文档或信息 - Python (1)

📅  最后修改于: 2023-12-03 15:37:23.013000             🧑  作者: Mango

在 jupyter notebook 中显示有关函数方法的文档或信息 - Python

作为一个 Python 程序员,你需要经常查询 Python 内置函数或第三方库的文档和信息。在 Jupyter Notebook 中,你可以通过以下几种方式来查看函数方法的文档和信息。

1. 使用内置函数 help()

Python 中的内置函数 help() 可以打印出函数的用法和文档。

# 使用 help() 显示内置函数的文档
help(len)

输出结果为:

Help on built-in function len in module builtins:

len(obj, /)
    Return the number of items in a container.

该结果提供了关于内置函数 len() 的基本信息,如函数名称、所在的模块、输入参数和函数作用等。

2. 使用 ?

在 Jupyter Notebook 中,你也可以使用 ? 来显示函数的文档和信息。

# 使用 ? 显示内置函数的文档
len?

输出结果同上。

3. 使用 ??

相比之下,你还可以使用 ?? 来显示函数的源代码和文档。

# 使用 ?? 显示内置函数的源代码和文档
len??

输出结果为:

Signature: len(obj, /)
Docstring: Return the number of items in a container.
Type:      builtin_function_or_method
File:      /usr/local/Cellar/python/3.7.2_2/Frameworks/Python.framework/Versions/3.7/lib/python3.7/__builtin__.py
Source:   
def len(obj, /):
    """
    Return the number of items in a container.
    """
    return _builtin_len(obj)

结果提供了关于内置函数 len() 的详细信息,包括函数签名、文档字符串、对象类型、代码文件和源代码等。

4. 使用 tab 键自动补全

Jupyter Notebook 还提供了一个很方便的自动补全功能。只需要输入函数名的前几个字符,然后按下 Tab 键即可自动补全函数名,同时还会弹出一个包含函数信息的弹出窗口。

# 输入函数名的前几个字符并按下 Tab 键
len<Tab>

弹出窗口会显示出与 len 相关的函数列表和信息。

总结

通过以上几种方式,你可以在 Jupyter Notebook 中方便地显示有关 Python 函数和方法的文档和信息。这些技巧能够帮助你更快速地掌握 Python 编程语言,并提高你的编程效率。