davidbgk
/
larlet-fr-david

<!doctype html>
<html lang=fr>
<head>
  <!-- Always define the charset before the title -->
  <meta charset=utf-8>
  <title>Un template python pour parser des arguments — Biologeek — David Larlet</title>
  <!-- Define a viewport to mobile devices to use - telling the browser to assume that the page is as wide as the device (width=device-width) and setting the initial page zoom level to be 1 (initial-scale=1.0) -->
  <meta name="viewport" content="width=device-width, initial-scale=1"/>
  <!-- Fake favicon, to avoid extra request to the server -->
  <link rel="icon" href="data:;base64,iVBORw0KGgo=">
  <link type="application/atom+xml" rel="alternate" title="Feed" href="/david/log/" />
  <link rel="manifest" href="/manifest.json">
  
  <link rel="stylesheet" href="/static/david/css/larlet-david-_J6Rv.css" data-instant-track />
  
  <noscript>
    <style type="text/css">
      /* Otherwise fonts are loaded by JS for faster initial rendering. See scripts at the bottom. */
      body {
        font-family: 'EquityTextB', serif;
      }
      h1, h2, h3, h4, h5, h6, time, nav a, nav a:link, nav a:visited {
        font-family: 'EquityCapsB', sans-serif;
        font-variant: normal;
      }
    </style>
  </noscript>
  
  <!-- Canonical URL for SEO purposes -->
  <link rel="canonical" href="https://larlet.fr/david/biologeek/archives/20060218-un-template-python-pour-parser-des-arguments">

</head>
<body>
  <div>
    
    <header>
      <nav>
        <p>
          <small>
            Je suis <a href="/david/" title="Profil public">David Larlet</a>, <a href="/david/pro/" title="Activité professionnelle">artisan</a> du web qui vous <a href="/david/pro/accompagnement/" title="Activité d’accompagnement">accompagne</a><span class="more-infos"> dans l’acquisition de savoirs pour concevoir des <a href="/david/pro/produits-essentiels/" title="Qu’est-ce qu’un produit essentiel ?">produits essentiels</a></span>. <span class="more-more-infos">Discutons ensemble d’une <a href="/david/pro/devis/" title="En savoir plus">non-demande de devis</a>.</span> Je partage ici mes <a href="/david/blog/" title="Expériences bienveillantes">réflexions</a> et <a href="/david/correspondances/2017/" title="Lettres hebdomadaires">correspondances</a>.
          </small>
        </p>
      </nav>
    </header>
    
    
  <section>
    <h1 property="schema:name">Un template python pour parser des arguments</h1>
    <article typeof="schema:BlogPosting">
      <div property="schema:articleBody">
        <img src="/static/david/biologeek/images/logos/python_nouveau.png" alt="vignette" style="float:left; margin: 0.5em 1em;" property="schema:thumbnailUrl" />
        <p>En réaction au billet de <a href="http://blog.virgule.info/2006/02/17/137-convertisseur-em-vers-pixels">mat qui a codé un convertisseur em vers pixels</a>. 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&nbsp;!</p>

<pre>#!/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()</pre>

<p>Et la même chose en <a href="http://vrac.biologeek.com/template_python.txt">fichier texte</a> si vous souhaitez l'utiliser.</p>

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

<p>Voila ce que ce même template donnerait avec l'utilisation de ce module&nbsp;:</p>

<pre>#!/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()</pre>

<p>Simple, concis, bref à utiliser. <a href="http://www.la-grange.net/2003/10/29.html#python">Karl en parlait déjà</a> il y a plus de deux ans...</p>
      </div>
    </article>
    <footer>
      <h6 property="schema:datePublished">— 18/02/2006</h6>
    </footer>
  </section>
  <section>
    <div>
      <h3>Articles peut-être en rapport</h3>
      <ul>
        <li><a href="/david/biologeek/archives/20080511-bonnes-pratiques-et-astuces-python/" title="Accès à Bonnes pratiques et astuces Python">Bonnes pratiques et astuces Python</a></li>
        <li><a href="/david/biologeek/archives/20061025-benchmarks-map-filter-vs-list-comprehensions/" title="Accès à Benchmarks map, filter vs. list-comprehensions">Benchmarks map, filter vs. list-comprehensions</a></li>
        <li><a href="/david/biologeek/archives/20060425-python-et-underscore/" title="Accès à Python : lisibilité vs simplicité">Python : lisibilité vs simplicité</a></li>
      </ul>
    </div>
  </section>
  <section>
    <div id="comments">
      <h3>Commentaires</h3>
      
<div class="comment" typeof="schema:UserComments">
    <p class="comment-meta">
        <span class="comment-author" property="schema:creator">mat</span> le <span class="comment-date" property="schema:commentTime">18/02/2006</span> :
    </p>
    <div class="comment-content" property="schema:commentText">
        <p>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)<br />
<br />
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...</p>
    </div>
</div>
<div class="comment" typeof="schema:UserComments">
    <p class="comment-meta">
        <span class="comment-author" property="schema:creator">David, biologeek</span> le <span class="comment-date" property="schema:commentTime">18/02/2006</span> :
    </p>
    <div class="comment-content" property="schema:commentText">
        <p>« optparse is a more convenient, flexible, and powerful library for parsing command-line options than getopt. »<br />
<br />
Ok je vais jetter un œil à ça, un edit est très probable :)</p>
    </div>
</div>
<div class="comment" typeof="schema:UserComments">
    <p class="comment-meta">
        <span class="comment-author" property="schema:creator">bubu</span> le <span class="comment-date" property="schema:commentTime">20/08/2008</span> :
    </p>
    <div class="comment-content" property="schema:commentText">
        <p>Helas optparse n&#39;est pas internationalisé, et pose des problemes avec les caracteres speciaux.</p>
    </div>
</div>

    </div>
  </section>

    
    <footer>
      <nav>
        <p>
          <small>
            Je réponds quasiment toujours aux <a href="m&#x61;ilto:d&#x61;vid%40l&#x61;rlet&#46;fr" title="Envoyer un email">emails</a> (<a href="/david/signature/" title="Ma signature actuelle avec possibilité de chiffrement">signés</a>) et vous pouvez me rencontrer à Montréal. <span class="more-infos">N’hésitez pas à <a href="/david/log/" title="Être tenu informé des mises à jour">vous abonner</a> pour être tenu informé des publications récentes.</span>
          </small>
        </p>
      </nav>
    </footer>
    
  </div>
  
  <script src="/static/david/js/larlet-david-3ee43f.js" data-no-instant></script>
  
  <script data-no-instant>InstantClick.init()</script>
  
</body>
</html>