web-dev-qa-db-ja.com

Pythonクラス継承のdocstringsを継承

Pythonでクラスを継承しようとしています。各クラスと継承クラスに適切なdocstringを持たせたい。だから、継承されたクラスについては、次のようにしたいと思います：

  • 基本クラスのdocstringを継承します
  • おそらく関連する追加のドキュメントをdocstringに追加する

クラス継承の状況でこの種のdocstring操作を行う（おそらくエレガントまたはPythonの）方法はありますか？多重継承はどうですか？

pythoninheritancedocumentation
85
Craig McQueen

あなただけではありません！しばらく前にこれについてcomp.lang.pythonで議論があり、レシピが作成されました。チェックしてくださいここ。

"""
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
36
John Feminella

Docstringを簡単に連結できます：

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

しかし、それは無意味です。ほとんどのドキュメント生成ツール（ Sphinx および Epydoc が含まれます）は、メソッドを含め、すでに親docstringをプルします。したがって、何もする必要はありません。

33
nosklo

特にエレガントではありませんが、シンプルで直接的です：

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

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

今：

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

継承されたdocstring構文と優先順序の両方を保持できる混合スタイルは、次のとおりです。

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

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

アレックスのものと同じ出力で：

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

シンアイス： docstringで遊ぶと、モジュールがpython -OO、いくつかの期待：

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

custom_inherit を作成して、docstringの継承を処理するためのシンプルで軽量なツールを提供しました。

また、さまざまな種類のdocstring（たとえば、Numpy、Google、およびreST形式のdocstring）をマージするためのいくつかのNiceデフォルトスタイルが付属しています。独自のスタイルを非常に簡単に提供することもできます。

重複するdocstringセクションは、子のセクションに従います。それ以外の場合は、ニースの書式設定とマージされます。

1
Ryan Soklaski