重新排序Python argparse参数组

我使用的是，我有一个自定义参数组required arguments。有什么方法可以改变帮助信息中参数组的顺序吗？我认为在可选参数前面有必要的参数更合乎逻辑，但没有找到任何文档或问题来帮助。重新排序Python argparse参数组

例如，改变这一点：

usage: foo.py [-h] -i INPUT [-o OUTPUT] 

Foo 

optional arguments: 
    -h, --help   show this help message and exit 
    -o OUTPUT, --output OUTPUT 
         Output file name 

required arguments: 
    -i INPUT, --input INPUT 
         Input file name

这样：

usage: foo.py [-h] -i INPUT [-o OUTPUT] 

Foo 

required arguments: 
    -i INPUT, --input INPUT 
         Input file name 

optional arguments: 
    -h, --help   show this help message and exit 
    -o OUTPUT, --output OUTPUT 
         Output file name

（例如，从this question拍摄）

来源

2016-08-19 Logan

，可以考虑添加一个明确的可选参数组：

import argparse 

parser = argparse.ArgumentParser(description='Foo', add_help=False) 

required = parser.add_argument_group('required arguments') 
required.add_argument('-i', '--input', help='Input file name', required=True) 

optional = parser.add_argument_group('optional arguments') 
optional.add_argument("-h", "--help", action="help", help="show this help message and exit") 
optional.add_argument('-o', '--output', help='Output file name', default='stdout') 

parser.parse_args(['-h'])

可以帮助动作移动到这里所描述的可选组作为： Move "help" to a different Argument Group in python argparse

正如你看到的，代码生成所需的输出：

usage: code.py -i INPUT [-h] [-o OUTPUT] 

Foo 

required arguments: 
    -i INPUT, --input INPUT 
         Input file name 

optional arguments: 
    -h, --help   show this help message and exit 
    -o OUTPUT, --output OUTPUT 
         Output file name

来源

2016-08-19 20:39:55 taras

分析器开始了与2个参数组，通常的positional和optionals。 -h帮助已添加到optionals。当您做add_argument_group时，会创建一个组（并返回给您）。它也附在parser._action_groups列表中。

当您寻求帮助（-h）parser.format_help()被调用（您也可以在测试中做到这一点）。在argparse.py中查找该方法。，设置了帮助消息，和一个步骤是：

# positionals, optionals and user-defined groups 
    for action_group in self._action_groups: 
     formatter.start_section(action_group.title) 
     formatter.add_text(action_group.description) 
     formatter.add_arguments(action_group._group_actions) 
     formatter.end_section()

因此，如果我们重新排序parser._action_groups列表中的项目，我们将重新排序组在显示屏上。由于这是_action_groups的唯一用途，它应该是安全和容易的。但有些人不允许在封面下达到顶峰（查看或更改._属性）。

建议的解决方案是按照您想要查看它们的顺序创建自己的组，并确保默认组为空（参数add_help=False）。如果你坚持使用公共API，那么这是唯一的方法。

演示：

import argparse 
parser = argparse.ArgumentParser() 
parser.add_argument('foo') 
g1 = parser.add_argument_group('REQUIRED') 
g1.add_argument('--bar', required=True) 
g1.add_argument('baz', nargs=2) 

print(parser._action_groups) 
print([group.title for group in parser._action_groups]) 
print(parser.format_help()) 

parser._action_groups.reverse() # easy inplace change 
parser.print_help()

运行结果：

1504:~/mypy$ python stack39047075.py

_actions_group名单和头衔：

[<argparse._ArgumentGroup object at 0xb7247fac>, 
<argparse._ArgumentGroup object at 0xb7247f6c>, 
<argparse._ArgumentGroup object at 0xb721de0c>] 
['positional arguments', 'optional arguments', 'REQUIRED']

默认的帮助：

usage: stack39047075.py [-h] --bar BAR foo baz baz 

positional arguments: 
    foo 

optional arguments: 
    -h, --help show this help message and exit 

REQUIRED: 
    --bar BAR 
    baz

反向后：

usage: stack39047075.py [-h] --bar BAR foo baz baz 

REQUIRED: 
    --bar BAR 
    baz 

optional arguments: 
    -h, --help show this help message and exit 

positional arguments: 
    foo 
1504:~/mypy$

实现此的另一种方式是定义一个新的format_help方法的ArgumentParser子类。在该方法中，重新排序for action_group...循环中使用的列表。

来源

2016-08-19 21:56:39 hpaulj

这是无可否认的一个黑客，并且是在多变的内部实现依赖，但添加的参数后，你可以简单地做：

parser._action_groups.reverse()

这将有效地使上述的可选参数必需的参数组显示组。请注意，这个答案只是描述性的，而不是说明性的。

信用：answer by hpaulj

来源

2016-10-05 07:19:38

重新排序Python argparse参数组

回答

相关问题