Account Options

  1. Sign in
The old Google Groups will be going away soon, but your browser is incompatible with the new version.
Google Groups Home
« Groups Home
comp.lang.python
+ new post
About this group
Subscribe to this group
This is a Usenet group - learn more
Message from discussion Override a method but inherit the docstring
The group you are posting to is a Usenet group. Messages posted to this group will make your email address visible to anyone on the Internet.
Your reply message has not been sent.
Your post was successful
 
From:
To:
Cc:
Followup To:
Add Cc | Add Followup-to | Edit Subject
Subject:
Validation:
For verification purposes please type the characters you see in the picture below or the numbers you hear by clicking the accessibility icon. Listen and type the numbers you hear
 
Jean-Paul Calderone  
View profile  
 More options Jul 16 2009, 9:13 pm
Newsgroups: comp.lang.python
From: Jean-Paul Calderone <exar...@divmod.com>
Date: Thu, 16 Jul 2009 21:13:34 -0400
Local: Thurs, Jul 16 2009 9:13 pm
Subject: Re: Override a method but inherit the docstring
Print | View thread | Show original | Report this message | Find messages by this author

On Fri, 17 Jul 2009 11:01:49 +1000, Ben Finney <ben+pyt...@benfinney.id.au> wrote:
>Howdy all,

>The following is a common idiom::

>    class FooGonk(object):
>        def frobnicate(self):
>            """ Frobnicate this gonk. """
>            basic_implementation(self.wobble)

>    class BarGonk(FooGonk):
>        def frobnicate(self):
>            special_implementation(self.warble)

>The docstring for ‘FooGonk.frobnicate’ is, intentionally, perfectly
>applicable to the ‘BarGonk.frobnicate’ method also. Yet in overriding
>the method, the original docstring is not associated with it.

>Ideally there would be a way to specify that the docstring should be
>inherited. The best I can come up with is::

>    class BarGonk(FooGonk):
>        def frobnicate(self):
>            special_implementation(self.warble)
>        frobnicate.__doc__ = FooGonk.frobnicate.__doc__

>but that violates DRY (the association between BarGonk and FooGonk is
>being repeated), puts the docstring assignment awkwardly after the end
>of the method instead of at the beginning where docstrings normally go,
>and reads poorly besides.

>What is the most Pythonic, DRY-adherent, and preferably least-ugly
>approach to override a method, but have the same docstring on both
>methods?

How about this?

    class BarGonk(FooGonk):
        @inherit_docstring
        def frobnicate(self):
            special_implementation(self.warble)

The implementation of "inherit_docstring" is left as an exercise for the
reader (it's not utterly trivial, I admit, as "FooGonk" will not readily
be at hand, but it is still possible).

By the way, I don't think this is a particularly good idea.  Presumably
there is a reason your implementation is special.  It would probably be
better if this were reflected in the docstring somehow.  Perhaps this
idea is a better one:

    class BarGonk(FooGonk):
        @append_to_docstring
        def frobnicate(self):
            """
            This implementation takes the warble into consideration.
            """
            special_implementation(self.warble)

With the result of BarGonk.frobnicate.__doc__ being set to:

     Frobnicate this gonk.

     This implementation takes the warble into consideration.

Jean-Paul


 
You must Sign in before you can post messages.
To post a message you must first join this group.
Please update your nickname on the subscription settings page before posting.
You do not have the permission required to post.
Create a group - Google Groups - Google Home - Terms of Service - Privacy Policy
©2012 Google