是否有可能拥有“动态”帮助文本?

时间:2018-03-05 14:53:47

标签: python function

我可以提供这样的帮助文本:

def my_func(): 
    "help text"

这样help(my_func)将打印help text

是否可以从全局变量构造帮助字符串?

例如:

test = "123"

def my_func():
     "help text" + test

不会为help(my_func)

打印任何内容

1 个答案:

答案 0 :(得分:9)

您可以覆盖__doc__属性

test = "123"

def my_func():
    pass

my_func.__doc__ = "help text" + test

来自PEP-0257

  

docstring是一个字符串文字,作为模块,函数,类或方法定义中的第一个语句出现。这样的文档字符串成为该对象的__doc__特殊属性。