# `cmd` — Soporte para intérpretes orientados a línea de comandos

Código fuente: Lib/cmd.py

La clase `Cmd` proporciona un framework simple para escribir intérpretes de comandos orientados a línea. A menudo son útiles para agentes de prueba, herramientas administrativas y prototipos que luego se incluirán en una interfaz más sofisticada.

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

  Una instancia `Cmd` o subclase de la instancia es un framework intérprete orientado a líneas. No hay una buena razón para crear instancias `Cmd`; mas bien, es útil como una super clase de una clase intérprete que usted define con el fin de heredar métodos `Cmd` y encapsular métodos de acción.

  El argumento opcional completekey es el nombre `readline` de una llave de finalización; por defecto es `Tab`. Si completekey no es `None` y `readline` está disponible, el comando de finalización es hecho automáticamente.

  Los argumentos opcionales stdin y stdout especifican la entrada y salida de los objetos archivo que la instancia Cmd o la instancia subclase usará para la entrada y salida. Si no está especificado, se predeterminarán a `sys.stdin` y `sys.stdout`.

  Si desea un stdin dado a ser usado, asegúrese de establecer las instancias atributo `use_rawinput` a `False`, de lo contrario stdin será ignorado.

## Objetos Cmd

Una instancia `Cmd` tiene los siguientes métodos:

`Cmd.``cmdloop`(intro=None)

  Emita repetidamente una solicitud, acepte la entrada, analice un prefijo inicial de la entrada recibida y envíe a los métodos de acción, pasándoles el resto de la línea como argumento.

  El argumento opcional es un banner o cadena de caracteres introductoria que se tramitará antes del primer mensaje (esto anula el atributo de clase `intro`).

  Si el módulo `readline` es cargado, la entrada heredará automáticamente bash-como edición historia-lista (e.g. `Control-P` retorna al último comando, `Control-N` adelanta al siguiente, `Control-F` mueve el cursor a la derecha no destructivamente, `Control-B` mueve el cursor a la izquierda no destructivamente, etc.).

  Un fin-de-archivo en la entrada es retornado como cadena de caracteres `’EOF’`.

  Una instancia del intérprete reconocerá un nombre de comando `foo` si y solo si tiene un método `do_foo()`. Como un caso especial, una línea comenzando con el carácter `’?’` es enviada al método `do_help()`. Como otro caso especial, una línea comenzando con el carácter `’!’` es enviada al método `do_shell()` (Si dicho método está definido).

  Este método retornará cuando el método `postcmd()` retorna un valor verdadero. El argumento stop a `postcmd()` es el valor de retorno de los comandos correspondientes al método `do_*()`.

  Si completar está habilitado, comandos de completar se realizarán automáticamente y la finalización de los comandos args es realizada llamando `complete_foo()` con los argumentos text, line, begidx, y endidx. text es el prefijo de la cadena de caracteres que estamos intentando emparejar: todos los emparejamientos retornados deben comenzar con él. line es la linea de entrada actual con el espacio en blanco inicial eliminado, begidx y endidx son los índices iniciales y finales del texto prefijo, que podrían usarse para proporcionar un completar diferente dependiendo de la posición en la que se encuentre el argumento.

  Todas las subclases de `Cmd` heredan un `do_help()` predefinido. Este método, llamado con el argumento `'bar'`, invoca el método correspondiente `help_bar()`, y si eso no está presente, imprime el docstring de `do_bar()`, si está disponible. Sin argumentos, `do_help()` enumera todos los temas de ayuda disponibles (Es decir, todos los comandos con los métodos correspondientes `help_*()` o los comandos que tienen docstrings), y también enumera cualquier comando no documentado.

`Cmd.``onecmd`(str)

  Interprete el argumento como si hubiera sido escrito en respuesta a la solicitud. Esto puede ser anulado, pero normalmente no debería ser necesario; vea los métodos `precmd()` y `postcmd()` para enlaces de ejecución útiles. El valor de retorno es una bandera que indica si la interpretación de los comandos por parte del intérprete debe detenerse. Si hay un método `do_*()` para el comando str, se retorna el valor de retorno de ese método; de lo contrario, se retorna el valor de retorno del método `default()`.

`Cmd.``emptyline`()

  Método llamado cuando se ingresa una línea vacía en respuesta a la solicitud. Si este método no se anula, repite el último comando no vacío ingresado.

