24.2. "cmd" — Interpréteurs en ligne de commande.
*************************************************

**Code source:** Lib/cmd.py

======================================================================

La "Cmd" fournit une base simple permettant d'écrire des interpréteurs
en ligne de commande. Ceux-ci sont souvent utiles pour piloter des
tests, pour des outils administratifs, et pour des prototypes destinés
à être intégrés à une interface plus sophistiquée.

class cmd.Cmd(completekey='tab', stdin=None, stdout=None)

   Une instance de "Cmd" ou d'une classe en héritant est un
   *framework* orienté ligne de commande. Il n'y a pas de bonne raison
   d'instancier "Cmd" directement. Elle est plutôt utile en tant que
   classe mère d'une classe-interprète que vous définirez afin
   d'hériter des méthodes de "Cmd" et d'encapsuler les opérations.

   L'argument facultatif *completekey* est le nom "readline" d'une
   touche de complétion. Si *completekey* ne vaut pas "None" et que
   "readline" est disponible, la complétion de commandes est faite
   automatiquement.

   Les arguments facultatifs *stdin* et *stdout* spécifient les
   objets-fichiers de lecture et d'écriture que l'instance de Cmd ou
   d'une classe fille utilisera comme entrée et sortie. Si ces
   arguments ne sont pas spécifiés, ils prendront comme valeur par
   défaut "sys.stdin" et "sys.stdout".

   Si vous souhaitez qu'un *stdin* donné soit utilisé, assurez-vous
   que l'attribut "use_rawinput" de l'instance vaille "False", faute
   de quoi *stdin* sera ignoré.


24.2.1. Objets Cmd
==================

Une instance de "Cmd" possède les méthodes suivantes :

Cmd.cmdloop(intro=None)

   Affiche une invite de commande de manière répétée, accepte une
   entrée, soustrait un préfixe initial de l'entrée reçue et envoie
   aux méthodes d'opération la partie restante de l'entrée reçue.

   L'argument facultatif est une bannière ou chaîne de caractères
   d'introduction à afficher avant la première invite de commande (il
   redéfinit l'attribut de classe "intro").

   Si le module "readline" est chargé, l'entrée héritera
   automatiquement d'une édition d'historique similaire à **bash**
   (Par exemple, "Control-P" reviendra à la dernière commande,
   "Control-N" avancera à la suivante, "Control-F" déplace le curseur
   vers la droite, "Control-B" déplace le curseur vers la gauche,
   etc...).

   Une caractère de fin de fichier est transmis via la chaîne de
   caractères "'EOF'".

   Une instance d'un interpréteur reconnaîtra un nom de commande "foo"
   si et seulement si celle-ci possède une méthode "do_foo()". Les
   lignes commençant par le caractère "'?'" sont un cas particulier:
   elles sont envoyées à la méthode "do_help()". Les lignes commençant
   par le caractère "'!'" sont également un cas particulier: elles
   sont envoyées à la méthode "do_shell()" (si une telle méthode est
   définie).

   Cette méthode ne s'arrêtera que lorsque "postcmd()" renverra une
   valeur vraie. L'argument *stop* de "postcmd()" est la valeur de
   retour de la méthode "do_*()" correspondant à la commande.

   Si la complétion est activée, la complétion de commandes sera faite
   automatiquement; et la complétion d'arguments sera faite en
   appelant "complete_foo()" avec les arguments *text*, *line*,
   *begidx*, et *endidx*. *text* est le préfixe que nous cherchons à
   faire coïncider: toutes les valeurs renvoyées doivent commencer par
   ce préfixe. *line* est la ligne d'entrée actuelle sans les espaces
   blancs de début. *begidx* et *endidx* sont les index de début et de
   fin du préfixe, ils pourraient être utilisés pour fournir
   différentes complétions en fonction de la position de l'argument.

   Toutes les classes filles de "Cmd" héritent d'une méthode
   "do_help()" prédéfinie. Cette méthode appellera la méthode
   "help_bar()" lorsqu'elle est appelée avec un argument "'bar'". Si
   celle-ci n'est pas définie, elle affichera la *docstring* de
   "do_bar()", (si elle a une *docstring*). Sans argument, "do_help()"
   listera tous les sujets d'aide (c'est à dire, toutes les commandes
   avec une méthode "help_\*()" correspondante ou commande ayant une
   *docstring*, elle lisera aussi les commandes non documentées.

Cmd.onecmd(str)

   Interprète l'argument comme si il avait été entré en réponse à
   l'invite de commande. Cette méthode peut être surchargée, mais ne
   devrait normalement pas avoir besoin de l'être; voir les méthodes
   "precmd()" et "postcmd()" pour altérer l'exécution d'une commande.
   La valeur de retour est un *flag* indiquant si l'interprétation de
   commandes par l'interpréteur devrait arrêter. S'il existe une
   méthode "do_*()" pour la commande *str*, la valeur de retour de
   cette méthode est renvoyée. Dans le cas contraire, la valeur de
   retour de la méthode "default()" est renvoyée.

