在 argparse 中有一个带有破折号的选项

Posted 2023-03-25

【中文标题】在 argparse 中有一个带有破折号的选项

【英文标题】：Having options in argparse with a dash

【发布时间】：2012-10-01 20:03:31

【问题描述】：

我想在 argparse 模块中有一些选项，例如 --pm-export，但是当我尝试像 args.pm-export 一样使用它时，我收到没有属性 pm 的错误。我该如何解决这个问题？是否可以在命令行选项中使用-？

【参考方案1】：

作为indicated in the argparse docs:

对于可选参数操作，dest 的值通常是从选项字符串中推断出来的。 ArgumentParser 通过获取第一个长选项字符串并剥离初始 -- 字符串来生成 dest 的值。 任何内部- 字符都将转换为_ 字符，以确保字符串是有效的属性名称

所以你应该使用args.pm_export。

【参考方案2】：

不幸的是，破折号到下划线的替换不适用于位置参数（不以-- 为前缀），例如

parser = argparse.ArgumentParser(description='Process some integers.')
parser.add_argument('logs-dir',
                    help='Directory with .log and .log.gz files')
parser.add_argument('results-csv', type=argparse.FileType('w'),
                    default=sys.stdout,
                    help='Output .csv filename')
args = parser.parse_args()
print args

# gives
# Namespace(logs-dir='./', results-csv=<open file 'lool.csv', mode 'w' at 0x9020650>)

因此，您应该使用add_argument() 的第一个参数作为属性名称，并使用metavar kwarg 来设置它在帮助中的外观：

parser = argparse.ArgumentParser(description='Process some integers.')
parser.add_argument('logs_dir', metavar='logs-dir',
                    nargs=1,
                    help='Directory with .log and .log.gz files')
parser.add_argument('results_csv', metavar='results-csv',
                    nargs=1,
                    type=argparse.FileType('w'),
                    default=sys.stdout,
                    help='Output .csv filename')
args = parser.parse_args()
print args

# gives
# Namespace(logs_dir=['./'], results_csv=[<open file 'lool.csv', mode 'w' at 0xb71385f8>])

【讨论】：

相关 Python 错误报告：bugs.python.org/issue15125。 argparse 使用 setattr 和 getattr，因此 dest 名称不必是有效的 dot 属性名称。用户也可以使用getattr。

我会做positional_arg = getattr( parser, 'positional-arg' )

【参考方案3】：

破折号转换为下划线：

import argparse
pa = argparse.ArgumentParser()
pa.add_argument('--foo-bar')
args = pa.parse_args(['--foo-bar', '24'])
print args # Namespace(foo_bar='24')

【讨论】：

仅适用于可选参数。需要保留连字符，因此需要下划线以使其易于访问。

【参考方案4】：

getattr(args, 'positional-arg')

这是位置参数的另一个可行的解决方法：

#!/usr/bin/env python3

import argparse

parser = argparse.ArgumentParser()
parser.add_argument('a-b')
args = parser.parse_args(['123'])
assert getattr(args, 'a-b') == '123'

在 Python 3.8.2 上测试。

【讨论】：

如果a-b 不是问题所要求的位置参数，这将不会通过。

【参考方案5】：

简洁明了但可能并不总是可以接受的方式是使用vars()：

#!/usr/bin/env python3

import argparse

parser = argparse.ArgumentParser()
parser.add_argument('a-b')
args = vars(parser.parse_args())

print(args['a-b'])