`Cmd.``default`(line)

  Método llamado en una línea de entrada cuando no se reconoce el prefijo del comando. Si este método no se anula, imprime un mensaje de error y retorna.

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

  Método llamado para completar una línea de entrada cuando no hay un comando específico, método `complete_*`()` está disponible. Por defecto, retorna una lista vacía.

`Cmd.``precmd`(line)

  Método de enlace ejecutado justo antes de que se interprete la línea de comando line, pero después de que se genere y emita la solicitud de entrada. Este método es un trozo en `Cmd`; existe para ser anulado por subclases. El valor de retorno es utilizado como el comando que se ejecutará mediante el método `onecmd()`; la implementación `precmd()` puede reescribir el comando o simplemente retornar line sin cambios.

`Cmd.``postcmd`(stop, line)

  Método de enlace ejecutado justo después de que finaliza un despacho de comando. Este método es un trozo en `Cmd`; existe para ser anulado por subclases. line es la línea de comando que se ejecutó, y stop es una bandera que indica si la ejecución finalizará después de la llamada a `postcmd()`; este será el valor de retorno del método `onecmd()`. El valor de retorno de este método será usado como el nuevo valor para la bandera interna que corresponde a stop; retornando falso hará que la interpretación continúe.

`Cmd.``preloop`()

  Método de enlace ejecutado una vez cuando `cmdloop()` es llamado. Este método es un trozo en `Cmd`; existe para ser anulado por subclases.

`Cmd.``postloop`()

  Método de enlace ejecutado una vez cuando `cmdloop()` está a punto de retornar. Este método es un trozo en `Cmd`; existe para ser anulado por subclases.

Instancias de subclases `Cmd` tienen algunas variables de instancia públicas:

`Cmd.``prompt`

  El aviso emitido para solicitar entradas.

`Cmd.``identchars`

  La cadena de caracteres aceptada para el prefijo del comando.

`Cmd.``lastcmd`

  El último prefijo de comando no vacío visto.

`Cmd.``cmdqueue`

  Una lista de líneas de entrada puestas en cola. La lista cmdqueue es verificada en `cmdloop()` cuando una nueva entrada es necesitada; Si es no vacía, sus elementos serán procesados en orden, como si se ingresara en la solicitud.

`Cmd.``intro`

  Una cadena para emitir como introducción o banner. Puede ser anulado dando un argumento al método `cmdloop()`.

`Cmd.``doc_header`

  El encabezado a tramitar si la salida de ayuda tiene una sección para comandos documentados.

`Cmd.``misc_header`

  El encabezado a tramitar si la salida de ayuda tiene una sección para temas de ayuda misceláneos (Es decir, hay métodos `help_*()` sin los métodos correspondientes `do_*()` ).

`Cmd.``undoc_header`

  El encabezado a tramitar si la salida de ayuda tiene una sección para comandos no documentados (Es decir, hay métodos `do_*()` sin los métodos correspondientes `help_*()`).

`Cmd.``ruler`

  El carácter utilizado para dibujar líneas separadoras debajo de los encabezados mensajes-ayuda. Si está vacío, no se dibuja una línea regla. El valor predeterminado es `’=‘`.

`Cmd.``use_rawinput`

  Una bandera, por defecto verdadera. Si es verdadera, `cmdloop()` usa `input()` para mostrar un mensaje y leer el siguiente comando; si es falsa, `sys.stdout.write()` y `sys.stdin.readline()` son usados. (Esto significa que importando `readline`, en sistemas que lo soportan, el intérprete soportará automáticamente Emacs-basados y comandos-historial de teclado.)

## Ejemplo Cmd

El módulo `cmd` es principalmente útil para construir shells personalizados que permiten al usuario trabajar con un programa de forma interactiva.

Esta sección presenta un ejemplo simple de cómo construir un shell alrededor de algunos de los comandos en el módulo `turtle`.

Comandos turtle básicos como `forward()` son añadidos a la subclase `Cmd` con un método llamado `do_forward()`. El argumento es convertido a un número y enviado al módulo turtle. El docstring se utiliza en la utilidad de ayuda proporcionada por el shell.

El ejemplo también incluye un registro básico y facilidad de reproducción implementado con el método `precmd()` el cuál es el responsable de convertir la entrada a minúscula y escribir los comandos en un archivo. El método `do_playback()` lee el archivo y añade los comandos grabados al `cmdqueue` para una reproducción inmediata:

    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()

Aquí hay una sesión de muestra con la turle shell mostrando las funciones de ayuda, de ayuda, usando líneas en blanco para repetir comandos, un registro simple y facilidad de reproducción:

    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