40

在 python 中，我可以使用help(<object>). 但是为了能够搜索文档，我必须上网。如果我在无法访问互联网的地方，这并没有真正的帮助。

在 R 中，有一个方便的双问号功能 ( ??<topic>)，它允许我在所有已安装库的文档中搜索包含<topic>在其名称或文档字符串中的任何函数。python有类似的东西吗？甚至可能只针对加载的对象？

4

9 回答 9

31

查看文件夹中的python文件夹：Doc. 此文件夹包含从python.org下载的 python 文档的完整文档。我知道这是一个非常晚的答案，但它提出了一个简单的解决方案。

于 2014-11-25T19:26:29.050 回答
25

pydoc 随 python 一起提供，可以进行搜索，但只能在可用模块的概要行中进行。报价pydoc --help：

pydoc -k
    在所有可用模块的概要行中搜索关键字。

请注意，在 pydoc 中，您可以使用“/”执行搜索。

于 2013-11-28T12:24:42.293 回答
7

评论中已经提到了这一点：Zeal 类似于 Dash，但适用于 Windows/Linux。它使用与 Dash 相同的来源。它是使用 Qt 构建的，可在多个发行版的存储库中使用，对于 Ubuntu，有一个 PPA。在这里下载。

Zeal 是一个简单的离线 API 文档浏览器，灵感来自 Dash（OS X 应用程序），可用于 Linux 和 Windows。

  • 使用 Alt+Space（或自定义）热键快速搜索文档，以便在工作区的任何位置显示 Zeal。
  • 一次搜索多组文档。
  • 不要依赖您的互联网连接。
  • 将 Zeal 与 Emacs、Sublime Text 或 Vim 集成。有关详细信息，请参阅用法»编辑器插件。

它是开源的 (GPL)，开发在GitHub 上进行。Zeal 使用与在线文档相同的样式表/HTML，所以一切都应该看起来很熟悉。

浏览器内的替代方案是devdocs.io。即使您处于离线状态，您也可以访问该网站，前提是您已将它们标记为本地离线存储。您需要启用 Python 2 文档，然后在此处将它们标记为离线存储。但是，作为在线 Python 文档的长期用户，我发现 DevDocs 使用的自定义样式表有点让人分心。

于 2015-03-19T08:20:44.683 回答
5

只是为离线访问 python 文档（主要是核心）添加另一个选项：

我目前无法访问 linux 计算机，但在 Windows 上，您可以导航your_python_dist_folder/doc到查找一些帮助文件。尤其python275.chm是例如。

如果您的 linux 机器上没有 doc 文件夹，您可以在此处下载文件并在 google 上找到 linux chm 查看器：

https://www.google.com/search?q=linux+chm+viewer

：：笔记：

一些发行版还包括其他软件包的文档......可能值得一试。除此之外，help(module)通常会返回良好的信息。

编辑：

您可以通过使用pydoc. sin例如，您正在数学模块中寻找有关的内容：

import math
import pydoc
[i for i in dir(math) if 'sin' in pydoc.getdoc(getattr(math,i))]

这将返回其文档字符串包括的方法sin：

['acos', 'acosh', 'asin', 'asinh', 'cos', 'cosh', 'isinf', 'sin', 'sinh']

然后您可以为此运行该help()功能

于 2013-11-26T01:00:47.547 回答
4

如果您在 Mac 上工作，则可以使用Dash下载文档集，然后离线浏览/搜索。尽管具有文档功能，但Dash还是一个片段管理器。

于 2013-11-24T16:48:00.997 回答
2

Windows Idle - 从 shell 窗口或编辑窗口按 F1 可以得到所有文档的 Windows 帮助文件。我认为它比在线版本更好 - 更容易找到东西。

于 2013-10-18T04:04:50.607 回答
2

这可能在提出和回答问题时不可用，但 python.org 现在将所有文档作为 HTML 文件的存档在线提供，可以离线导航和搜索：https ://docs.python.org/ 2/下载.html

（该链接指向 2.x 最新版本的文档，但您可以从该页面选择 3.x 和更早的 2.x 版本）

于 2015-01-30T03:17:37.517 回答
2

尽管您的计算机中内置的文档肯定比 windows idle 之类的 help() 更好，但对于一些更常见的主题，另一种选择是将一些在线文档保存到您的计算机中。对于你经常使用的模块，想离线访问，你可以下载官方在线python文档的文本文件版本，这是获取文档的最佳位置。（文件 > 将页面另存为 > 选择 .txt 文件格式）

于 2013-11-22T00:05:20.213 回答
0

你应该试试ipython。

对象名？将打印有关任何对象的各种详细信息，包括文档字符串、函数定义行（用于调用参数）和类的构造函数详细信息。

魔术命令 %pdoc、%pdef、%psource 和 %pfile 将分别打印任何对象的文档字符串、函数定义行、完整源代码和完整文件（如果可以找到）。如果 automagic 已打开（默认情况下），则无需显式键入 '%'。

于 2013-10-18T03:33:47.760 回答