Cmd.emptyline()

   Méthode appelée quand une ligne vide est entrée en réponse à
   l'invite de commande. Si cette méthode n'est pas surchargée, elle
   répète la dernière commande non-vide entrée.

Cmd.default(line)

   Méthode appelée lorsque le préfixe de commande d'une ligne entrée
   n'est pas reconnu. Si cette méthode n'est pas surchargée, elle
   affiche un message d'erreur et s'arrête.

Cmd.completedefault(text, line, begidx, endidx)

   Méthode appelée pour compléter une ligne entrée quand aucune
   méthode "complete_*()" spécifique à la commande n'est disponible.
   Par défaut, elle renvoie une liste vide.

Cmd.precmd(line)

   Méthode de rappel exécutée juste avant que la ligne de commande
   *line* ne soit interprétée, mais après que l'invite de commande ait
   été généré et affiché. Cette méthode existe afin d'être surchargée
   par des classes filles de "Cmd". La valeur de retour est utilisée
   comme la commande qui sera exécutée par la méthode "onecmd()".
   L'implémentation de "precmd()" peut réécrire la commande ou
   simplement renvoyer *line* sans modification.

Cmd.postcmd(stop, line)

   Méthode de rappel exécutée juste après qu'une commande ait été
   exécutée. Cette méthode existe afin d'être surchargée par des
   classes filles de "Cmd". *line est la ligne de commande ayant été
   exécutée et *stop* est un *flag* indiquant si l'exécution sera
   terminée après un appel à "postcmd()". *stop* sera la valeur de
   retour de "onecmd()". La valeur de retour de cette méthode sera
   utilisée comme nouvelle valeur pour le *flag* interne correspondant
   à *stop*. Renvoyer *False* permettra à l'interprétation de
   continuer.

Cmd.preloop()

   Méthode de rappel exécutée une fois lorsque "cmdloop()" est
   appelée. Cette méthode existe afin d'être surchargée par des
   classes filles de "Cmd".

Cmd.postloop()

   Méthode de rappel exécutée une fois lorsque "cmdloop()" va
   s'arrêter. Cette méthode existe afin d'être surchargée par des
   classes filles de "Cmd".

Les instances de classes filles de "Cmd" possèdent des variables
d'instance publiques:

Cmd.prompt

   L'invite de commande affiché pour solliciter une entrée.

Cmd.identchars

   La chaîne de caractères acceptée en tant que préfixe de commande.

Cmd.lastcmd

   Le dernier préfixe de commande non-vide vu.

Cmd.cmdqueue

   Une liste de lignes entrées en file. La liste *cmdqueue* est
   vérifiée dans "cmdloop()" lorsqu'une nouvelle entrée est
   nécessitée; si elle n'est pas vide, ses éléments seront traités
   dans l'ordre, comme si ils avaient entrés dans l'invite de
   commande.

Cmd.intro

   Une chaîne de caractères à afficher en introduction ou bannière.
   Peut être surchargée en passant un argument à la méthode
   "cmdloop()".

Cmd.doc_header

   L'en-tête à afficher si la sortie de l'aide possède une section
   pour les commandes documentées.

Cmd.misc_header

   L'en-tête à afficher si la sortie de l'aide possède une section
   pour divers sujets (c'est-à-dire qu'il existe des méthodes
   "help_*()" sans méthodes "do_*()" correspondantes).

Cmd.undoc_header

   L'en-tête à afficher si la sortie de l'aide possède une section
   pour les commandes non documentées (c'est-à-dire qu'il existe des
   méthodes "dop_*()" sans méthodes "help_*()" correspondantes).

Cmd.ruler

   Le caractère utilisé pour afficher des lignes de séparation sous
   les en-têtes de messages d'aide. Si il est vide, aucune ligne de
   séparation n'est affichée. Par défaut, ce caractère vaut "'='".

Cmd.use_rawinput

   Un *flag*, valant *True* par défaut. Si ce *flag* est vrai,
   "cmdloop()" utilise "input()" pour afficher une invite de commande
   et lire la prochaine commande; si il est faux, "sys.stdout.write()"
   et "sys.stdin.readline()" sont utilisées. (Cela signifie qu'en
   important "readline" sur les systèmes qui le supportent,
   l'interpréteur va automatiquement supporter une édition de ligne
   similaire à **Emacs** ainsi que des touches d'historique de
   commande).


24.2.2. Exemple
===============

Le module "cmd" est utile pour produire des invites de commande
permettant à l'utilisateur de travailler avec un programme de manière
interactive.

