Python argparse - 长参数名称的帮助文本

如何解决Python argparse - 长参数名称的帮助文本

Python 'argparse' 在新行上显示长命名参数的帮助文本：

**#script.py -h

Select one of the options given


optional arguments:
  -h,--help            show this help message and exit
  -bs,--business_service 
                        choose the service     << New line
  -so,--service_offering 
  -ci,--cmdb_ci       provide configuration item
  -desc,--description 
                        write description     << New line

以下是我正在使用的代码：

self.parser = argparse.ArgumentParser(
            description='Select one of the options given',epilog=self._get_usage(),formatter_class=argparse.RawTextHelpformatter
            )


        self.parser.add_argument('-bs','--business_service',type=str,help='choose the service',Metavar='')
        self.parser.add_argument('-so','--service_offering',Metavar='')
        self.parser.add_argument('-ci','--mdcb_ci',help='provide configuration item',Metavar='')
        self.parser.add_argument('-desc','--description',help='write description',Metavar='')

我希望帮助字符串在参数的同一行：

-bs,--business_service     choose the service     << Same line

我该如何解决？

解决方法

HelpFormatter 类采用 max_help_position 参数。默认值为 24，这是您在帮助中看到的值。

可以使用新的 Formatter 子类进行更改，或修改调用参数。

In [23]: parser.formatter_class = 
    lambda prog: argparse.RawTextHelpFormatter(prog,max_help_position=30)

这里我修改了 formatter_class 属性，但您可以使用此 lambda 行代替

formatter_class=argparse.RawTextHelpFormatter

结果是：

In [24]: parser.print_help()
usage: ipython3 [-h] [-bs] [-so] [-ci] [-desc]

Select one of the options given

optional arguments:
  -h,--help                 show this help message and exit
  -bs,--business_service   choose the service
  -so,--service_offering 
  -ci,--mdcb_ci            provide configuration item
  -desc,--description      write description

选择这样的参数是为了平衡显示的整体宽度和易读性。它们可以像这样进行调整，但这确实需要一些 Python 编程知识。我已经有一段时间没有这样做了，所以我的建议可能不是最简单的。但总体来说方向是正确的。

另一种使用 partial 包装器设置它的方法：

In [42]: from functools import partial
In [43]: newformatter=partial(argparse.HelpFormatter,max_help_position=30)
In [44]: parser.formatter_class=newformatter