问题标签 [pydoc]

我什至不确定这些东西的正式名称，不过，Python 有元数据，通常位于模块文件的顶部，例如__version__ = '0.1'.

如何找到 PyDoc 支持的所有列表？

我试图确保help()在 Python 2.7 REPL 上运行会显示__doc__用functools.partial. 当前help()在functools.partial“函数”上运行显示__doc__类的functools.partial，而不是我的包装函数的__doc__。有没有办法做到这一点？

考虑以下可调用对象：

运行help(foo)将导致显示foo.__doc__。但是，运行会help(partial_foo)导致Partial object。__doc__

我的第一种方法是使用functools.update_wrapper正确替换部分对象__doc__的foo.__doc__. 但是，由于pydoc的方式，这并不能解决“问题” 。

我已经调查了 pydoc 代码，问题似乎是它partial_foo实际上是一个Partial 对象而不是典型的函数/可调用对象，有关该详细信息的更多信息，请参阅此问题。

默认情况下，如果通过inspect.isclass__doc__确定传递的对象是类，pydoc 将显示对象类型，而不是实例。有关代码本身的更多信息，请参见render_doc 函数。

所以，在我上面的场景中，pydoc 显示的是类型的帮助，而functools.partial不是__doc__我的functools.partial实例的帮助。

无论如何要更改我的调用help()或functools.partial传递给的实例，help()以便它显示__doc__实例的，而不是类型？

Is there a resource that provides quick/easy access to methods and their pydoc's for standard library classes?

E.g. I want to see what are the methods available on the Match class and the associated pydoc descriptions. Starting pydoc -p 8888 is partially helpful .. but does not address this usecase.

Thanks.

我创建了我的第一个包，我注意到用户调用时显示的文档help(my_package)不完整。我会很高兴在调用help(). 理想情况下，来自docstrings 的功能描述。

阅读pydoc文档，我仍然不知道该怎么做，因为那里提供的信息有点稀疏。

当我理解正确时，help()当用户调用此函数时会自动创建“输出”？还是我必须提供并指定一些额外的东西？

help()目前，当我调用我的包（这里：pdbsr）时，它看起来像这样：

当我调用子模块时，例如 pdbsr.exceptions：

这是我当前文件夹结构的概述：

我的设置文件目前看起来像这样：

这是我最上面的__init__.py文件的内容：

我在脚本中使用argparse.ArgumentParser()，我想将脚本的 pydoc 描述显示为 argparse 的“--help”选项的一部分。

一种可能的解决方案是使用 ArgumentParser 的formatter_class或description属性来配置帮助的显示。但在这种情况下，我们需要在内部使用“pydoc”命令来获取描述。

我们还有其他方法（可能很优雅）吗？

我正在决定是否使用 Sphinx 或 Pydoc 来记录现有的大型项目。我应该选择哪一个？哪一个在给定条件下表现更好？哪个更快地配置项目运行？

我正在寻找一种方法来生成文档，在这种情况下为 pydoc，用于嵌套函数。pydoc可以做到这一点吗？是否可以使用其他工具？

例如：

使用以下命令生成 pydoc： pydoc -w -filename- 将为模块和 foo() 生成 pydoc，但不会为 bar() 生成 pydoc。

通常这样就可以了；问题是我正在尝试建立一个用于教育目的的图书馆，并且记录闭包内发生的事情特别有用。我想找到一种方法来记录它，而不必将内部函数暴露给全局范围。

我正在尝试在运行时生成帮助文本，但无法在 Windows 中使用 pydoc 命令。当我输入

我已经为pydoc.py文件设置了环境变量。C:\Python33\Lib\pydoc.py.

这也不适用于>>help('atexit')

可能的原因是什么。

更新：

我相信我刚刚安装了 pip、nose、distribute 和 virtualenv。我想检查并在终端中运行 pydoc 模块以查看其中的内容-它们都没有出现。我错过了什么吗？这些模块是否应该出现。终端输出如下（Mac，Python 2.7）。

要安装这些模块，我首先使用sudo easy_install pip. 然后，我做了以下事情：

一切似乎都“工作” - 终端下载了一些东西并打印了一些我认为暗示它工作的输出（我无法返回并复制/粘贴输出，因为我关闭了该终端窗口并重新打开，希望我新安装的模块可能会出现）

如何判断我是否已成功安装这些模块？我有没有？