在线搜索python docs?

时间:2013-10-18 03:20:37

标签: python offline

在python中,我可以使用help(<object>)为任何对象获取一些基本文档。但是为了能够搜索文档,我必须上网。如果我在某个无法访问互联网的地方,这并不是真的有用。

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

9 个答案:

答案 0 :(得分:24)

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

答案 1 :(得分:15)

pydoc附带python,可以进行搜索,但只能在可用模块的概要行中进行搜索。引用pydoc --help

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

请注意,在pydoc中,您可以使用“/".

执行搜索

答案 2 :(得分:5)

只需为python文档的离线访问添加另一个选项(主要是核心):

我目前无法访问Linux计算机,但在Windows上,您可以导航到your_python_dist_folder/doc以查找一些帮助文件。特别是python275.chm

如果你的linux机器上没有doc文件夹,你可以下载文件here和google for linux chm viewer:

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()函数

答案 3 :(得分:5)

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

  

Zeal是一款简单的离线API文档浏览器,受Dash(OS X应用程序)启发,适用于Linux和Windows。

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

它是开源(GPL),开发发生在GitHub。 Zeal使用与在线文档相同的样式表/ HTML,因此一切都应该看起来很熟悉。

浏览器中的替代方案是devdocs.io。即使您已离线,也可以访问该网站,前提是您已将其标记为本地离线存储。您需要启用Python 2文档,然后将其标记为脱机存储here。但是,作为在线Python文档的长期用户,我发现DevDocs使用的自定义样式表有点分散注意力。

答案 4 :(得分:4)

如果您在Mac上工作时有Dash,则可以下载文档集,然后离线浏览/搜索。尽管有文档功能,Dash也是一个代码片段管理器。

答案 5 :(得分:2)

Windows空闲 - 来自shell窗口或编辑窗口的F1会获取所有文档的Windows帮助文件。我认为它比在线版本更好 - 它更容易找到东西。

答案 6 :(得分:2)

虽然你的计算机内置的文档确实比windows(如windows)空闲的help()更好,但是一些更常见的主题的另一个选择就是将一些在线文档保存到你的计算机上。对于您经常使用并希望脱机访问的模块,您只需下载官方在线python文档的文本文件版本,这是获取文档的最佳位置。 (文件&gt;将页面保存为&gt;选择.txt文件格式)

答案 7 :(得分:2)

这个问题在提出和回答时可能尚未提供,但python.org现在可以在线提供所有文档作为HTML文件的存档,可以离线导航和搜索:https://docs.python.org/2/download.html

(该链接指向最新版本2.x的文档,但您可以从该页面选择3.x及更早版本的2.x版本)

答案 8 :(得分:0)

您应该尝试ipython

  

object_name?会打印有关任何对象的各种详细信息,   包括docstrings,函数定义行(用于调用参数)   和类的构造函数详细信息。

魔术命令%pdoc,%pdef,%psource和%pfile将分别打印文档字符串,函数定义行,完整源代码和任何对象的完整文件(当它们可以找到时)。如果启用了automagic(默认情况下),则无需显式键入'%'。