Erben Sie Dokumentzeichenfolgen in der Python-Klassenvererbung

Ich versuche, eine Klassenvererbung in Python durchzuführen. Ich möchte, dass jede Klasse und jede geerbte Klasse gute Dokumentzeichenfolgen hat. Ich denke, für die geerbte Klasse möchte ich:

• erben Sie die Basisklasse docstring
• Fügen Sie möglicherweise relevante zusätzliche Dokumentation an die Dokumentzeichenfolge an

Gibt es eine (möglicherweise elegante oder pythonische) Möglichkeit, diese Art der Manipulation von Dokumentenstrings in einer Klassenvererbungssituation durchzuführen? Wie wäre es mit Mehrfachvererbung?

Du bist nicht der Einzige! comp.lang.pythonVor einiger Zeit gab es eine Diskussion darüber, und ein Rezept wurde erstellt. Schau es dir hier an .

"""
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 

Sie können die Dokumentzeichenfolgen einfach verketten:

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

Das ist jedoch nutzlos. Die meisten Tools zur Generierung von Dokumentationen ( einschließlich Sphinx und Epydoc ) ziehen bereits übergeordnete Dokumentzeichenfolgen, auch für Methoden. Sie müssen also nichts tun.

Nicht besonders elegant, aber einfach und direkt:

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

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

Jetzt:

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

Ein gemischter Stil, der sowohl die geerbte Docstring-Syntax als auch die bevorzugte Reihenfolge beibehalten kann, kann sein:

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

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

Mit der gleichen Ausgabe wie Alex:

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

Dünnes Eis: Wenn Sie mit Docstring spielen, kann Ihr Modul unbrauchbar werden python -OO. Erwarten Sie Folgendes :

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

Ich habe custom_inherit geschrieben , um einige einfache, leichte Tools für die Handhabung der Docstring-Vererbung bereitzustellen.

Es enthält auch einige nette Standardstile zum Zusammenführen verschiedener Arten von Dokumentzeichenfolgen (z. B. Numpy-, Google- und reST-formatierte Dokumentzeichenfolgen). Sie können auch ganz einfach Ihren eigenen Stil angeben.

Überlappende Docstring-Abschnitte werden auf den Abschnitt des Kindes verschoben, andernfalls werden sie mit einer schönen Formatierung zusammengeführt.