Argparse: Erforderliche Argumente unter "optionale Argumente"?

Ich verwende den folgenden einfachen Code, um einige Argumente zu analysieren. Beachten Sie, dass einer von ihnen erforderlich ist. Wenn der Benutzer das Skript ohne Angabe des Arguments ausführt, zeigt der angezeigte Verwendungs- / Hilfetext leider nicht an, dass es ein nicht optionales Argument gibt, was ich sehr verwirrend finde. Wie kann ich Python dazu bringen, anzuzeigen, dass ein Argument nicht optional ist?

Hier ist der Code:

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 )

Wenn ich den obigen Code ohne Angabe des erforderlichen Arguments ausführe, erhalte ich die folgende Ausgabe:

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

Parameter, die mit -oder beginnen, --werden normalerweise als optional betrachtet. Alle anderen Parameter sind Positionsparameter und als solche vom Design erforderlich (wie Positionsfunktionsargumente). Es ist möglich, optionale Argumente zu verlangen, aber dies ist ein bisschen gegen ihr Design. Da sie immer noch Teil der nicht positionellen Argumente sind, werden sie auch dann unter der verwirrenden Überschrift "optionale Argumente" aufgeführt, wenn sie erforderlich sind. Die fehlenden eckigen Klammern im Verwendungsteil zeigen jedoch, dass sie tatsächlich erforderlich sind.

Siehe auch die Dokumentation :

Im Allgemeinen geht das argparse-Modul davon aus, dass Flags wie -f und --bar optionale Argumente angeben, die in der Befehlszeile immer weggelassen werden können.

Hinweis: Erforderliche Optionen werden im Allgemeinen als schlechte Form angesehen, da Benutzer erwarten, dass Optionen optional sind, und sie daher nach Möglichkeit vermieden werden sollten.

Davon abgesehen werden die Überschriften "Positionsargumente" und "optionale Argumente" in der Hilfe von zwei Argumentgruppen generiert, in die die Argumente automatisch unterteilt werden. Jetzt können Sie sich "hineinhacken" und den Namen der optionalen Argumente ändern. Eine weitaus elegantere Lösung wäre jedoch, eine weitere Gruppe für "erforderliche benannte Argumente" (oder wie auch immer Sie sie nennen möchten) zu erstellen:

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

Da ich die erforderlichen Argumente lieber vor dem optionalen auflisten möchte, hacke ich sie herum über:

    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()

und dies gibt aus:

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

required arguments:
  --required_arg REQUIRED_ARG

optional arguments:
  --optional_arg OPTIONAL_ARG

Ich kann leben, ohne dass 'Hilfe' in der Gruppe der optionalen Argumente auftaucht.

Aufbau von @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()

und dies gibt aus:

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

Noch einmal aus @RalphyZ aufbauen

Dieser bricht die exponierte API nicht.

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')

Welches wird das gleiche wie oben zeigen und sollte zukünftige Versionen überleben:

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