Argparse: обов'язковий аргумент 'y', якщо 'x' присутній

У мене є така вимога:

./xyifier --prox --lport lport --rport rport

для аргументу prox я використовую action = 'store_true', щоб перевірити, чи він присутній чи ні. Я не вимагаю жодного аргументу. Але якщо встановлено --prox, мені потрібні також rport та lport. Чи існує простий спосіб зробити це з аргументом без написання спеціального умовного кодування.

Більше коду:

non_int.add_argument('--prox', action='store_true', help='Flag to turn on proxy')
non_int.add_argument('--lport', type=int, help='Listen Port.')
non_int.add_argument('--rport', type=int, help='Proxy port.')

Ні, не існує якоїсь - або параметр в argparse , щоб взаємно інклюзивних набори параметрів.

Найпростіший спосіб вирішити це:

if args.prox and (args.lport is None or args.rport is None):
    parser.error("--prox requires --lport and --rport.")

Ви говорите про наявність умовно необхідних аргументів. Як @borntyping сказав, що ви можете перевірити наявність помилок і зробити це parser.error(), або ви можете просто застосувати вимогу, пов’язану з тим, --proxколи додаєте новий аргумент.

Простим рішенням для вашого прикладу може бути:

non_int.add_argument('--prox', action='store_true', help='Flag to turn on proxy')
non_int.add_argument('--lport', required='--prox' in sys.argv, type=int)
non_int.add_argument('--rport', required='--prox' in sys.argv, type=int)

Цей спосіб requiredотримує Trueабо Falseзалежно від того, користувач як використовується --prox. Це також гарантує -lportта -rportмати незалежну поведінку між собою.

Як щодо використання parser.parse_known_args()методу, а потім додавання --lportта --rportаргументи як необхідні аргументи, якщо вони --proxє.

# just add --prox arg now
non_int = argparse.ArgumentParser(description="stackoverflow question", 
                                  usage="%(prog)s [-h] [--prox --lport port --rport port]")
non_int.add_argument('--prox', action='store_true', 
                     help='Flag to turn on proxy, requires additional args lport and rport')
opts, rem_args = non_int.parse_known_args()
if opts.prox:
    non_int.add_argument('--lport', required=True, type=int, help='Listen Port.')
    non_int.add_argument('--rport', required=True, type=int, help='Proxy port.')
    # use options and namespace from first parsing
    non_int.parse_args(rem_args, namespace = opts)

Також пам’ятайте, що ви можете надати простір імен, optsзгенерований після першого розбору, під час аналізу інших аргументів вдруге. Таким чином, врешті-решт, після того, як буде проведено аналіз, у вас буде єдиний простір імен з усіма параметрами.

Недоліки:

• Якщо --proxнемає, інших двох залежних варіантів немає навіть у просторі імен. Незважаючи на те, що виходячи з вашого використання, якщо --proxнемає, те, що відбувається з іншими варіантами, не має значення.
• Потрібно змінити повідомлення про використання, оскільки аналізатор не знає повної структури
• --lportі --rportне відображатись у довідковому повідомленні

Чи використовуєте ви, lportколи proxне встановлено. Якщо ні, то чому б не зробити lportта rportаргументи prox? напр

parser.add_argument('--prox', nargs=2, type=int, help='Prox: listen and proxy ports')

Це дозволяє економити ваші користувачі набравши текст. Це так само , як легко перевірити , if args.prox is not None:як if args.prox:.

Прийнята відповідь спрацювала для мене чудово! Оскільки весь код порушений без тестів, то я перевірив прийняту відповідь. parser.error()не викликає argparse.ArgumentErrorпомилки, натомість виходить із процесу. Ви повинні пройти тестування SystemExit.

при піесті

import pytest
from . import parse_arguments  # code that rasises parse.error()


def test_args_parsed_raises_error():
    with pytest.raises(SystemExit):
        parse_arguments(["argument that raises error"])

з одиничними тестами

from unittest import TestCase
from . import parse_arguments  # code that rasises parse.error()

class TestArgs(TestCase):

    def test_args_parsed_raises_error():
        with self.assertRaises(SystemExit) as cm:
            parse_arguments(["argument that raises error"])

натхненний: Використання unittest для тестування argparse - помилок виходу