如何自定义默认帮助文本的命令行python-fire由谷歌?

23c0lvtd  于 2023-01-19  发布在  Python
关注(0)|答案(1)|浏览(95)

我正在尝试使用python-fire module by google创建一个小命令行工具。我的文件名是my_tools. py。在my_tools.py中,我有代码

class MainFunction():
   def __init__(self):
      self.config = WrapperConfig()
   def hey_world(self):
      print("hey world")

if __name__ == '__main__':
   fire.Fire(MainFunction)

当我在终端中运行命令python my_tools.py时,我得到的输出为:

NAME                                                                                                                        
  my_tools.py                                                                                                                                                                                                                                 
SYNOPSIS                                                                                                                    
  my_tools.py GROUP | COMMAND                                                                                                                                                                                                                 
GROUPS                                                                                                                      
  GROUP is one of the following:                                                                                                                                                                                                                   
  config                                                                                                                                                                                                                                     
COMMANDS                                                                                                                    
  COMMAND is one of the following:                                                                                                                                                                                                                 
  hey_world

View Output Here
有什么方法可以自定义此默认帮助文本吗?

e5nqia27

e5nqia271#

可以向类和函数中添加docstring。

class MainFunction():
   """description of MainFunction"""
   def __init__(self):
      self.config = WrapperConfig()
   def hey_world(self):
   """description of hey_world"""
      print("hey world")

if __name__ == '__main__':
   fire.Fire(MainFunction)

相关问题