Comment implémenter l'option --verbose ou -v dans un script ?

Question

Je sais que le --verbose ou -v de plusieurs outils et j'aimerais l'intégrer à certains de mes propres scripts et outils.

J'ai pensé à placer :

if verbose:
    print ...

par le biais de mon code source, de sorte que si un utilisateur passe l'option -v la variable verbose sera réglé sur True et le texte sera imprimé.

Est-ce la bonne approche ou existe-t-il une méthode plus courante ?

Ajout : Je ne demande pas un moyen d'implémenter le parsing des arguments. Je sais comment cela est fait. Je suis seulement spécialement intéressé par l'option verbose.

Answer 1

Ma suggestion est d'utiliser une fonction. Mais plutôt que de mettre le if dans la fonction, ce que vous pourriez être tenté de faire, faites-le comme ceci :

if verbose:
    def verboseprint(*args):
        # Print each argument separately so caller doesn't need to
        # stuff everything to be printed into a single string
        for arg in args:
           print arg,
        print
else:   
    verboseprint = lambda *a: None      # do-nothing function

(Oui, vous pouvez définir une fonction dans un fichier if et elle ne sera définie que si la condition est vraie !)

Si vous utilisez Python 3, où print est déjà une fonction (ou si vous êtes prêt à utiliser la fonction print comme une fonction dans 2.x en utilisant from __future__ import print_function ), c'est encore plus simple :

verboseprint = print if verbose else lambda *a, **k: None

De cette façon, la fonction est définie comme une fonction qui ne fait rien si le mode verbeux est désactivé (en utilisant une lambda), au lieu de tester constamment la fonction verbose drapeau.

Si l'utilisateur pouvait changer le mode de verbosité pendant l'exécution de votre programme, ce serait la mauvaise approche (vous auriez besoin de la if dans la fonction), mais comme vous le définissez avec un drapeau de ligne de commande, vous ne devez prendre la décision qu'une seule fois.

Vous utilisez alors par exemple verboseprint("look at all my verbosity!", object(), 3) lorsque vous souhaitez imprimer un message "verbeux".

Answer 2

Utilisez le logging module :

import logging as log
…
args = p.parse_args()
if args.verbose:
    log.basicConfig(format="%(levelname)s: %(message)s", level=log.DEBUG)
    log.info("Verbose output.")
else:
    log.basicConfig(format="%(levelname)s: %(message)s")

log.info("This should be verbose.")
log.warning("This is a warning.")
log.error("This is an error.")

Tous ces éléments vont automatiquement à stderr :

% python myprogram.py
WARNING: This is a warning.
ERROR: This is an error.

% python myprogram.py -v
INFO: Verbose output.
INFO: This should be verbose.
WARNING: This is a warning.
ERROR: This is an error.

Pour plus d'informations, voir le Docs Python et le tutoriels .

Answer 3

En construisant et en simplifiant la réponse de @kindall, voici ce que j'utilise généralement :

v_print = None
def main()
    parser = argparse.ArgumentParser()
    parser.add_argument('-v', '--verbosity', action="count", 
                        help="increase output verbosity (e.g., -vv is more than -v)")

    args = parser.parse_args()

    if args.verbosity:
        def _v_print(*verb_args):
            if verb_args[0] > (3 - args.verbosity):
                print verb_args[1]  
    else:
        _v_print = lambda *a: None  # do-nothing function

    global v_print
    v_print = _v_print

if __name__ == '__main__':
    main()

Cela fournit ensuite l'utilisation suivante tout au long de votre script :

v_print(1, "INFO message")
v_print(2, "WARN message")
v_print(3, "ERROR message")

Et votre script peut être appelé comme ceci :

% python verbose-tester.py -v
ERROR message

% python verbose=tester.py -vv
WARN message
ERROR message

% python verbose-tester.py -vvv
INFO message
WARN message
ERROR message

Quelques notes :

1. Le premier argument est le niveau d'erreur, et le second est le message. Il a le nombre magique de 3 qui fixe la limite supérieure de votre journalisation, mais je l'accepte comme un compromis pour la simplicité.
2. Si vous voulez v_print pour fonctionner dans tout votre programme, vous devez faire les cochonneries avec le global. Ce n'est pas drôle, mais je mets au défi quelqu'un de trouver un meilleur moyen.

Answer 4

Dans mes scripts, je vérifie au moment de l'exécution si l'option "verbose" est activée, puis je règle le niveau de journalisation sur "debug". Si l'option n'est pas activée, je la règle sur info. De cette façon, vous n'avez pas de vérifications "if verbose" partout dans votre code.

Answer 5

Il pourrait être plus propre si vous avez une fonction, disons appelée vprint qui vérifie le drapeau verbeux pour vous. Ensuite, vous appelez simplement votre propre vprint à tout endroit où vous souhaitez une verbosité optionnelle.