python - как включить переменную в строку doc?

Question

Я использую модуль cmd. есть команда, которую я хотел бы, чтобы документ, как это:

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

аргументации быть, я хотел бы ввести этот список допустимых значений только один раз. Я обнаружил, что позже могу изменить документацию, но я думаю, что это взломать. Есть ли способ сделать это?

Answer 1

Изменение значения docstring после этого (путем присвоения 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 

Answer 2

Как у вас есть эти значения в переменной, вы можете ссылаться на него в документ:

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

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