栏目分类:
子分类:
返回
名师互学网用户登录
快速导航关闭
当前搜索
当前分类
子分类
实用工具
热门搜索
名师互学网 > IT > 面试经验 > 面试问答

Sphinx-从父方法插入参数文档

面试问答 更新时间: 发布时间: IT归档 最新发布 模块sitemap 名妆网 法律咨询 聚返吧 英语巴士网 伯小乐 网商动力

Sphinx-从父方法插入参数文档

可能不太理想,但也许您可以使用装饰器来扩展文档字符串。例如:

class extend_docstring:    def __init__(self, method):        self.doc = method.__doc__    def __call__(self, function):        if self.doc is not None: doc = function.__doc__ function.__doc__ = self.doc if doc is not None:     function.__doc__ += doc        return functionclass baseClass:    def mymethod(myargument):        """This does something        Params        ------        myargument : int Description of the argument        """        [...]class MyClass1(baseClass):    @extend_docstring(baseClass.mymethod)    def mymethod(myargument):        baseClass.mymethod(myargument)        [...]class MyClass2(baseClass):    @extend_docstring(MyClass1.mymethod)    def mymethod(myargument, argument2):        """argument2 : int Description of the additional argument        """        baseClass.mymethod(argument)        [...]print('---baseClass.mymethod---')print(baseClass.mymethod.__doc__)print('---MyClass1.mymethod---')print(MyClass1.mymethod.__doc__)print('---MyClass2.mymethod---')print(MyClass2.mymethod.__doc__)

结果:

---baseClass.mymethod---This does something        Params        ------        myargument : int Description of the argument---MyClass1.mymethod---This does something        Params        ------        myargument : int Description of the argument---MyClass2.mymethod---This does something        Params        ------        myargument : int Description of the argument        argument2 : int Description of the additional argument

如果将装饰器作为描述符并搜索到该覆盖器,则可以动态解析覆盖方法,

__get__
但这意味着装饰器不再可堆叠,因为它不返回实函数。



转载请注明:文章转载自 www.mshxw.com
本文地址:https://www.mshxw.com/it/611370.html
我们一直用心在做
关于我们 文章归档 网站地图 联系我们

版权所有 (c)2021-2022 MSHXW.COM

ICP备案号:晋ICP备2021003244-6号