带有编号参数名称的 Python argparse

Posted 2023-03-25

【中文标题】带有编号参数名称的 Python argparse

【英文标题】：Python argparse with numbered argument name

【发布时间】：2021-06-28 01:56:21

【问题描述】：

GNU grep 有一个参数可以在匹配行周围打印一定数量的额外行。从手册页：

-C NUM, -NUM, --context=NUM 打印 NUM 行输出上下文。在相邻的组之间放置一个包含组分隔符 (--) 的行 火柴。使用 -o 或 --only-matching 选项，这没有效果，并且 发出警告。

所以我可以做类似的事情

grep -5 pattern file.txt

相当于

grep -C 5 pattern file.txt

如何使用 argparse 模拟 -NUMBER 行为到用户可以传入 -NUM 的位置，我可以从 argparse 轻松获取该数字。

这样做的一个愚蠢的方法是做这样的事情：

parser = argparse.ArgumentParser()
for i in range(1, 10000):
    parser.add_argument(f'-i', action='store_true', dest=f'border_lines_i', help=argparse.SUPPRESS)

args = parser.parse_args()

border_line_count = 0
for i in range(1, 10000):
    if getattr(args, f'border_lines_i'):
        border_line_count = i
        break

基本上，我为不同的 -NUM 添加了一堆隐藏参数。然后找到设置的那个。有没有更好的办法？

【问题讨论】：

你必须定义每一个'-1'，'-3'。没有通用或模式标志定义。

grep 可能可以追溯到 unix/POSIX getopt 标准开发之前。它从头开始进行自己的解析。

【参考方案1】：

这是一种方法，但我个人不喜欢它。

parser.add_argument('-', dest='border_lines')

会给你你想要的基本行为。请注意，这是一个必需参数，如果您希望这是一个可选参数，您可以：

parser.add_argument('-', dest='border_lines', default=0)

现在的一个（奇怪的）问题是它只接受单个数字。要解决这个问题，您需要定义并覆盖解析操作。

 class ConcatAction(argparse.Action):
     def __call__(self, parser, namespace, values, option_string):
         value = int(''.join(values))
         setattr(namespace, 'border_lines', value)

现在您可以将其用作：

parser = argparse.ArgumentParser()
parser.add_argument('-', dest='border_lines', default=0, nargs='*', action=ConcatAction)
parser.parse_args('-555')  # Gives Namespace(border_lines=555)

我强烈认为这会与其他参数混淆，我还没有测试过。我再说一遍，我不喜欢这种方式，并且遵循 python zen，我们应该明确（使用 arg 名称）并尽可能清晰。

【讨论】：

我同意这是一件奇怪的事情，只是试图将一些 grep 语法与一个快速的 python 脚本匹配以使用我的肌肉记忆。

@csm10495 对，我喜欢自己经常练习奇怪的东西。