21

我正在使用 Python 2.7 的 argparse 包为命令行工具编写一些选项解析逻辑。该工具应接受以下参数之一：

"ON"：打开功能。
"OFF"：关闭功能。
[未提供参数]：回显函数的当前状态。

查看 argparse 文档让我相信我想要定义两个（可能是三个）子命令，因为这三个状态是互斥的并且代表不同的概念活动。这是我目前对代码的尝试：

parser = argparse.ArgumentParser()
subparsers = parser.add_subparsers()
parser.set_defaults(func=print_state) # I think this line is wrong.

parser_on = subparsers.add_parser('ON')
parser_on.set_defaults(func=set_state, newstate='ON')

parser_off = subparsers.add_parser('OFF')
parser_off.set_defaults(func=set_state, newstate='OFF')

args = parser.parse_args()

if(args.func == set_state):
    set_state(args.newstate)
elif(args.func == print_state):
    print_state()
else:
    args.func() # Catchall in case I add more functions later

我的印象是，如果我提供 0 个参数，主解析器将设置func=print_state，如果我提供 1 个参数，主解析器将使用适当的子命令的默认值并调用func=set_state. 相反，我收到以下带有 0 个参数的错误：

usage: cvsSecure.py [-h] {ON,OFF} ...
cvsSecure.py: error: too few arguments

如果我提供“OFF”或“ON”，print_state则调用而不是set_state. 如果我注释掉该parser.set_defaults行，set_state则正确调用。

我是一个熟练级别的程序员，但是 Python 的初级初学者。关于如何让这个工作的任何建议？

编辑：我查看子命令的另一个原因是我正在考虑未来的潜在第四个功能：

“FORCE txtval”：将函数的状态设置为txtval.

4

2 回答 2

13

顶级解析器的默认值会覆盖子解析器的默认值，因此设置子解析器的默认值会func被忽略，但newstate子解析器默认值的值是正确的。

我认为您不想使用子命令。当可用选项和位置参数根据选择的子命令而变化时，使用子命令。但是，您没有其他选项或位置参数。

以下代码似乎可以满足您的要求：

import argparse

def print_state():
    print "Print state"

def set_state(s):
    print "Setting state to " + s

parser = argparse.ArgumentParser()
parser.add_argument('state', choices = ['ON', 'OFF'], nargs='?')

args = parser.parse_args()

if args.state is None:
    print_state()
elif args.state in ('ON', 'OFF'):
    set_state(args.state)

注意 的可选参数parser.add_argument。"choices" 参数指定允许的选项，同时将 "nargs" 设置为 "?" 指定如果可用，则应使用 1 个参数，否则不应使用任何参数。

编辑：如果您想添加一个带有参数的 FORCE 命令并为 ON 和 OFF 命令提供单独的帮助文本，那么您确实需要使用子命令。不幸的是，似乎没有指定默认子命令的方法。但是，您可以通过检查空参数列表并提供您自己的来解决此问题。这是一些示例代码，说明了我的意思：

import argparse
import sys

def print_state(ignored):
    print "Print state"

def set_state(s):
    print "Setting state to " + s

parser = argparse.ArgumentParser()
subparsers = parser.add_subparsers()
on = subparsers.add_parser('ON', help = 'On help here.')
on.set_defaults(func = set_state, newstate = 'ON')
off = subparsers.add_parser('OFF', help = 'Off help here.')
off.set_defaults(func = set_state, newstate = 'OFF')
prt = subparsers.add_parser('PRINT')
prt.set_defaults(func = print_state, newstate = 'N/A')
force = subparsers.add_parser('FORCE' , help = 'Force help here.')
force.add_argument('newstate', choices = [ 'ON', 'OFF' ])
force.set_defaults(func = set_state)

if (len(sys.argv) < 2):
    args = parser.parse_args(['PRINT'])
else:
    args = parser.parse_args(sys.argv[1:])

args.func(args.newstate)
于 2011-03-03T04:55:34.660 回答
1

你的方法有两个问题。

首先，您可能已经注意到，这newstate不是 sub 解析器的一些 sub_value，需要在argsas的顶层处理args.newstate。这应该解释将默认值分配给newstate两次将导致第一个值被覆盖。无论您使用“ON”还是“OFF”作为参数调用程序，每次都set_state()将使用OFF. 如果您只想能够做到以下几点将起作用python cvsSecure ON： python cvsSecure OFF

from __future__ import print_function

import sys
import argparse

def set_state(state):
    print("set_state", state)

def do_on(args):
    set_state('ON')

def do_off(args):
    set_state('OFF')

parser = argparse.ArgumentParser()
subparsers = parser.add_subparsers()

parser_on = subparsers.add_parser('ON')
parser_on.set_defaults(func=do_on)
parser_on.add_argument('--fast', action='store_true')
parser_off = subparsers.add_parser('OFF')
parser_off.set_defaults(func=do_off)

args = parser.parse_args()
args.func(args)

第二个问题是将argparse子解析器作为单值参数处理，因此您必须在调用之前指定一个parser.parse_args()。set_default_subparser您可以通过添加额外的子解析器'PRINT'并使用添加到自动插入缺少的参数来自动插入argparse.ArgumentParser()（该代码是包ruamel.std.argparse的一部分

from __future__ import print_function

import sys
import argparse

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 print_state(args):
    print("print_state")

def set_state(state):
    print("set_state", state)

def do_on(args):
    set_state('ON')

def do_off(args):
    set_state('OFF')

parser = argparse.ArgumentParser()
subparsers = parser.add_subparsers()

parser_print = subparsers.add_parser('PRINT', help='default action')
parser_print.set_defaults(func=print_state)
parser_on = subparsers.add_parser('ON')
parser_on.set_defaults(func=do_on)
parser_on.add_argument('--fast', action='store_true')
parser_off = subparsers.add_parser('OFF')
parser_off.set_defaults(func=do_off)

parser.set_default_subparser('PRINT')

args = parser.parse_args()
args.func(args)

您不需要处理argstodo_on()等，但如果您开始为不同的子解析器指定选项，它会派上用场。

于 2014-10-15T08:57:09.003 回答