如何显示Python文件头描述

时间:2015-12-03 20:19:43

标签: python comments

我想知道你是否知道如何运行python文件只显示文件描述。 例如,我在python程序的顶部有这些行。

"""
===================================================
    test.py
    sphchow

    Description
====================================================
"""

我希望能够运行它以便显示它。但也有能力正常运行程序。我试着四处寻找,只能找到像__docstring__这样的信息,我想我没有使用正确的关键词?

1 个答案:

答案 0 :(得分:1)

假设您的模块为foo.py,那么您可以执行以下操作:

import foo
print(foo.__doc__)

这将打印模块的docstring

或从命令行:

python -c "import foo; print(foo.__doc__)"

如评论中所述,使用帮助命令时也会显示此信息:

help(foo)