Python, documentation strings within classes

Question

How do I print documentation strings within classes

For functions i can do this:

def func():  
    """
     doc string
    """


print func.__doc__

Is it possible to do the same thing with a class

class MyClass(object):

    def __init__(self):
        """
        doc string
        """

i = MyClass()  
print i.__doc__

This doesn't work. It only prints out None.
Am writing a text game and I want to use the doc string as an instruction to the player without using the print command

Thanks

miku · Accepted Answer · 2011-01-21 02:44:34Z

10

It's None because the class does not have a docstring. Try adding one:

class MyClass(object):
    """ Documentation for MyClass goes here. """

    def __init__(self):
        """
        doc string
        """

i = MyClass()  
print i.__doc__ # same as MyClass.__doc__

edited Jan 21, 2011 at 2:44

answered Jan 21, 2011 at 2:29

miku

189k47 gold badges314 silver badges317 bronze badges

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

1 Comment

kassold Over a year ago

Ok. so the doc strings goes directly into the class and not inside the init func. Thank you

Mark Tolonen · Accepted Answer · 2011-01-21 02:37:47Z

3

You defined a doc string for the method MyClass.__init__ not MyClass:

print i.__init__.__doc__

Put the doc string for the class after the class declaration:

class MyClass(object):
    ''' MyClass ... '''

And there is always:

help(i)

To get the class and method doc strings in a single document.

answered Jan 21, 2011 at 2:37

Mark Tolonen

181k26 gold badges182 silver badges278 bronze badges

Collectives™ on Stack Overflow

Python, documentation strings within classes

2 Answers 2

1 Comment

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

1 Comment

Comments

Your Answer

Sign up or log in

Post as a guest

Related