How to display Python file header description

Question

I was wondering if you knew how to run a python file to only display the file description. For example I have these lines on the top of my python program.

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

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

I want to be able to run it so it displays this. But also have the ability to run the program normally. I tried searching around and could only find information like __docstring__ I think I'm not using the right key words?

__docstring__ is the name of the lines at the top of the program. — Riet
– Riet, Commented Dec 3, 2015 at 20:28

shuttle87 · Accepted Answer · 2015-12-03 20:31:27Z

1

Say your module is foo.py then you can do:

import foo
print(foo.__doc__)

This will print the docstring for the module.

Or from the command line:

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

As mentioned in the comments, this information is also displayed when you use the help command:

help(foo)

edited Dec 3, 2015 at 20:31

answered Dec 3, 2015 at 20:26

shuttle87

16.1k12 gold badges80 silver badges107 bronze badges

Sign up to request clarification or add additional context in comments.

2 Comments

Riet Over a year ago

You can also access it through import foo; help(foo), which will give you other information as well.

sphchow Over a year ago

Thanks guys, this was exactly what I was looking for

Collectives™ on Stack Overflow

How to display Python file header description

1 Answer 1

2 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

2 Comments

Your Answer

Sign up or log in

Post as a guest

Related