Python文档等同于Perl" perldoc"

时间:2015-09-23 16:17:02

标签: python documentation pydoc

快速perldoc概述:

编写Perl模块时,您可以使用POD样式文档对其进行记录。然后,要了解模块的工作原理,您只需在命令行中输入:

perldoc <module_name>

如何使用Python执行此操作?

我知道Python有一种标准形式的代码使用&#34; docstrings&#34;这有点类似于Perl的POD风格。然后可以使用help()函数提取有关Python模块的信息,但这远非优雅

首先,您需要启动Python解释器,然后导入您想要获得帮助的模块,最后您可以使用help()函数获取有关模块的信息。

示例:

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

有更好的方法吗?

我想要一个与Perl工作方式相同的Python:

pydoc <module_name>

但是当我尝试这个时,我得到以下输出:

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

3 个答案:

答案 0 :(得分:5)

事实证明,pydoc确实可以像perldoc一样工作!

有了捕捉......你只需要输入一点点不同!

python -m pydoc <module_name>

并且有点“haquery”...... :)

创建一个pydoc.bat文件,如下所示。

pydoc.bat:

python -m pydoc %1

然后将此文件存储在“C:\ Python27”中(或与python.exe文件位于同一位置)

  

然后迅速挥动你的手在键盘上并惊呼“ SIM SALA BIM!

您的pydoc命令现在可以使用了!

pydoc <module_name>

答案 1 :(得分:0)

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

答案 2 :(得分:-1)

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

返回以下内容: int(x [,base]) - &gt;整数

如果可能,将字符串或数字转换为整数。一个浮点 参数将被截断为零(这不包括字符串 表示浮点数!)转换字符串时,请使用 可选的基础。转换a时提供基数是错误的 非字符串。如果base为零,则基于该算法猜测正确的基数 字符串内容。如果参数超出整数范围a 将返回长对象。