python - 为模块中的每个函数创建帮助热线

Question

我制作了几个 python 文件，其功能如下:

def func(a,b,c):
   return a+b+c

这些函数通常更复杂，但它们的总体思路都是相同的，接收几个预定的参数，并返回所需的值。

现在，我想制作一个单独的 GUI 文件，以便于使用所有功能。 GUI 导入所有不同的 python 脚本，并通过文本输入字段我希望能够为每个函数提供所需的参数。问题是这些函数在它们期望的参数类型方面差异很大，所以我想让每个函数都能够向 GUI 返回一个帮助字符串，并简要说明该函数需要运行什么。在 GUI 文件中，我使用 getattr 来保存所需的函数:

methodtocall = getattr(Nuclear, func)

然后我可以使用为文本字段获得的参数调用该函数，例如:

methodtocall(textfield1.get(),textfield2.get())

正如我上面所说，问题是为了使 GUI 有用，我需要在选择功能时将帮助语句打印到 GUI。我尝试对函数本身进行调整，例如:

def func(a,b,c):
    help = "give a as string, b as list, c as integer"
    if no_parameters:
        return help
    else:
        return desired_value

问题是 methodtocall 函数给出了 TypeError，因为我尝试在没有任何参数的情况下启动它:methodtocall()

解决方案是在我在 GUI 中选择所需函数时调用该函数，并检索所需函数的帮助行并将其显示在 GUI 中的帮助文本字段中，有人有任何想法吗？

Answer 1

将帮助文本放在函数定义中的第一个未分配的字符串中，如下所示:

def func(a,b,c): 
  """
  This function adds three numbers.
  """
  return a+b+c

现在，可以通过变量 __doc__ 获取此文本:

print(func.__doc__)
#
# This function adds three numbers.
# 

您甚至不需要调用该函数。