我正在编写一组python脚本,这些脚本可以解析多种输入格式,但这些输入的type
由另一个命令行参数决定。如何使一个参数影响另一个参数的类型?
示例演示我想要的行为:
import argparse
def load_single_file(filepath: str):
...
def load_directory(filepath: str):
...
parser = argparse.ArgumentParser()
parser.add_argument('--type', choices=('single-file', 'directory'), required=True)
parser.add_argument('input', type=load_single_file if '--type' == 'single-file' else load_directory)
我不想事后处理parser.parse_args()
,因为我正在写大量的脚本,所有这些脚本都需要这种输入风格,除了其中一些脚本可能会以不同的方式使用'input'
参数(例如,一个脚本可能使用两个这样的参数,一个可能是input1 3 4 randomInfo input2
或--first input1 --second input2
等(,这意味着如果我在后处理中这样做,我通常不知道应该解析哪些参数:
# This doesn't work:
def parse_args(parser):
parser.add_argument('--type', choices=('single-file', 'directory'), required=True)
args = parser.parse_args()
parser = load_single_file if args.type== 'single-file' else load_directory
# Which elements of `args` should have `parser` applied to it? It's impossible to tell.
# I cannot just specify `'input'` here too, as some scripts may want multiple or interspersed inputs.
同样重要的是,我可以将这种行为收集到一个函数中,因为我有几个参数(不仅仅是--type
(,它们会影响解析数据的方式(例如--filter
过滤掉一些数据(
总结:
- 给定
--type Value
,input
应根据Value
进行不同的解析 - 我不想通过后处理
parse_args()
来处理这种不同的解析,因为这将需要关于特定脚本的参数的知识,而我在";图书馆"> - 我正在编写大量密切相关的脚本,这些脚本都需要这个接口,这就是为什么我想抽象出一个通用的
parse_args(parser)
或类似的函数
您可以通过两次解析参数并设置全局:来获得此行为
# Use for type=parse_input
def parse_input(str, parse_fn=None):
if parse_fn is None:
parse_fn = parse_input.parse_fn
return parse_fn(str)
def parse_args(parser):
def add_args(parser, required):
parser.add_argument('--type', choices=('single-file', 'directory'), required=required)
# No --help, because we want to get the --help for `parser` if so
initial_parser = argparse.ArgumentParser(add_help=False)
# Any required arguments should be set to False so that we can get the message from `parser`
add_args(initial_parser, required=False)
first, rest = initial_parser.parse_known_args()
# Note: if you use prefix_chars, these won't necessarily be `-h` and `--help`.
# Use:
# if '-' in parser.prefix_chars:
# p = '-'
# else:
# p = parser.prefix_chars[0]
# And:
# f'{p}h', f'{p}{p}help'
if all(h not in rest for h in ('-h', '--help')):
parse_input.parse_fn = load_single_file if first.type== 'single-file' else load_directory
else:
# Allow better error message if parse_fn is missing
parse_input.parse_fn = lambda s: s
add_args(parser, required=True)
return parser.parse_args()
用法:
parser = argparse.ArgumentParser()
parser.add_argument('input', type=parse_input)
...
args = parse_args(parser)
我不知道有什么问题
def parse_args():
parser = argparse.ArgumentParser()
parser.add_argument('--type', choices=('single-file', 'directory'), required=True)
parser.add_argument('input', type=load_single_file if '--type' == 'single-file' else load_directory)
args = parser.parse_args()
# print(args) # for debugging
foo = load_single_file(args.input) if args.type=='single-file' else load_directory(args.input)
args.input = foo # if you want that result back on args
return args
如果您知道input
在创建parser
时依赖于type
,那么您也知道这一点。
了解load
函数的作用,可能会提供进一步的见解。预期type
函数将执行简单的转换,或者在出现错误时引发错误(TypeError
、ValueError
或argparse.ArgumentTypeError
(。argparse.FileType
可能是argparse
开发人员考虑过的最复杂的可调用类型,甚至它还没有成熟。它所做的只是打开一个文件,但现在我们被鼓励在with
上下文中打开文件,以确保及时关闭。
我的代码没有做的一件事是捕获错误(如果有的话(。它可以被包裹在try/except
中。您甚至可以使用parser.error(your-message)
以标准格式显示错误(带出口(。
无论如何,type
只使用一个参数(字符串(进行调用。它不能访问当时解析器内部正在进行的任何其他操作,甚至不能访问args
命名空间。argparse
的基本原理是按照用户提供的顺序解析参数。位置显然是顺序相关的,但标记的位置(optionals
(是顺序无关的,因此实现相互依赖是很困难的。具有xor
依赖关系的multually_exlusive
是它得到的最精细的。
其他SO问题询问了相互依赖的required
或default
属性。Answers提出了双重解析或自定义Action
类,但在我看来,后解析总是最简单的。
双重解析确实有其用途。例如,我编写了parser.parse_intermixed_args
方法,以便在混合位置和选项时提供更大的灵活性。请自行研究argparse.py
文件。
对此使用type
是有问题的。这很难理解,至少效率很低。script --input input --help
将使用parse_input
函数解析input
,然后argparse
意识到存在--help
,它应该只打印帮助消息并退出。
这并不是那么好,但您仍然可以通过自定义parse_args(...)
函数来获得这种行为,该函数添加了库标志,但也接受了使用parse_input
作为参数的名称。这还有一个额外的好处,那就是在错误处理方面也有更大的灵活性:
def parse_args(parser, *names):
parser.add_argument('--type', choices=('single-file', 'directory'), required=True)
args = parser.parse_args()
parser = load_single_file if args.type == 'single-file' else load_directory
args_dict = vars(args)
for name in names:
args_dict[name] = parser(args_dict[name])
return args
示例用法:
parser = argparse.ArgumentParser()
parser.add_argument('input')
args = parse_args(parser, 'input')
它不是完美的,因为您必须在一个额外的位置指定'input'
,但代码要容易得多;没有全局或类似的。