6

我从来自 java 的 Python 开始。

我想知道是否存在类似于 JavaDoc API 的东西,我可以在其中找到类、它的方法以及如何使用它的示例。

我发现从 Python(命令行)中使用help(thing)非常有帮助

我也发现了这个:

http://docs.python.org/2/

https://docs.python.org/2/py-modindex.html

但是,当您已经拥有要查找的类名时,它似乎会有所帮助。在 JavaDoc API 中,我有所有的类,所以如果我需要一些东西,我会向下滚动到一个“听起来像”我需要的类。或者有时我只是浏览所有类以查看它们的作用,当我需要一个功能时,我的大脑会想起我 我们在 javadoc 中看到过类似的东西记得!?

但我似乎没有在 Python 中找到类似的东西(尚未),这就是我发布这个 questin 的原因。

顺便说一句,我知道我最终会读到这个:

https://docs.python.org/2/library/

但是,好吧,我认为不是今天。

4

9 回答 9

5

pydoc ?

我不确定您是否正在寻找更复杂的东西,但它确实有用。

于 2008-09-25T23:00:48.243 回答
2

标准的 python 库有很好的文档记录。尝试跳入 python 并导入一个模块说“os”并运行:

import os   
help(os)

这会读取模块中每个项目的文档字符串并显示它。这也正是 pydoc 会做的。

编辑:epydoc可能正是您正在寻找的:

于 2008-09-25T23:11:13.820 回答
1

是 Python 中所有模块的列表,不确定这是否是您真正想要的。

于 2008-09-25T23:03:33.307 回答
1

我从 Python.org 下载了 Python 2.5,它不包含 pydoc。

Directorio de C:\Python25

9/23/2008  10:45 PM    <DIR>          .
9/23/2008  10:45 PM    <DIR>          ..
9/23/2008  10:45 PM    <DIR>          DLLs
9/23/2008  10:45 PM    <DIR>          Doc
9/23/2008  10:45 PM    <DIR>          include
9/25/2008  06:34 PM    <DIR>          Lib
9/23/2008  10:45 PM    <DIR>          libs
2/21/2008  01:05 PM            14,013 LICENSE.txt
2/21/2008  01:05 PM           119,048 NEWS.txt
2/21/2008  01:11 PM            24,064 python.exe
2/21/2008  01:12 PM            24,576 pythonw.exe
2/21/2008  01:05 PM            56,354 README.txt
9/23/2008  10:45 PM    <DIR>          tcl
9/23/2008  10:45 PM    <DIR>          Tools
2/21/2008  01:11 PM             4,608 w9xpopen.exe
          6 archivos        242,663 bytes

但它有(我猜的替代品)pydocgui ......

C:\Python25>dir Tools\Scripts\pydocgui.pyw

10/28/2005  07:06 PM               222 pydocgui.pyw
           1 archivos            222 bytes

这将启动一个网络服务器并显示我正在寻找的内容。所有模块以及平台附带的所有类。

Doc 目录包含与以下内容相同的内容:

http://docs.python.org/

非常感谢您指导我使用 pydoc。

于 2008-09-25T23:42:37.567 回答
1

顺便说一句,我知道我最终会读到这个:

http://docs.python.org/lib/lib.html

但是,好吧,我认为不是今天。

我建议你犯了一个错误。lib doc 包含“类、它的方法以及如何使用它的示例”。这就是你要找的东西。

我一直都在使用 Java 和 Python。深入了解图书馆文档,您会找到所需的一切。

于 2008-09-26T01:56:12.270 回答
1

您可以将环境变量 PYTHONDOCS设置为指向 python 文档的安装位置。

在我的系统上,它位于/usr/share/doc/python2.5

因此,您可以在shell 配置文件或其他地方定义此变量,具体取决于您的系统:

导出 PYTHONDOCS=/usr/share/doc/python2.5

现在,如果你打开一个交互式 python 控制台,你可以调用帮助系统。举个例子:

>>> help(Exception)
>>> Help on class Exception in module exceptions:

>>> class Exception(BaseException)
>>>  |  Common base class for all non-exit exceptions.
>>>  |  
>>>  |  Method resolution order:
>>>  |      Exception

文档在这里:

https://docs.python.org/library/pydoc.html

于 2008-09-26T08:07:29.600 回答
0

如果您使用的是 Windows ActiveState,Python附带文档,包括可搜索帮助文件中的库参考。

于 2008-09-25T23:04:21.077 回答
0

它不会直接回答您的问题(因此我可能会被降级),但您可能对Jython感兴趣。

Jython 是用 100% 纯 Java 编写的高级、动态、面向对象的 Python 语言的实现,并与 Java 平台无缝集成。因此,它允许您在任何 Java 平台上运行 Python。

由于您来自 Java,Jython 可以帮助您利用 Python,同时仍然允许您使用您的 Java 知识。

于 2008-09-26T07:16:09.647 回答
0

也试试

pydoc -p 11111

然后在浏览器中输入http://localhost:11111

编辑:当然,您可以使用任何其他值作为端口号,而不是 11111

于 2008-09-26T08:34:18.490 回答