argparse可选子分析器（用于--version）

Question

我有以下代码（使用Python 2.7）：

# shared command line options, like --version or --verbose 
parser_shared = argparse.ArgumentParser(add_help=False) 
parser_shared.add_argument('--version', action='store_true') 

# the main parser, inherits from `parser_shared` 
parser = argparse.ArgumentParser(description='main', parents=[parser_shared]) 

# several subcommands, which can't inherit from the main parser, since 
# it would expect subcommands ad infinitum 
subparsers = parser.add_subparsers('db', parents=[parser_shared]) 

... 

args = parser.parse_args() 

现在我想能够例如调用这个程序与附加到正常程序或一些子命令--version：

$ prog --version 
0.1 

$ prog db --version 
0.1 

基本上，我需要声明可选subparsers。我知道这不是really supported，但有没有任何解决方法或替代方法？

编辑：该错误消息我得到：

$ prog db --version 
# works fine 

$ prog --version 
usage: .... 
prog: error: too few arguments 

Answer 1

根据文档，--version与action='version'（而不是与action='store_true'）打印自动版本号：

parser.add_argument('--version', action='version', version='%(prog)s 2.0') 

Answer 2

啊，我只是检查svn，它在add_subparsers() documentation中用作对象示例，它仅在主命令上支持'--version'：

python zacharyyoung$ svn log --version 
Subcommand 'log' doesn't accept option '--version' 
Type 'svn help log' for usage. 

还有：

# create common parser 
parent_parser = argparse.ArgumentParser('parent', add_help=False) 
parent_parser.add_argument('--version', action='version', version='%(prog)s 2.0') 

# create the top-level parser 
parser = argparse.ArgumentParser(parents=[parent_parser]) 
subparsers = parser.add_subparsers() 

# create the parser for the "foo" command 
parser_foo = subparsers.add_parser('foo', parents=[parent_parser]) 

其中产量：

python zacharyyoung$ ./arg-test.py --version 
arg-test.py 2.0 
python zacharyyoung$ ./arg-test.py foo --version 
arg-test.py foo 2.0 

Answer 3

虽然我们wait for this feature交付，我们可以用这样的代码：

# Make sure that main is the default sub-parser 
if '-h' not in sys.argv and '--help' not in sys.argv: 
    if len(sys.argv) < 2: 
     sys.argv.append('main') 
    if sys.argv[1] not in ('main', 'test'): 
     sys.argv = [sys.argv[0], 'main'] + sys.argv[1:] 

Answer 4

FWIW，我跑进这也是，并最终通过不使用子分析器“解决”它（我已经拥有了自己的系统打印帮助，所以没有失去任何东西）。

相反，我这样做：

parser.add_argument("command", nargs="?", 
        help="name of command to execute") 

args, subcommand_args = parser.parse_known_args() 

...然后子命令创建自己的解析器（类似于子分析器），它只能在subcommand_args运行。

Answer 5

从Python 3.3开始，如分号http://bugs.python.org/issue9253（argparse：optional subparsers）中所讨论的那样，子分析器现在是可选的。这是parse_args如何检查所需参数的一个非预期结果。

我发现一个软复位恢复以前（所需的子分析器）行为，明确设置subparsers操作的required属性。

parser = ArgumentParser(prog='test') 
subparsers = parser.add_subparsers() 
subparsers.required = True # the fudge 
subparsers.dest = 'command' 
subparser = subparsers.add_parser("foo", help="run foo") 
parser.parse_args() 

查看该问题了解更多详情。我预计，如果此问题得到正确修补，则默认情况下将需要子分析器，并且可以使用某种选项将其required属性设置为False。但是有一个积压的​​补丁。

Answer 6

虽然@ eumiro的回答地址--version选项，它只能这样做，因为这是optparse的特殊情况。为了让一般的调用：

prog 
prog --verbose 
prog --verbose main 
prog --verbose db 

，并有prog --version工作作为prog --verbose main（和prog main --verbose）相同，你可以添加一个方法来Argumentparser并调用与默认子分析器的名字，只是调用parse_args()前：

import argparse 
import sys 

def set_default_subparser(self, name, args=None): 
    """default subparser selection. Call after setup, just before parse_args() 
    name: is the name of the subparser to call by default 
    args: if set is the argument list handed to parse_args() 

    , tested with 2.7, 3.2, 3.3, 3.4 
    it works with 2.6 assuming argparse is installed 
    """ 
    subparser_found = False 
    for arg in sys.argv[1:]: 
     if arg in ['-h', '--help']: # global help if no subparser 
      break 
    else: 
     for x in self._subparsers._actions: 
      if not isinstance(x, argparse._SubParsersAction): 
       continue 
      for sp_name in x._name_parser_map.keys(): 
       if sp_name in sys.argv[1:]: 
        subparser_found = True 
     if not subparser_found: 
      # insert default in first position, this implies no 
      # global options without a sub_parsers specified 
      if args is None: 
       sys.argv.insert(1, name) 
      else: 
       args.insert(0, name) 

argparse.ArgumentParser.set_default_subparser = set_default_subparser 

def do_main(args): 
    print 'main verbose', args.verbose 

def do_db(args): 
    print 'db verbose:', args.verbose 

parser = argparse.ArgumentParser() 
parser.add_argument('--verbose', action='store_true') 
parser.add_argument('--version', action='version', version='%(prog)s 2.0') 
subparsers = parser.add_subparsers() 
sp = subparsers.add_parser('main') 
sp.set_defaults(func=do_main) 
sp.add_argument('--verbose', action='store_true') 
sp = subparsers.add_parser('db') 
sp.set_defaults(func=do_db) 

parser.set_default_subparser('main') 
args = parser.parse_args() 

if hasattr(args, 'func'): 
    args.func(args) 

set_default_subparser()方法是ruamel.std.argparse包的一部分。

Answer 7

这似乎实现了可选subparser的基本思想。我们解析适用于所有子命令的标准参数。然后，如果剩下任何东西，我们就调用其余的解析器。主要参数是子命令的父项，因此-h显示正确。如果没有子命令存在，我打算输入交互式提示符。

import argparse 

p1 = argparse.ArgumentParser(add_help = False)  
p1.add_argument(‘–flag1′) 

p2 = argparse.ArgumentParser(parents = [ p1 ]) 
s = p2.add_subparsers() 
p = s.add_parser(‘group’) 
p.set_defaults(group=True) 

(init_ns, remaining) = p1.parse_known_args() 

if remaining: 
    p2.parse_args(args = remaining, namespace=init_ns) 
else: 
    print(‘Enter interactive loop’) 

print(init_ns)