Pydoc 模块有什么作用？答案

【问题标题】：What does the Pydoc module do?Pydoc 模块有什么作用？
【发布时间】：2014-02-06 00:24:40
【问题描述】：

完全不熟悉编程和 python。在我正在学习的书中，作者建议我找出 Pydoc 的用途。

我对它进行了谷歌搜索，并找到了一个匹配项（来自 Gnome 终端），但这对我来说没有多大意义。有人介意简化一下吗？

【问题讨论】：

docs.python.org/2/library/pydoc.html
另见 Python 3 documentation。

标签： python terminal pydoc

【解决方案1】：

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

在您的 Windows 终端上使用它来了解 python 中的函数的作用：

python -m pydoc <function>

例如。

python -m pydoc raw_input

如果特定函数的文档很长，请使用 'q' 退出。

例如如果是

python -m pydoc Tkinter

【讨论】：

请注意，如果您不使用 Windows，pydoc <function> 通常就足够了。

【解决方案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 它会显示 cmets。

help(f2m)

查看这个的另一种方法是编写命令

python -m pydoc file1

另一种在 html 页面中查看 cmets 的方法是键入此命令并将其导出为 html

python -m pydoc -w <dir>

如果你有多个 python 文件，并且如果你想将 HTML 生成到单独的文件夹中，那么简单的 shell 命令就可以完成这项工作。下面的代码生成一个文件夹“htmldocs”，然后生成 html 并将它们移动到这个新文件夹。如果您在右上角打开任何一个，您可以看到索引选项，您可以通过该选项浏览其他页面。

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

【讨论】：

【解决方案3】：

它是帮助了解python程序的单词或组件的工具。即

>python -m pydoc input

了解“输入”在代码中的作用

【讨论】：

【解决方案4】：

只需在您通常运行 python 的终端中键入 pydoc。它将给出简单的解释！ :)

【讨论】：

这不能回答问题。请扩展您的答案。

【解决方案5】：

这是一个生成python风格文档的工具，见http://docs.python.org/2/library/pydoc.html

您可能也想看看 Sphinx。

【讨论】：

【解决方案6】：

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

【讨论】：

【解决方案7】：

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

对于模块、类、函数和方法，显示的文档源自对象的文档字符串（即 doc 属性），并递归地源自其可文档化的成员。如果没有文档字符串，pydoc 会尝试从源文件中类、函数或方法定义上方或模块顶部的注释行块中获取描述。

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

【讨论】：

【解决方案8】：

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

【讨论】：

【解决方案9】：

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

> python -m pydoc 'function'

例子：

> python -m pydoc open

关于在模块builtin中打开的内置函数的帮助：

打开（...） 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. <<<

希望有帮助！

【讨论】：

【解决方案10】：

pydoc 从文档字符串生成在线文档...

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

【讨论】：