# Un template python pour parser des arguments

En réaction au billet de mat qui a codé un convertisseur em vers pixels. Je me demande souvent si la méthode que j'emploie est la plus pertinente pour parser des arguments en ligne de commande lorsque je crée des petits scripts en python. Voici le template que j'utilise souvent, toutes les remarques en commentaire sont les bienvenues !

    #!/usr/bin/python
    # -*- coding: iso-8859-1 -*-

    """
    Explain what program do.
    """

    import os
    import sys
    from textwrap import wrap
    from getopt import getopt

    # Global default settings, had to be get/set with appopriate functions
    settings = {
        "verbose" : False,          # -v  option
        "other_option" : ""         # -o: option
    }
    def set_settings(key, value): settings[key] = value
    def get_settings(key): return settings[key]

    def verify_arguments_existence():
        """ For each command line argument, check existence if necessary """
        if get_settings("other_option") == "":
            set_settings("other_option", "default")

    def parse_arguments():
        shortopts = "".join([opt[0] for opt in options])
        longopts = [opt[1] for opt in options]
        opts, args = getopt(sys.argv[1:], shortopts, longopts)
        for opt, optarg in opts:
            for tuple in options:
                short = "-" + tuple[0][:1]
                long = "--" + tuple[1]
                if long.endswith("="):
                    long = long[:-1]
                if opt in [short, long]:
                    tuple[2](optarg)
                    break

    def print_help(*args):
        print "USAGE:
       %s [options]
    " % sys.argv[0]
        print "OPTIONS:"
        for short, long, func, doc in options:
            print
            if short[-1] == ":":
                print "  -%s filename, --%sfilename" % (short[:1], long)
            else:
                print "  -%s, --%s" % (short[:1], long)
            for line in wrap(doc):
                print "    %s" % line
        print "
    EXAMPLE:"
        print "   %s -v -o:argument
    " % sys.argv[0]
        sys.exit(0)

    # Syntax : short option, long option, action, help
    options = [
        ("h", "help", print_help,
         "Print out this usage summary."),

        ("v", "verbose", lambda optarg: set_settings("verbose", True),
         "Write output informations (not only errors)."),

        ("o:", "other-option=", lambda optarg: set_settings("other_option", optarg),
         "Another option for the template.")
    ]

    def main():
        """ Main function, deals with arguments and launch program"""
        # Usual verifications and warnings
        if not sys.argv[1:]:
            sys.stdout.write("Sorry: you must specify at least an argument
    ")
            sys.stdout.write("More help avalaible with -h or --help option
    ")
            sys.exit(0)
        parse_arguments()
        verify_arguments_existence()

        # THE program :-)
        if get_settings("verbose"):
            print "Hello verbose Word !"
        else:
            print "Hello Word !"

    if __name__ == '__main__':
        main()

Et la même chose en fichier texte si vous souhaitez l'utiliser.

[edit] : J'ai encore perdu une occasion de me taire Je suis heureux d'avoir appris l'existence d'un nouveau module, effectivement optparse permet de parser les arguments en ligne de commande très facilement du coup mon template ne sert plus à rien ;-)

Voila ce que ce même template donnerait avec l'utilisation de ce module :

    #!/usr/bin/python
    # -*- coding: iso-8859-1 -*-

    """
    Explain what program do.
    """

    import os
    import sys
    from optparse import OptionParser

    def main():
        """ Main function, deals with arguments and launch program"""
        # Usual verifications and warnings
        if not sys.argv[1:]:
            sys.stdout.write("Sorry: you must specify at least an argument
    ")
            sys.stdout.write("More help avalaible with -h or --help option
    ")
            sys.exit(0)

        parser = OptionParser()
        parser.add_option("-v", "--verbose", action="store_true",
            help="Write output informations (not only errors).",
            default=False)

        parser.add_option("-f", "--file", help="Create a xxx file.")

        (options, args) = parser.parse_args()

        # THE program :-)
        if options.verbose:
            print "Hello verbose Word !"
        else:
            print "Hello Word !"

    if __name__ == '__main__':
        main()

Simple, concis, bref à utiliser. Karl en parlait déjà il y a plus de deux ans...

### Articles peut-être en rapport

- Bonnes pratiques et astuces Python
- Benchmarks map, filter vs. list-comprehensions
- Python : lisibilité vs simplicité

### Commentaires

mat le 18/02/2006 :

Bah moi j'ai fait betement en copiant collant la doc, ne connaissant que tres peu python et n'ayant pas envie de me prendre la tete avec ca (le script était deja fini quand j'ai rajouté la gestion des arguments)
La doc python mentionnait optparse, qui a l'air plus complet, tu devrais ptet plutot zieuter par la pour un truc un peu plus complet et plus robuste...

David, biologeek le 18/02/2006 :

« optparse is a more convenient, flexible, and powerful library for parsing command-line options than getopt. »
Ok je vais jetter un œil à ça, un edit est très probable :)

bubu le 20/08/2008 :

Helas optparse n'est pas internationalisé, et pose des problemes avec les caracteres speciaux.