Hériter des docstrings dans l'héritage des classes Python

Question

J'essaie de faire de l'héritage de classe en Python. J'aimerais que chaque classe et classe héritée ait une bonne documentation. Donc je pense que pour la classe héritée, je voudrais qu'elle.. :

• hériter de la docstring de la classe de base
• peut-être ajouter une documentation supplémentaire pertinente à la docstring

Existe-t-il un moyen (éventuellement élégant ou pythonique) de faire ce genre de manipulation de la docstring dans une situation d'héritage de classe ? Et pour l'héritage multiple ?

Answer 1

Vous n'êtes pas le seul ! Il y a eu une discussion sur comp.lang.python à ce sujet il y a quelque temps, et une recette a été créée. Consultez-la aquí .

"""
doc_inherit decorator

Usage:

class Foo(object):
    def foo(self):
        "Frobber"
        pass

class Bar(Foo):
    @doc_inherit
    def foo(self):
        pass 

Now, Bar.foo.__doc__ == Bar().foo.__doc__ == Foo.foo.__doc__ == "Frobber"
"""

from functools import wraps

class DocInherit(object):
    """
    Docstring inheriting method descriptor

    The class itself is also used as a decorator
    """

    def __init__(self, mthd):
        self.mthd = mthd
        self.name = mthd.__name__

    def __get__(self, obj, cls):
        if obj:
            return self.get_with_inst(obj, cls)
        else:
            return self.get_no_inst(cls)

    def get_with_inst(self, obj, cls):

        overridden = getattr(super(cls, obj), self.name, None)

        @wraps(self.mthd, assigned=('__name__','__module__'))
        def f(*args, **kwargs):
            return self.mthd(obj, *args, **kwargs)

        return self.use_parent_doc(f, overridden)

    def get_no_inst(self, cls):

        for parent in cls.__mro__[1:]:
            overridden = getattr(parent, self.name, None)
            if overridden: break

        @wraps(self.mthd, assigned=('__name__','__module__'))
        def f(*args, **kwargs):
            return self.mthd(*args, **kwargs)

        return self.use_parent_doc(f, overridden)

    def use_parent_doc(self, func, source):
        if source is None:
            raise NameError, ("Can't find '%s' in parents"%self.name)
        func.__doc__ = source.__doc__
        return func

doc_inherit = DocInherit

Answer 2

Vous pouvez concaténer les docstrings facilement :

class Foo(object):
    """
    Foo Class.
    This class foos around.
    """
    pass

class Bar(Foo):
    """
    Bar class, children of Foo
    Use this when you want to Bar around.
    parent:
    """ 
    __doc__ += Foo.__doc__
    pass

Cependant, cela ne sert à rien. La plupart des outils de génération de documentation ( Sphinx y Epydoc inclus) tirera déjà la docstring parent, y compris pour les méthodes. Vous n'avez donc rien à faire.

Answer 3

Pas particulièrement élégant, mais simple et direct :

class X(object):
  """This class has a method foo()."""
  def foo(): pass

class Y(X):
  __doc__ = X.__doc__ + ' Also bar().'
  def bar(): pass

Maintenant :

>>> print Y.__doc__
This class has a method foo(). Also bar().

Answer 4

Un stile mixte qui peut préserver à la fois la syntaxe de la docstring héritée et l'ordre préféré peut être :

class X(object):
  """This class has a method foo()."""
  def foo(): pass

class Y(X):
  """ Also bar()."""
  __doc__ = X.__doc__ + __doc__
  def bar(): pass

Avec la même sortie que celle d'Alex :

>>> print Y.__doc__
This class has a method foo(). Also bar().

De la glace fine : jouer avec la docstring peut rendre votre module inutilisable avec python -OO attendez-vous à en voir :

TypeError: cannot concatenate 'str' and 'NoneType' objects

Answer 5

J'ai écrit Héritage personnalisé pour fournir des outils simples et légers pour gérer l'héritage des chaînes de documents.

Il est également livré avec quelques styles par défaut pour fusionner différents types de docstrings (par exemple, les docstrings formatés Numpy, Google et reST). Vous pouvez également fournir votre propre style très facilement.

Les sections de la docstring qui se chevauchent sont reportées à la section de l'enfant, sinon elles sont fusionnées avec un formatage agréable.