Argparse: Arguments requis répertoriés sous «arguments facultatifs»?

J'utilise le code simple suivant pour analyser certains arguments; notez que l'un d'eux est obligatoire. Malheureusement, lorsque l'utilisateur exécute le script sans fournir l'argument, le texte d'utilisation / d'aide affiché n'indique pas qu'il existe un argument non facultatif, ce que je trouve très déroutant. Comment puis-je obtenir python pour indiquer qu'un argument n'est pas facultatif?

Voici le 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 )

Lors de l'exécution du code ci-dessus sans fournir l'argument requis, j'obtiens la sortie suivante:

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

Les paramètres commençant par -ou --sont généralement considérés comme facultatifs. Tous les autres paramètres sont des paramètres positionnels et en tant que tels requis par la conception (comme les arguments des fonctions positionnelles). Il est possible d'exiger des arguments facultatifs, mais c'est un peu contraire à leur conception. Puisqu'ils font toujours partie des arguments non positionnels, ils seront toujours répertoriés sous l'en-tête déroutant «arguments facultatifs» même s'ils sont requis. Les crochets manquants dans la partie utilisation montrent cependant qu'ils sont effectivement nécessaires.

Voir aussi la documentation :

En général, le module argparse suppose que des indicateurs comme -f et --bar indiquent des arguments facultatifs, qui peuvent toujours être omis sur la ligne de commande.

Remarque: Les options requises sont généralement considérées comme de mauvaise forme car les utilisateurs s'attendent à ce que les options soient facultatives, et elles doivent donc être évitées dans la mesure du possible.

Cela étant dit, les en-têtes «arguments positionnels» et «arguments facultatifs» dans l'aide sont générés par deux groupes d'arguments dans lesquels les arguments sont automatiquement séparés. Maintenant, vous pouvez "pirater" et changer le nom des options, mais une solution beaucoup plus élégante serait de créer un autre groupe pour "les arguments nommés requis" (ou ce que vous voulez les appeler):

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

Comme je préfère lister les arguments requis avant facultatif, je le pirate via:

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

et cela donne:

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

required arguments:
  --required_arg REQUIRED_ARG

optional arguments:
  --optional_arg OPTIONAL_ARG

Je peux vivre sans que «l'aide» apparaisse dans le groupe d'arguments optionnels.

Construire hors de @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()

et cela donne:

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

Encore une fois, en partant de @RalphyZ

Celui-ci ne casse pas l'API exposée.

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

Qui affichera la même chose que ci-dessus et devrait survivre aux futures versions:

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