python - 如何在doc字符串中包含变量？

Question

我正在使用cmd模块。有一个命令，我想这样记录：

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

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

Answer 1

之后更改文档字符串（通过分配到weblogic）是唯一的方法。

或者，如果您希望它看起来更漂亮，您可以使用装饰器 - 但它仍然分配给do_this.__doc__。

do_this.__doc__

Answer 2

由于您在变量中有此值，因此可以在doc：

中引用它

# mymodule.py
legal_values = {'one', 'two', 'three'}

def do_this(self,arg)
    """this command accepts these values: see `mymodule.legal_values`"""