python - 如何在文档字符串中包含变量?

2023-12-04

我正在使用 cmd 模块。我想记录一个命令,如下所示:

def do_this(self,arg)
    "this command accepts these values {values}".format(values="legal values")

原因是我只想输入该合法值列表一次。我发现我可以稍后更改文档字符串,但我认为这是一个黑客行为。有没有办法做到这一点?


之后更改文档字符串(通过分配给do_this.__doc__)是唯一的方法。

或者如果你想让它看起来更好,你可以使用装饰器 - 但它仍然分配给do_this.__doc__.

def doc(docstring):
    def document(func):
        func.__doc__ = docstring
        return func

    return document

@doc("this command accepts these values: {values}".format(values=[1, 2, 3])
def do_this(self, arg):
    pass
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)

python - 如何在文档字符串中包含变量? 的相关文章

随机推荐