Python文档中类似于Perl的“perldoc”的等效工具是什么？

Question

快速 perldoc 概述：

编写 Perl 模块时，您可以使用 POD 风格的文档进行记录。然后，要获取模块工作方式的概述，只需在命令行中键入以下内容：

perldoc <module_name>

---

如何用Python实现这个？

我知道Python有一种标准的代码文档方式，使用“docstrings”，与Perl的POD风格有些相似。可以使用help()函数提取有关Python模块的信息，但这远非优雅。

首先需要启动Python解释器，然后导入要获取帮助的模块，最后才能使用help()函数获取有关该模块的信息。

例如：

>python
# Prints Python version info
>>>import <module_name>
>>>help(<module_name>)
# Prints documentation!

---

有更好的方法吗？

我希望能够找到 Python 中类似于 Perl 的以下方式：

pydoc <module_name>

但是当我尝试这样做时，输出结果如下：

'pydoc' is not recognized as an internal or external command,
operable program or batch file.

- tjwrona1992

---

pydoc是要使用的命令。如果缺少该命令，则可能存在Python安装问题。 - chepner

那么你的意思是它应该像 perldoc 一样工作？ - tjwrona1992

本质上，它们都从请求的对象中提取文档（pydoc通过定义和文档字符串，perldoc通过嵌入的pod文档）。 - chepner

Example: pydoc3 pathlib.Path - Alexey Shrub

Answer 1

原来，pydoc的使用方式与perldoc类似！

不过有一点需要注意，你只需要稍微修改一下命令！

python -m pydoc <module_name>

---

再加上一点"魔法"... :)

按照以下示例创建一个pydoc.bat文件。

pydoc.bat:

python -m pydoc %1

将此文件存储在"C:\Python27"（或与您的python.exe文件相同的位置）

然后迅速地在键盘上挥舞双手，大喊“SIM SALA BIM！”

现在您的pydoc命令将会工作！

pydoc <module_name>

- tjwrona1992

Answer 2

安装并使用IPython。它允许您键入<object>?并获取有关该对象的信息。您还可以键入.+TAB以获取对象的属性。IPython有许多更棒的功能，我强烈建议您去了解一下。

- nathanielobrown

Answer 3

Python文档字符串存储在doc变量中。您可以查看该变量以获取信息： print(int().__doc__)

返回以下内容： int(x[, base]) -> integer

将字符串或数字转换为整数（如果可能）。浮点参数将向零截断（这不包括浮点数的字符串表示！）当转换字符串时，请使用可选基数。在转换非字符串时提供基数是错误的。如果基数为零，则根据字符串内容猜测正确的基数。如果参数超出整数范围，则返回长整型对象。

- Brian Cain

---

我理解这一点，但这仍然不够美观或高效。你仍然需要在Python解释器内部使用它，而且对于不熟悉Python的人来说，格式非常难看。我想要的是，我可以告诉一个从未使用过Python的用户在Windows命令提示符中键入某些内容，并让它向他们提供有关如何使用所需模块的文档。perldoc对于Perl做得非常好。 - tjwrona1992