2022年 11月 16日

Python如何快速查每个类的用法和帮助文档

一、dir函数

比如要使用到d2l模块下的synthetic_data函数即d2l.synthetic_data(),但是忘了“synthetic_data”这个名字,可以使用dir打印出d2l包含的所有函数

通常,我们可以忽略以“__”(双下划线)开始和结束的函数(它们是Python中的特殊对象), 或以单个“_”(单下划线)开始的函数(它们通常是内部函数)。 根据剩余的函数名或属性名,可以猜测该模块对应的功能,并从中回忆起我们想用的内容。

如果只看名字想不起来功能,可以使用help函数进一步查看该函数的用法和功能。

二、help函数

help函数可以查找指定函数和类的用法,比如我们为了用 d2l.synthetic_data() ,已经使用dir函数得到 synthetic_data 这个函数名了,可以使用 help(d2l.synthetic_data) 进一步查看用法和功能。

三、?和?? 

在Jupyter记事本中,可以使用 ? 指令在另一个浏览器窗口中显示文档。

例如  d2l.synthetic_data? 指令将创建与 help(d2l.synthetic_data) 指令几乎相同的内容,并在新的浏览器窗口中显示它。

此外,如果我们使用两个问号,如 d2l.synthetic_data?? ,将显示实现该函数的Python代码。

这个功能其实还蛮方便的,有时候我们就是想看一下他底层代码怎么写的以便我们更好地理解。想在撸代码这条路上进阶的选手必备!

以上内容来自2.7. 查阅文档 — 动手学深度学习 2.0.0-beta0 documentation

 写代码时常常遇到查文档不方便的问题,今日恰好看到,特此记录与分享!