Argparse: อาร์กิวเมนต์ที่ต้องการ 'y' ถ้า 'x' มีอยู่

ฉันมีข้อกำหนดดังต่อไปนี้:

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

สำหรับอาร์กิวเมนต์ prox ฉันใช้ action = 'store_true' เพื่อตรวจสอบว่ามีอยู่หรือไม่ ฉันไม่ต้องการข้อโต้แย้งใด ๆ แต่ถ้าตั้งค่า--prox ฉันต้องการ rport และ lport ด้วย มีวิธีง่ายๆในการทำเช่นนี้ด้วย argparse โดยไม่ต้องเขียนโค้ดตามเงื่อนไขที่กำหนดเอง

รหัสเพิ่มเติม:

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และ--rportargs เป็น args ที่ต้องการถ้า--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ไม่มีอยู่สิ่งที่เกิดขึ้นกับตัวเลือกอื่น ๆ ก็ไม่เกี่ยวข้อง
• ต้องแก้ไขข้อความการใช้งานเนื่องจาก parser ไม่ทราบโครงสร้างทั้งหมด
• --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คุณจะต้องทดสอบ

ด้วย pytest

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"])

กับ unittests

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 - exit