Skip to content

CLI Kit¤

避免顯示 argparse metavar 的 Formatter,用於簡化參數提示和加長選項到說明的間距。舉例來說,使用 options 參數預設的提示是

options
  -o OPTION --options OPTION   Description...

會變成

options
  -o --options OPTION          Description...

arg_kit ¤

CLASS DESCRIPTION
ArgFormatter

抑制 argparse metavar 輸入重複提示,加寬參數到描述文字的間隔

ArgFormatter ¤

ArgFormatter(spacing: int = 36, *args: Any, **kwargs: Any)

抑制 argparse metavar 輸入重複提示,加寬參數到描述文字的間隔

Usage
parser = argparse.ArgumentParser(
    prog='awesome-cli',
    description='My super cool cli tool',
    formatter_class=ArgFormatter,
)
parser.add_argument('-o', '--option', dest='option', type=str, help='custom option')
parser.parse_args()

Command line output:

$ example.py -h
usage: awesome-cli [-h] [-o OPTION]

My super cool cli tool

options:
  -h, --help           show this help message and exit
  -o, --option OPTION  custom option