python - 更改 argparse 使用消息参数顺序

Question

我在 python3 中使用 argparse。在我的脚本中，我有一些子解析器、一个位置参数和一些可选参数。我有一个可选参数来传递任意数量的文件路径，它使用 nargs='*'。我的脚本的使用消息显示如下:

usage: myprog.py subparser1 [-h] [--dir DIR] 
                            [--files [FILES [FILES ...]]]
                            positional_arg

但是，如果您实际上按照此使用消息的建议将 positional_arg 放在 --files 标志之后，我认为解析器最终会将其作为文件路径使用(因为 nargs='*')，然后抛出错误，因为它找不到所需的 positional_arg。

我认为打印使用消息的方式具有误导性。由于我有多个子解析器，我想找到一种方法来更改所有使用消息(无需使用 usage= 参数手动输入所有消息)，以便首先显示位置参数，希望如此消除困惑。

所以我的主要问题是如何更改 argparse 消息的使用部分中参数的排序方式？

编辑以解决一种不适合我的可能解决方案。

我不想将 --files 标志添加为 nargs='*' 的位置参数。首先，因为这使得它现在显示在帮助消息的“位置参数”部分中，而不是与我的其余可选参数一起显示在“可选参数”部分中，因此它看起来像是必需的，即使您可以传递 0 个参数。

其次，因为如果我想要另一个标志，除了 --files 之外还可以接受任意数量的参数(例如 --folders)，并且如果我让它们都是位置参数，我遇到了同样的问题，第一个参数会一直消耗参数直到最后。如果我设置了一个位置和一个可选，那么误导性的使用消息仍然是一个问题。

Answer 1

这里有几个问题 - 如何解析参数以及如何格式化用法。

一些快速修复:

使用 -- 标记可选列表的结尾和位置的开始。

另一种可能性是将您的位置变成可选。也就是说，给它一个简单的标志，并在需要时提供 required 参数。然后它可以放置在子解析器输入中的任何位置。

<小时/>

https://stackoverflow.com/a/26986546/901925解决了 * 可选后面的位置问题。它给出了同样的快速建议。它还显示了如何更改帮助格式化程序以不将位置移动到用法的末尾。但它没有解决多行用例。

最近的一个 SO 问题中也讨论了使用顺序， https://stackoverflow.com/a/29619171/901925

<小时/>

如果您不喜欢默认的参数分组(位置和可选参数)，您可以使用具有不同标题和描述的 argument_groups。带有诸如“？”之类的纳尔斯和“*”、“必需”参数、“可选”和“位置”等名称可能会令人困惑。我正在尝试使用“标记”作为“可选”，希望它不会那么困惑。