อาร์กิวเมนต์: อาร์กิวเมนต์ที่จำเป็นแสดงรายการอยู่ภายใต้“ อาร์กิวเมนต์ที่เลือกได้” หรือไม่

ฉันใช้รหัสง่าย ๆ ต่อไปนี้เพื่อแยกอาร์กิวเมนต์บางอย่าง โปรดทราบว่าจำเป็นต้องใช้หนึ่งในนั้น น่าเสียดายที่เมื่อผู้ใช้รันสคริปต์โดยไม่ได้ระบุอาร์กิวเมนต์ข้อความการใช้งาน / ช่วยเหลือที่แสดงไม่ได้ระบุว่ามีอาร์กิวเมนต์ที่ไม่จำเป็นซึ่งฉันพบว่าสับสนมาก ฉันจะรับไพ ธ อนเพื่อระบุว่าการโต้แย้งนั้นไม่จำเป็นหรือไม่?

นี่คือรหัส:

import argparse
if __name__ == '__main__':
    parser = argparse.ArgumentParser(
        description='Foo')
    parser.add_argument('-i','--input', help='Input file name', required=True)
    parser.add_argument('-o','--output', help='Output file name', default="stdout")
    args = parser.parse_args()
    print ("Input file: %s" % args.input )
    print ("Output file: %s" % args.output )

เมื่อรันโค้ดข้างต้นโดยไม่ต้องระบุอาร์กิวเมนต์ที่ต้องการฉันจะได้ผลลัพธ์ต่อไปนี้:

usage: foo.py [-h] -i INPUT [-o OUTPUT]

Foo

optional arguments:
    -h, --help            show this help message and exit
    -i INPUT, --input INPUT
                          Input file name
    -o OUTPUT, --output OUTPUT
                          Output file name

พารามิเตอร์เริ่มต้นด้วย-หรือ--มักจะถือว่าเป็นตัวเลือก พารามิเตอร์อื่น ๆ ทั้งหมดเป็นพารามิเตอร์ตำแหน่งและตามที่ต้องการโดยการออกแบบ (เช่นอาร์กิวเมนต์ตำแหน่งฟังก์ชัน) เป็นไปได้ที่จะต้องมีอาร์กิวเมนต์ที่เป็นตัวเลือก แต่สิ่งนี้ขัดแย้งกับการออกแบบของพวกเขาเล็กน้อย เนื่องจากพวกเขายังคงเป็นส่วนหนึ่งของการขัดแย้งที่ไม่ใช่ตำแหน่งพวกเขาจะยังคงอยู่ภายใต้หัวข้อ "การมีตัวเลือกเสริม" ที่สับสนแม้ว่าพวกเขาจะต้อง เครื่องหมายวงเล็บเหลี่ยมที่ขาดหายไปในส่วนการใช้งานแสดงให้เห็นว่าจำเป็นต้องมี

ดูเอกสารประกอบ :

โดยทั่วไปโมดูล argparse จะถือว่าค่าสถานะเช่น -f และ --bar บ่งชี้ว่ามีอาร์กิวเมนต์ตัวเลือกซึ่งสามารถละเว้นได้ที่บรรทัดคำสั่ง

หมายเหตุ:ตัวเลือกที่จำเป็นโดยทั่วไปถือว่าเป็นรูปแบบที่ไม่ดีเนื่องจากผู้ใช้คาดหวังว่าตัวเลือกจะเป็นตัวเลือกและควรหลีกเลี่ยงเมื่อเป็นไปได้

ที่ถูกกล่าวว่าส่วนหัว"ข้อโต้แย้งตำแหน่ง"และ"ข้อโต้แย้งทางเลือก"ในความช่วยเหลือจะถูกสร้างขึ้นโดยกลุ่มอาร์กิวเมนต์สองกลุ่มซึ่งข้อโต้แย้งจะถูกแยกออกโดยอัตโนมัติ ตอนนี้คุณสามารถ“ แฮ็คมันได้” และเปลี่ยนชื่อของตัวเลือกเสริมได้ แต่วิธีแก้ปัญหาที่สง่างามกว่านั้นก็คือการสร้างกลุ่มอื่นสำหรับ

parser = argparse.ArgumentParser(description='Foo')
parser.add_argument('-o', '--output', help='Output file name', default='stdout')
requiredNamed = parser.add_argument_group('required named arguments')
requiredNamed.add_argument('-i', '--input', help='Input file name', required=True)
parser.parse_args(['-h'])

usage: [-h] [-o OUTPUT] -i INPUT

Foo

optional arguments:
  -h, --help            show this help message and exit
  -o OUTPUT, --output OUTPUT
                        Output file name

required named arguments:
  -i INPUT, --input INPUT
                        Input file name

เนื่องจากฉันต้องการแสดงรายการอาร์กิวเมนต์ที่ต้องการก่อนตัวเลือกฉันจึงแฮ็กมันผ่าน:

    parser = argparse.ArgumentParser()
    parser._action_groups.pop()
    required = parser.add_argument_group('required arguments')
    optional = parser.add_argument_group('optional arguments')
    required.add_argument('--required_arg', required=True)
    optional.add_argument('--optional_arg')
    return parser.parse_args()

และผลลัพธ์นี้:

usage: main.py [-h] [--required_arg REQUIRED_ARG]
               [--optional_arg OPTIONAL_ARG]

required arguments:
  --required_arg REQUIRED_ARG

optional arguments:
  --optional_arg OPTIONAL_ARG

ฉันสามารถอยู่ได้โดยปราศจาก 'ความช่วยเหลือ' แสดงในกลุ่มอาร์กิวเมนต์ที่เป็นทางเลือก

อาคารนอกของ @Karl Rosaen

parser = argparse.ArgumentParser()
optional = parser._action_groups.pop() # Edited this line
required = parser.add_argument_group('required arguments')
# remove this line: optional = parser...
required.add_argument('--required_arg', required=True)
optional.add_argument('--optional_arg')
parser._action_groups.append(optional) # added this line
return parser.parse_args()

และผลลัพธ์นี้:

usage: main.py [-h] [--required_arg REQUIRED_ARG]
           [--optional_arg OPTIONAL_ARG]

required arguments:
  --required_arg REQUIRED_ARG

optional arguments:
  -h, --help                    show this help message and exit
  --optional_arg OPTIONAL_ARG

อีกครั้งหนึ่งที่สร้างจาก @RalphyZ

อันนี้ไม่ผิด API ที่เปิดเผย

from argparse import ArgumentParser, SUPPRESS
# Disable default help
parser = ArgumentParser(add_help=False)
required = parser.add_argument_group('required arguments')
optional = parser.add_argument_group('optional arguments')

# Add back help 
optional.add_argument(
    '-h',
    '--help',
    action='help',
    default=SUPPRESS,
    help='show this help message and exit'
)
required.add_argument('--required_arg', required=True)
optional.add_argument('--optional_arg')

ซึ่งจะแสดงเช่นเดียวกับด้านบนและควรอยู่รอดเวอร์ชันในอนาคต:

usage: main.py [-h] [--required_arg REQUIRED_ARG]
           [--optional_arg OPTIONAL_ARG]

required arguments:
  --required_arg REQUIRED_ARG

optional arguments:
  -h, --help                    show this help message and exit
  --optional_arg OPTIONAL_ARG