如何访问文档字符串以获取更多信息 本节介绍help()、?、?? 当涉及到数据科学生态系统时,Python和NumPy是以用户为中心构建的。最好的例子之一是内置的文档访问。每个对象都包含对字符串的引用,该字符串称为docstring。在大多数情况下,这个文档字符串包含一个快速而简洁的对象摘要以及如何使用它。Python有一个内置的help()函数,可以帮助用户访问这些信息。这意味着几乎任何时候用户需要更多的信息,都可以使用help()快速找到需要的信息。
例如:
有关builtins模块内置函数max的帮助:使用单个可迭代对象参数,返回其最大项。这个default仅关键字参数指定在输入的可迭代对象参数为空时返回值。对于两个或多个参数,返回最大的参数。 由于访问附加信息非常有用,IPython(安装和使用见附录)使用“?”字符作为访问此文档以及其他相关信息的速记。IPython是一个用于多种语言交互计算的命令shell。有关IPython的更多信息,打开:https://ipython.org/。 例如:
甚至可以将此符号用于对象方法和对象本身。 首先创建了下面数组:
然后,可以获取许多有用的信息(首先是关于a实例本身的详细信息,然后是其类ndarray的文档字符串): 这也适用于您创建的函数和其他对象,不过需要在函数中使用文档字符串(三引号""" """ 或 ''' '''中的字符串 )。 例如,如果创建了函数:
可以如下获得有关这个函数的信息:
用户可以通过阅读感兴趣对象的源代码,来获得另一级别的信息。使用双问号(??)即可。 例如: 如果所讨论的对象是用Python以外的语言编译的,使用??得到的信息与?相同。在许多内置对象和类型中找到这种情况,例如: 由于这些函数已经用非Python语言编译,只有Docstring保留在已编译对象中,因此返回是一样的。
附录:安装和运行IPython
1、进入cmd界面后,配置pip镜像源为清华大学镜像源:
pip config set global.index-url https://pypi.tuna.tsinghua.edu.cn/simple 2、安装IPython:
pip install ipython 3、运行IPython:
ipython