python - argparse:如何要求一组并非全部互斥且并非全部可选的参数？

Question

我正在尝试在 argparse 中提出与我的程序所需的主要功能有关的某些参数。但是，我有两个问题:

1. 并非所有论点都是相互排斥的。
2. 即使他们都是相互排斥的，相互排斥的群体要求参数是可选的，并且主要函数 search(不是必需的)使用位置参数。

理想情况下，我认为 'search' 是主要功能。因此，我希望它的论点是位置性的；不过，搜索 不是必需的。但是，至少需要以下一项:search, --name, --list, --add, --import, --encrypt, --decrypt, --delete-database, --rename-数据库，--备份

此外，--name 是不是相互排斥的选项，它是多用途的:

• 如果它被自己调用，如果它的参数(数据库的名称)不存在，将被创建。
• 如果(数据库)确实存在，则将其用作调用它的任何其他选项函数的参数:例如，-n myfirstdb --decrypt
• 然而，如果 --name 不存在，我假设是最近访问的数据库。

目前，我必须运行一个开始变得繁重的检查，以查看是否调用了任何主要选项，以及测试 --name 是否存在.

最后，显然不能同时使用互斥选项。

如何让 search 成为这个必需的互斥组的一部分？我怎样才能使 --name 也成为这个必需的组之一，但又不与它们中的任何一个互斥？

我正在试验子解析器，但我不确定它们是否能解决我的问题。任何建议都可能会节省我几天的试错时间，非常感谢。

parser.add_argument(
    'search', nargs='*', type=str, metavar='S', help='search [field] for string(s)')
parser.add_argument(
    '--name', '-n', type=str, help='name of the database; created if does not exist')

main_ex_group = parser.add_argument_group(
    title='main functions').add_mutually_exclusive_group()
main_ex_group.add_argument(
    '--list', '-l', action='store_true', help='list databases')
main_ex_group.add_argument(
    '--add', '-a', action='store_true', help='add new record to database')
main_ex_group.add_argument(
    '--import','-i', dest='include', metavar='PATH', type=str,
    help='import file(s) at PATH')
main_ex_group.add_argument(
    '--encrypt', action='store_true', help='encrypt database')
main_ex_group.add_argument(
    '--decrypt', action='store_true', help='decrypt database')
main_ex_group.add_argument(
    '--delete-database', metavar='NAME', type=str,
    help='delete a database')
main_ex_group.add_argument(
    '--rename-database', nargs=2, metavar='NAME', type=str,
    help='rename a database')
main_ex_group.add_argument(
    '--backup', nargs=2, metavar='NAME DEST', type=str,
    help='copy database to destination')


import_group = parser.add_argument_group(title='options for import')
import_group.add_argument(
    '--parse-fields', action='store_true',
    help='extract keys/fields from included file(s); used as columns')
import_group.add_argument(
    '--delimiter', metavar='S', default='::', help='key-value separator')

Answer 1

argparse 中只有两个分组工具。互斥组和子解析器。 MEG 的所有操作都是xor。虽然组本身可能是必需的，但其所有操作都必须是可选的。大多数都必须标记(可选)，但一个可能是“可选”位置(是的，术语可能会造成混淆)。

没有提供嵌套组，也没有提供其他逻辑(and、or、any、not 等)。那些已经被要求，我已经在一个补丁上工作，但它离完成还差得很远。其实测试本身并不难；以清晰的方式定义组更难，显示用法也更难。一旦允许嵌套，并尝试考虑所有逻辑可能性，额外代码的数量就会大幅增加。

目前最好的选择是在解析完成后进行自己的测试。只要您使用合理的默认值(例如默认值 None)，这并不难。

有一个内部变量“seen_actions”可以很好地用于此测试，但我还没有找到一种简单的方法让像您这样的程序员可以使用它。我最初扩展组的想法是创建一个 Hook ，让您可以在解析接近尾声时运行自己的函数并访问此变量。

查看边栏中的早期答案。

---

参数组 是一种显示工具 - 它将帮助行分组。您可以在参数组中嵌套互斥组。这有效地为 MEG 提供了一个标题/描述，并将其参数一起显示。但这并不影响使用 或测试。而以另一种方式嵌套是没有意义的。 MEG 嵌套在 MEG 中也是可能的，但最终效果是将所有操作放在一个更大的组中 - 并弄乱了用法(请参阅最近的 Python 错误/问题)。存在的嵌套与其说是设计，不如说是类继承的一个特征。

---

我还想问问大家，您如何在usage 行中表达您的分组？如果需求难以在 usage 中表达，则很难在 argparse 中实现。