Cette section présente un exemple simple de comment produire une
invite de commande autour de quelques commandes du module "turtle".

Des commandes *turtle* basiques telles que "forward()" sont ajoutées à
une classe fille de "Cmd" avec la méthode appelée "do_forward()".
L'argument est converti en nombre et envoyé au module *turtle*. La
*docstring* est utilisée dans l'utilitaire d'aide fourni par l'invite
de commande.

L'exemple inclut également un utilitaire d'enregistrement et de
*playback* implémenté avec la méthode "precmd()", qui est responsable
du passage de l'entrée en minuscules ainsi que d'écrire les commandes
dans un fichier. La méthode "do_playback()" lit le fichier et ajoute
les commandes enregistrées à "cmdqueue" pour être rejouées
immédiatement :

   import cmd, sys
   from turtle import *

   class TurtleShell(cmd.Cmd):
       intro = 'Welcome to the turtle shell.   Type help or ? to list commands.\n'
       prompt = '(turtle) '
       file = None

       # ----- basic turtle commands -----
       def do_forward(self, arg):
           'Move the turtle forward by the specified distance:  FORWARD 10'
           forward(*parse(arg))
       def do_right(self, arg):
           'Turn turtle right by given number of degrees:  RIGHT 20'
           right(*parse(arg))
       def do_left(self, arg):
           'Turn turtle left by given number of degrees:  LEFT 90'
           left(*parse(arg))
       def do_goto(self, arg):
           'Move turtle to an absolute position with changing orientation.  GOTO 100 200'
           goto(*parse(arg))
       def do_home(self, arg):
           'Return turtle to the home position:  HOME'
           home()
       def do_circle(self, arg):
           'Draw circle with given radius an options extent and steps:  CIRCLE 50'
           circle(*parse(arg))
       def do_position(self, arg):
           'Print the current turtle position:  POSITION'
           print('Current position is %d %d\n' % position())
       def do_heading(self, arg):
           'Print the current turtle heading in degrees:  HEADING'
           print('Current heading is %d\n' % (heading(),))
       def do_color(self, arg):
           'Set the color:  COLOR BLUE'
           color(arg.lower())
       def do_undo(self, arg):
           'Undo (repeatedly) the last turtle action(s):  UNDO'
       def do_reset(self, arg):
           'Clear the screen and return turtle to center:  RESET'
           reset()
       def do_bye(self, arg):
           'Stop recording, close the turtle window, and exit:  BYE'
           print('Thank you for using Turtle')
           self.close()
           bye()
           return True

       # ----- record and playback -----
       def do_record(self, arg):
           'Save future commands to filename:  RECORD rose.cmd'
           self.file = open(arg, 'w')
       def do_playback(self, arg):
           'Playback commands from a file:  PLAYBACK rose.cmd'
           self.close()
           with open(arg) as f:
               self.cmdqueue.extend(f.read().splitlines())
       def precmd(self, line):
           line = line.lower()
           if self.file and 'playback' not in line:
               print(line, file=self.file)
           return line
       def close(self):
           if self.file:
               self.file.close()
               self.file = None

   def parse(arg):
       'Convert a series of zero or more numbers to an argument tuple'
       return tuple(map(int, arg.split()))

   if __name__ == '__main__':
       TurtleShell().cmdloop()

Voici une session d'exemple avec l'invite de commande *turtle*. Elle
montre les fonctions d'aide, utilise les lignes vides pour répéter des
commandes et montre l'utilitaire de *playback*:

   Welcome to the turtle shell.   Type help or ? to list commands.

   (turtle) ?

   Documented commands (type help <topic>):
   ========================================
   bye     color    goto     home  playback  record  right
   circle  forward  heading  left  position  reset   undo

   (turtle) help forward
   Move the turtle forward by the specified distance:  FORWARD 10
   (turtle) record spiral.cmd
   (turtle) position
   Current position is 0 0

   (turtle) heading
   Current heading is 0

   (turtle) reset
   (turtle) circle 20
   (turtle) right 30
   (turtle) circle 40
   (turtle) right 30
   (turtle) circle 60
   (turtle) right 30
   (turtle) circle 80
   (turtle) right 30
   (turtle) circle 100
   (turtle) right 30
   (turtle) circle 120
   (turtle) right 30
   (turtle) circle 120
   (turtle) heading
   Current heading is 180

   (turtle) forward 100
   (turtle)
   (turtle) right 90
   (turtle) forward 100
   (turtle)
   (turtle) right 90
   (turtle) forward 400
   (turtle) right 90
   (turtle) forward 500
   (turtle) right 90
   (turtle) forward 400
   (turtle) right 90
   (turtle) forward 300
   (turtle) playback spiral.cmd
   Current position is 0 0

   Current heading is 0

   Current heading is 180

   (turtle) bye
   Thank you for using Turtle
