禁止子类文档字符串中的"Methods inherited by base class"



我正在子类化一个具有大量方法和长文档字符串的类。如果我调用 IPython 帮助函数,我会看到原始类的所有帮助。 我想这是意料之中的,有没有办法抑制这一点?我只想看到我重新定义的方法。

mymodule.py是:

import matplotlib.axes
class MySubclass(matplotlib.axes.Axes):
pass

如果我在IPython中这样做:

import mymodule
help(mymodule)

打印输出很大,因为它包含所有"从matplotlib.axes._axes继承的方法。Axes:"是兆字节的文本,因为它列出了类的所有方法的文档字符串。

如此处所述,一个可能的工作解决方案是手动删除文档

## List the methods from the original class
method_list = [func for func in dir(mymodule.MySubclass) if  
callable(getattr(mymodule.MySubclass, func))]
## Remove doc for methods
for func in method_list:
## Change only original user defined methods
if ("_" not in el[0:2]):
original_method = getattr(mymodule.MySubclass, func)
setattr(original_method, "__doc__", "")
else:
pass

这可以很容易地封装在装饰器中,并在实例化子类或导入模块时调用。

我能想到的唯一方法是,如果您在子类中制作基类中定义的所有函数,并在其中创建自己的文档字符串,那么它们可以被覆盖。您甚至可以留下空白的文档字符串,无论您喜欢什么,但这是非常不切实际的。

相关内容

最新更新