来自基类参数的成员文档字符串

编程问答 2022-08-15

问题描述

我有一个Python（抽象）基类，它提供了一些方法，这些方法可以由基类通过设置类字段进行修改。如果没有一个非常人为的例子，很难想到一个简单的例子，但这是这样的：

class Base():
    _name_ = 'the base class'

    def foo(self):
        print('Doing something in {}'.format(self._name_))

class Derived(Base):
    _name_ = 'a derived class'

我希望派生类的foo方法具有一个可以准确描述其功能的文档字符串。因此理想情况下，基类应如下所示：

class Base():
    _name_ = 'the base class'

    def foo(self):
        'Do someting in {}'.format(_name_)
        print('Doing something in {}'.format(self._name_))

这当然行不通；但是有人可以建议实现这一目标的方法吗？

如果您对上下文感兴趣，这是一个Flask应用程序，其中基类提供在ORM类上运行的视图方法（get，put，post等）在派生类中指定的内容。然后，会自动从文档字符串中收集api文档，并将其显示为swagger JSON。因此，除非我可以在文档字符串中找到一些明智的方法，否则这些方法将没有有用的草率文档。

我可以找到很多试图做相反的事情的人-重写基类的方法但继承文档字符串-但不是那些试图继承方法但重写docstring的人。

解决方法

暂无找到可以解决该程序问题的有效方法，小编努力寻找整理中！

如果你已经找到好的解决方法，欢迎将解决方案带上本链接一起发送给小编。

小编邮箱:dio#foxmail.com (将#修改为@）

docstringinheritancepythonpython-3.6