argparse note

Une note sur argparse, l'outil d'analyse de ligne de commande Python

référence

Manuel, Tutoriel

Cas d'utilisation typique

import argparse

def main():
    parser = argparse.ArgumentParser(
        formatter_class=argparse.RawDescriptionHelpFormatter,
        description="Concatenates a person's files",
        epilog='''Notices:
    1. You need an account first.
    2. Files should exist.
'''
    )
    parser.add_argument(
        '-o', '--outfile', default='foo.txt', help='Output file name')
    parser.add_argument(
        '-q', '--quiet', action='store_true', dest='qFlag',
        help='No messages to console')
    parser.add_argument(
        '-r', '--repeat', type=int, default=1, help='Repeat count')
    parser.add_argument(
        '-m', '--mode', required=True, choices=['t', 'b'], help='Mode')
    parser.add_argument('person', help='Person name')
        # mandatory positional argument
    parser.add_argument('infile', nargs='*', help='Input file name')
        # '+' can also be used for nargs
    group = parser.add_mutually_exclusive_group(required=True)
    group.add_argument('--private', action='store_true')
    group.add_argument('--public',  action='store_true')
    args = parser.parse_args()

    print(f'outfile = {args.outfile}')            # long name is prefered
    print(f'quiet = {args.qFlag}')                # dest='qFlag'
    print(f'repeat count = {args.repeat * 100}')  # type=int
    print(f'# of infiles = {len(args.infile)}')   # stored as a list

main()

Exemple d'exécution

$ ./a.py -m t --private uid a b c
outfile = foo.txt
quiet = False
repeat count = 100
# of infiles = 3

point

• Facultatif s'il commence par un trait d'union. Sinon, le paramètre de position
• Lors de l'utilisation, accédez avec ʻargs. Name`.
• La priorité est donnée aux noms de deux caractères ou plus.
• Il peut également être spécifié par dest.
• La valeur par défaut de l'option est default = value
• L'indicateur Vrai / Faux est ʻaction = 'store_true'`
• Si type = int, cela devient un entier.
• L'option facultative est required = True
• La sélection parmi les spécifiés est choix = liste
• Les spécifications multiples sont `` nargs = '*' 'et `nargs =' + ''
• Les options qui ne peuvent pas être spécifiées en même temps sont créées avec ʻadd_mutually_exclusive_group`.
• la description est remplie de blancs et de sauts de ligne, mais ce n'est pas le cas si vous spécifiez formatter_argparse.RawDescriptionHelpFormatter.