Python 小技巧 055：Python 的 pydoc（1. 基本用法）

zltzlt

Python 的 pydoc（基本用法）

pydoc 是 Python 自带的一个文档生成工具，使用 pydoc 可以很方便的查看类和方法结构。pydoc 模块可以从 Python 代码中获取帮助信息（Docstring）。

今天就让我们来学学它的基本使用方法。

查看 Python 关键字及其用法

在命令行中输入 python -m pydoc keywords，可以查看当前 Python 版本的所有关键字（-m 指定 Python 将模块当做脚本执行）：



（相当于在 Python Shell 中执行 help('keywords')）

Enter any keyword to get more help 说明可以通过 python -m pydoc keywords {关键字名} 来获取指定关键字的帮助信息。比如我想查看 nonlocal 关键字的帮助信息：

> python -m pydoc keywords nonlocal

Here is a list of the Python keywords.  Enter any keyword to get more help.

False               class               from                or
None                continue            global              pass
True                def                 if                  raise
and                 del                 import              return
as                  elif                in                  try
assert              else                is                  while
async               except              lambda              with
await               finally             nonlocal            yield
break               for                 not

The "nonlocal" statement
************************

   nonlocal_stmt ::= "nonlocal" identifier ("," identifier)*

The "nonlocal" statement causes the listed identifiers to refer to
previously bound variables in the nearest enclosing scope excluding
globals. This is important because the default behavior for binding is
to search the local namespace first.  The statement allows
encapsulated code to rebind variables outside of the local scope
besides the global (module) scope.

......

查看 Python 当前可被导入的所有模块

在命令行输入 python -m pydoc modules，可以查看当前 Python 可被导入的所有模块（包括第三方模块）：



（相当于在 Python Shell 中执行 help("modules")）

查看 Python 内置函数、模块及包的文档

查看 Python 内置函数、模块和包的方法很简单，只需要输入 python -m pydoc {函数名 \ 模块名 \ 包名} 命令：

_2_

来抢沙发了

_2_

第一个图片下，多打了一个括号
@zltzlt

zltzlt

_2_ 发表于 2020-1-24 17:10
第一个图片下，多打了一个括号
@zltzlt

没有，你视力有问题