python - Pydoc 模块有什么作用？

Question

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

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

score 14 · Accepted Answer

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

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

python -m pydoc <function>

例如。

python -m pydoc raw_input

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

例如，在

python -m pydoc Tkinter

score 6 · Accepted Answer

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

您可能也想看看 Sphinx。

score 5 · Accepted Answer

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

score 3 · Accepted Answer

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

score 1 · Accepted Answer

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

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

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

score 1 · Accepted Answer

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

>python -m pydoc input

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

score 0 · Accepted Answer

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

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

score 0 · Accepted Answer

0

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

于 2018-05-11T15:57:27.793 回答

score 0 · Accepted Answer

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

> python -m pydoc 'function'

例子：

> python -m pydoc 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. <<<

希望有帮助！

score -1 · Accepted Answer

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

10 回答 10