Python module docstring

Question

How do I print the docstring of my python module file, from my main file? Let's say I have a python module file called Projectile.py, which defines a class inside it called Projectile. Then I have another python file called main.py. In main, I want to access the module level docstring. How do I do this?
I know how to print the docstring for the class and the methods. For example, to print the class level docstring from my main file, it would just be:

print(Projectile.__doc__)

Output:  This is the class docstring:  Simulates the flight of simple projectiles near the earth's surface, ignoring wind resistance. Tracking is done in two dimensions, height (y) and distance (x).

But how to print the module level docstring?? Thanks!

     """This is the module docstring"""
        from graphics import *
        from math import *

        class Projectile:
            """This is the class docstring:  Simulates the flight of simple projectiles near the earth's surface, 
               ignoring wind resistance. Tracking is done in two dimensions, height (y) and distance (x)."""

            # Constructor - TO INITIALIZE INSTANCE VARIABLES
            """This is the constructor docstring"""
            def __init__(self, angle, velocity, height):
                self.initialVelocity = velocity
                self.xpos = 0.0

jubnzv · Accepted Answer · 2020-04-10 13:29:37Z

2

You can get the docstring, using __doc__ field:

import x; print(x.__doc__)

Or use help function to get interactive help:

import x; help(x)

edited Apr 10, 2020 at 13:29

answered Apr 10, 2020 at 13:24

jubnzv

1,6142 gold badges11 silver badges23 bronze badges

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

5 Comments

Tad Over a year ago

This prints out all the info on my Projectile.py file, but doesn't print the docstring at the very top of the file/module. In my example, from my main.py file, I'm trying to print out the docstring """This is the module docstring""".

jubnzv Over a year ago

Got it. I extended my answer.

Tad Over a year ago

when I do print(Projectile.__doc__), it prints my class docstring, but not the module docstring. Is this because I'm naming my module the same as my class?

jubnzv Over a year ago

How do you import Projectile class? Don't use from Projectile import Projectile.

Tad Over a year ago

Duh! OMG that was it! Thank you!

Collectives™ on Stack Overflow

Python module docstring

1 Answer 1

5 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

5 Comments

Your Answer

Sign up or log in

Post as a guest

Related