摘要

本 PEP 描述了 Python 的一个命令行驱动的在线帮助工具。该工具应该能够建立在现有的文档工具（如 Python 文档和文档字符串）的基础上。它也应该可以扩展到新的类型和模块。

交互式使用

只需键入 help 即可描述帮助函数（通过 repr() 重载）。

help 也可以用作函数。

该函数接受以下形式的输入

• help( "string" ) – 内置主题或全局变量
• help( <ob> ) – 来自对象或类型的文档字符串
• help( "doc:filename" ) – 来自 Python 文档的文件名

如果请求全局变量，它可以是完全限定的名称，例如

help("xml.dom")

您也可以从命令行使用该工具

python --help if

在这两种情况下，输出都会进行分页，类似于 more 命令。

实现

帮助函数在 onlinehelp 模块中实现，该模块是按需加载的。

应该可以通过 onlinehelp 模块从命令行以外的环境获取帮助信息。

onlinehelp.gethelp(object_or_string) -> string

还可以通过将值赋给 onlinehelp.displayhelp(object_or_string) 来覆盖帮助显示函数。

该模块应该能够从 Python 文档的 HTML 或 LaTeX 版本中提取模块信息。链接应该以“类似 lynx”的方式处理。

随着时间的推移，它还应该能够识别文档字符串是否使用“特殊”语法（如结构化文本、HTML 和 LaTeX），并适当地对其进行解码。

原型实现与 Python 源代码分发一起提供，位于 nondist/sandbox/doctools/onlinehelp.py。

内置主题

• help( "intro" ) – 什么是 Python？请先阅读！
• help( "keywords" ) – 什么是关键字？
• help( "syntax" ) – 总体语法是什么？
• help( "operators" ) – 可用哪些运算符？
• help( "builtins" ) – 内置了哪些函数、类型等？
• help( "modules" ) – 标准库中有哪些模块？
• help( "copyright" ) – 谁拥有 Python？
• help( "moreinfo" ) – 哪里可以找到更多信息？
• help( "changes" ) – Python 2.0 中有哪些变化？
• help( "extensions" ) – 安装了哪些扩展？
• help( "faq" ) – 经常被问到的问题有哪些？
• help( "ack" ) – 最近谁在 Python 上工作？

安全问题

此模块将尝试导入与请求主题名称相同的模块。如果您不确定 PYTHONPATH 中的所有内容都来自可信来源，请勿使用这些模块。