Pydoc模块是什么？

Question

我对编程和Python都是新手。在我学习的书中，作者建议我了解Pydoc的用途。

我在谷歌上搜索了一下，找到了一个匹配项（来自Gnome终端），但我并不是很理解它的意思。有人能把它简单化吗？

- logan beaupre

---

http://docs.python.org/2/library/pydoc.html - Joran Beasley

还可以查看Python 3 文档。 - martineau

Answer 1

Pydoc是Python的帮助/文档模块。

在Windows终端上使用它可以了解Python中函数的作用：

python -m pydoc <function>

eg.

python -m pydoc raw_input

如果某个函数的文档非常长，可以使用'q'键退出。

例如，在

python -m pydoc Tkinter

- Kapil Marwaha

---

请注意，如果您没有使用Windows，则通常可以使用pydoc <function>。 - AstroFloyd

Answer 2

Python中的Pydoc模块可用于生成HTML页面或甚至在控制台上生成文档。

python -m pydoc 

这个命令提供了一些选项，如查看文件的pydoc、-k搜索不同的库、-p允许在Web浏览器中打开页面查看Python包、-g提供一个图形界面来查看文档、-w将输出写成HTML。以下是您可以用于测试的示例命令。

python -m pydoc yourpythonfile
python -m pydoc -k ftplib
python -m pydoc -p 314
python -m pydoc -w file

我已经在一个目录下创建了两个样本文件file1.py和file2.py，其中包含一行注释的简单代码。

def f2m(ft):
    """ Return the number of meters eq to feet """
    return 0.30 * ft

查看文件的注释的一种方法是在同一文件中直接写下面的代码，然后运行python file.py即可显示注释。

help(f2m)

另一种看待这个问题的方式是编写命令：

python -m pydoc file1

通过键入此命令并导出到HTML，可以查看HTML页面中的注释的另一种方法：

python -m pydoc -w <dir>

如果您有多个Python文件，并且想将HTML生成到单独的文件夹中，则可以使用简单的Shell命令来完成此任务。下面的代码会生成一个名为“htmldocs”的文件夹，然后生成HTML并将它们移动到这个新文件夹中。如果您打开其中任何一个文件，在右上角可以看到索引选项，通过它您可以浏览其他页面。

mkdir -p htmldocs
pydoc -w `find . -name '*.py'`
mv *.html htmldocs

- Nitish Sharma

Answer 3

这是一个用于生成类似Python风格文档的工具，详情请见http://docs.python.org/2/library/pydoc.html

您也可以看看Sphinx。

- Eric B.

Answer 4

Pydoc是Python的文档生成系统。你可以使用Pydoc标准记录你的函数，然后它可以用于在你的代码中生成文档。

- pampasman

Answer 5

pydoc模块可以自动生成Python模块的文档。文档可以在控制台上呈现为文本页面，提供给Web浏览器或保存为HTML文件。

对于模块、类、函数和方法，显示的文档来源于对象的docstring（即doc属性），以及其可文档化成员的递归。如果没有docstring，则pydoc尝试从源文件中类、函数或方法定义上方的注释块中获取描述，或者在模块顶部获取描述。

有关各个Python版本的更多信息，请参见 - Python 2.7 - Python 3.5 - Python 3.6

- Anilkumar

Answer 6

这是一种工具，可帮助了解Python程序中的单词或组件。 例如：

>python -m pydoc input

了解在代码中 "input" 的作用。

- prabhu

Answer 7

pydoc可以从docstrings生成在线文档...

例如，您可以看到Numpy.histograms()函数的在线文档实际上是基于该函数的docstring创建的...

- AvinashBolleddula

Answer 8

作为一个Python学习者，我可以用最简单的方式来描述pydoc，它是一个用于了解不同命令的命令。其语法如下：

> python -m pydoc 'function'

例子：

> python -m pydoc open

在模块builtin中的内置函数open的帮助信息：

open(...) open(name[, mode[, buffering]]) -> 文件对象

Open a file using the file() type, returns a file object.  This is the
preferred way to open a file.  See file.__doc__ for further information. <<<

希望这能有所帮助！

- RoiMinuit

Answer 9

维基百科提供的简明描述如下： “Pydoc允许Python程序员访问Python的文档帮助文件，生成具有文档特定信息的文本和HTML页面，并为特定工作找到适当的模块。”

- Nigel

Answer 10

在通常运行Python的终端中，只需键入pydoc即可。它会给出简单说明！：）

- Ssaa918

---

这并没有回答问题。请详细阐述你的答案。 - Robert