Question

我有以下代码：

parser = argparse.ArgumentParser(description='Postfix Queue Administration Tool',
        prog='pqa',
        usage='%(prog)s [-h] [-v,--version]')
parser.add_argument('-l', '--list', action='store_true',
        help='Shows full overview of all queues')
parser.add_argument('-q', '--queue', action='store', metavar='<queue>', dest='queue',
        help='Show information for <queue>')
parser.add_argument('-d', '--domain', action='store', metavar='<domain>', dest='domain',
        help='Show information about a specific <domain>')
parser.add_argument('-v', '--version', action='version', version='%(prog)s 0.1')
args = parser.parse_args()

这给了我这样的输出：

%./pqa                                                                                                                        
usage: pqa [-h] [-v,--version]

Postfix Queue Administration Tool

optional arguments:
  -h, --help            show this help message and exit
  -l, --list            Shows full overview of all queues
  -q <queue>, --queue <queue>
                        Show information for <queue>
  -d <domain>, --domain <domain>
                        Show information about a specific <domain>
  -v, --version         show program's version number and exit

我非常想知道如何“分组”具有两个版本（即长选项）的命令，每个版本也显示一个元变量。

这主要是我身上的审美问题，但我仍然想解决这个问题。我一直在网上阅读手册和文字，但要么信息不存在，要么我完全遗漏了一些东西：）

Answer 1

将hpaulj的答案放入实际代码中，类似这样的工作：

class CustomHelpFormatter(argparse.HelpFormatter):
    def _format_action_invocation(self, action):
        if not action.option_strings or action.nargs == 0:
            return super()._format_action_invocation(action)
        default = self._get_default_metavar_for_optional(action)
        args_string = self._format_args(action, default)
        return ', '.join(action.option_strings) + ' ' + args_string

fmt = lambda prog: CustomHelpFormatter(prog)
parser = argparse.ArgumentParser(formatter_class=fmt)

要另外扩展帮助变量的默认列大小，请将构造函数添加到CustomHelpFormatter：

def __init__(self, prog):
    super().__init__(prog, max_help_position=40, width=80)

看到它在行动：

usage: bk set [-h] [-p] [-s r] [-f] [-c] [-b c] [-t x y] [-bs s] [-bc c]
              [--crop x1 y1 x2 y2] [-g u r d l]
              monitor [path]

positional arguments:
  monitor                    monitor number
  path                       input image path

optional arguments:
  -h, --help                 show this help message and exit
  -p, --preview              previews the changes without applying them
  -s, --scale r              scales image by given factor
  -f, --fit                  fits the image within monitor work area
  -c, --cover                makes the image cover whole monitor work area
  -b, --background c         selects background color
  -t, --translate x y        places the image at given position
  -bs, --border-size s       selects border width
  -bc, --border-color c      selects border size
  --crop x1 y1 x2 y2         selects crop area
  -g, --gap, --gaps u r d l  keeps "border" around work area

Answer 2

另一种解决方案，使用自定义描述

如果您设置metavar=''，则帮助热线会变为：

-q , --queue          Show information for <queue>

在这里，我取消了常规帮助行，并将其替换为组的描述行：

parser = argparse.ArgumentParser(description='Postfix Queue Administration Tool',
        prog='pqa',
        usage='%(prog)s [-h] [-v,--version]',
        formatter_class=argparse.RawDescriptionHelpFormatter,
        )
parser.add_argument('-l', '--list', action='store_true',
        help='Shows full overview of all queues')
g = parser.add_argument_group(title='information options',
        description='''-q, --queue <queue>     Show information for <queue>
-d, --domain <domain>   Show information about a specific <domain>''')
g.add_argument('-q', '--queue', action='store', metavar='', dest='queue',
        help=argparse.SUPPRESS)
g.add_argument('-d', '--domain', action='store', metavar='<domain>', dest='domain',
        help=argparse.SUPPRESS)
parser.add_argument('-v', '--version', action='version', version='%(prog)s 0.1')
parser.print_help()

usage: pqa [-h] [-v,--version]

Postfix Queue Administration Tool

optional arguments:
  -h, --help     show this help message and exit
  -l, --list     Shows full overview of all queues
  -v, --version  show program's version number and exit

information options:
  -q, --queue <queue>     Show information for <queue>
  -d, --domain <domain>   Show information about a specific <domain>

或者您可以将这些信息放在常规说明中。您已经在使用自定义使用行。

Answer 3

帮助热线中是否重复了<domain>的问题？：

-d <domain>, --domain <domain>

argparse HelpFormatter不会让用户对显示器的这一部分有很多控制权。如您所示，您可以设置使用行，帮助文本和metavar。

您必须继承HelpFormatter，并更改其中一个函数以生成以下内容：

-d, --domain <domain>

它看起来不像是一个复杂的变化，可能是HelpFormatter._format_action_invocation方法。但是你需要更清楚地了解你想要的东西。

不要在argparse的print_help（）中显示两次长选项

3 个答案:

另一种解决方案，使用自定义描述