Python 自学不求人

时间：2020-02-07 12:36:02 阅读：130 评论：0 收藏：0 [点我收藏+]

自学 Python 不求人，本文介绍 Python 自学时如何获取免费权威的帮助信息。

概述

如何使用 Python 自带的 help() 方法
如何利用 Python 文档
获取中文文档

获取帮助 `help`

每次进入 python 解释器的交互模式时，都会先打印横幅消息，在版本信息下面就是推荐
的命令:

Type "help", "copyright", "credits" or "license" for more information.
>>>

让我们试试:

>>> help
Type help() for interactive help, or help(object) for help about object.
>>>

提示使用 help() 进入交互式的 help，或者使用传一个对象给 help(object)。

交互式 `help`

不带参数调用 help() 进入到 help 的交互模式：

>>> help()

Welcome to Python 3.8's help utility!

If this is your first time using Python, you should definitely check out
the tutorial on the Internet at https://docs.python.org/3.8/tutorial/.

Enter the name of any module, keyword, or topic to get help on writing
Python programs and using Python modules.  To quit this help utility and
return to the interpreter, just type "quit".

To get a list of available modules, keywords, symbols, or topics, type
"modules", "keywords", "symbols", or "topics".  Each module also comes
with a one-line summary of what it does; to list the modules whose name
or summary contain a given string such as "spam", type "modules spam".

help>   <--- 开始变成 help 的提示符

这时候可以输入想要查询的任何内容，有几种特定的查询词：

modules，显示所有的模块列表
keywords，显示所有关键字
symbols, 显示所有的符号
topics，显示一些特定的话题，注意这些话题都是全部大写的，想要继续查询也需要输入全部大写的话题名。

`help(thing)`

进入交互式模式步骤较多，所以大多少情况下我们直接给 help() 传递一个参数，这个参数就是要查的东西，比如用来查询 help 自己：

>>> help(help)
Help on _Helper in module _sitebuiltins object:

class _Helper(builtins.object)
 |  Define the builtin 'help'.
 |
 |  This is a wrapper around pydoc.help that provides a helpful message
 |  when 'help' is typed at the Python interactive prompt.
 |
 |  Calling help() at the Python prompt starts an interactive help session.
 |  Calling help(thing) prints help for the python object 'thing'.
 |
 |  Methods defined here:
 |
 |  __call__(self, *args, **kwds)
 |      Call self as a function.
 |
 |  __repr__(self)
 |      Return repr(self).
 |
 |  ----------------------------------------------------------------------
 |  Data descriptors defined here:
 |
 |  __dict__
 |      dictionary for instance variables (if defined)
 |
 |  __weakref__
 |      list of weak references to the object (if defined)

这个东西可以是一个对象，Python 里面一切皆对象，所以它就是任何我们能用的东西（变量、函数、类、模块等），但是这里有个前提是，这个对象必须得在当前的命名空间内能访问，这才能直接用它的名字，比如 sys 模块，要导入后才能查。

会在以后讲解变量的时候详细讨论名字。

如果没有导入就会报错:

>>> help(sys)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
NameError: name 'sys' is not defined

所以这种传对象的方式也不能去查关键字和符号，比如:

>>> help(def)
  File "<stdin>", line 1
    help(def)
         ^
SyntaxError: invalid syntax

>>> help(+)
  File "<stdin>", line 1
    help(+)
          ^
SyntaxError: invalid syntax

这时候就需要把查询关键字用引号括起来作为字符串传给 help()

>>> help('sys')
>>> help('def')
>>> help('+')

在 help 交互模式下没有此限制

所以，help 的用法很简单，哪里不会查哪里。

help 的帮助信息里面还有关键的一句话:

This is a wrapper around pydoc.help that provides a helpful message

when 'help' is typed at the Python interactive prompt.

我们简单看下 pydoc

`pydoc` 模块

pydoc 是一个模块，用来从 python 模块自动生成文档（documentation）。

>>> import pydoc
>>> pydoc.help.help('sys')   # 等价 help('sys')

pydoc 提供了命令行操作，不过无法直接使用。用我们学过的 python -m 的启动方式即可:

# 在命令行中执行，不是在 python 交互环境
python -m pydoc
pydoc - the Python documentation tool

pydoc <name> ...
    Show text documentation on something.  <name> may be the name of a
    Python keyword, topic, function, module, or package, or a dotted
    reference to a class or function within a module or module in a
    package.  If <name> contains a '\', it is used as the path to a
    Python source file to document. If name is 'keywords', 'topics',
    or 'modules', a listing of these things is displayed.

pydoc -k <keyword>
    Search for a keyword in the synopsis lines of all available modules.

pydoc -n <hostname>
    Start an HTTP server with the given hostname (default: localhost).

pydoc -p <port>
    Start an HTTP server on the given port on the local machine.  Port
    number 0 can be used to get an arbitrary unused port.

pydoc -b
    Start an HTTP server on an arbitrary unused port and open a Web browser
    to interactively browse documentation.  This option can be used in
    combination with -n and/or -p.

pydoc -w <name> ...
    Write out the HTML documentation for a module to a file in the current
    directory.  If <name> contains a '\', it is treated as a filename; if
    it names a directory, documentation is written for all the contents.

这里参数还是比较简单的，普通的使用就和 help 差不多，唯一有点亮点的是可以自动起一个 HTTP 服务器，并自动打开浏览器，显示文档的 html 页面:

python -m pydoc -b

这里需要说明的是，因为这个帮助系统是通过 module 自动生成的，所以它不仅仅是能显示 Python 标准库的帮助信息。正常安装的第三方库的帮助信息也能一起查询到。

比如说，查一下 requests:

>>> help('requests')
Help on package requests:

NAME
    requests

DESCRIPTION
    Requests HTTP Library
    ~~~~~~~~~~~~~~~~~~~~~

    Requests is an HTTP library, written in Python, for human beings. Basic GET
    usage:

       >>> import requests
       >>> r = requests.get('https://www.python.org')
       >>> r.status_code
       200
       >>> 'Python is a programming language' in r.content
       True