python - doc dizesinde bir değişken nasıl bulunur?

Question

Cmd modülünü kullanıyorum. Böyle belgelemek istiyorum bir komut var:

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

muhakeme Sadece bir kez yasal değerlerin o listeyi yazı yazmak istediğiniz olmak. Dokunu daha sonra değiştirebileceğimi buldum, ama bence bu bir hack. Bunu yapmanın bir yolu var mı?

Answer 1

Dokümanı sonradan değiştirmek (do_this.__doc__'a atayarak) tek yoldur.

Veya daha güzel görünmesini isterseniz, bir dekoratör kullanabilirsiniz - ancak yine de do_this.__doc__'a atar. değişkene bu değerlere sahip olarak

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

, dokümanın kendisine başvurabilirsiniz: Hiçbir şey kaybetmemeniz için

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

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