如何在Fabric中创建自定义帮助菜单？

Question

当我运行fab --list时，我得到输出

error                        Call ``func`` with given error ``message``.
get_all_tags
get_head_position
get_latest_patch
get_latest_tag
get_pending_patches
glob                         Return a list of paths matching a pathname pattern.
handle_prompt_abort
help
indent                       Return ``text`` indented by the given number of spaces.

这包含几个用户定义的函数，如get_all_tags get_head_position等但没有任何描述。
我希望包含这些函数的描述，以便我的列表看起来像这样< BR />

error                        Call ``func`` with given error ``message``.
get_all_tags                 Returns a list of all available tags
get_head_position            Returns the current Head position
get_latest_patch             Returns most recently created patch file name
get_latest_tag               Returns the most recent tags among all the tags
get_pending_patches          Returns list of all patches which are yet to be applied
glob                         Return a list of paths matching a pathname pattern.
handle_prompt_abort
help
indent                       Return ``text`` indented by the given number of spaces.

我该怎么做？

Answer 1

将docstring添加到函数中。

@task
def get_all_tags():
    "This is a docstring ..."

docstring用于显示帮助消息。

根据fab -l option documentation：

  

正常导入fabfile，但随后打印所有已发现的列表   任务和退出。 还会打印每个任务的第一行   docstring，如果它有一个，在它旁边（必要时截断。）