cmd — Поддержка интерпретаторов команд с ориентированными на строку командами

Объекты Cmd

Экземпляр Cmd имеет следующие методы:

Cmd.cmdloop(intro=None)

Повторяет вывод приглашения, принимает входные данные, анализирует начальный префикс полученного ввода и вызывает методы действий, передавая им оставшуюся часть строки в качестве аргумента.

Необязательный аргумент — строка баннера или ввода, которая будет выведена перед первым приглашением (это переопределяет атрибут класса intro).

Если модуль readline загружен, ввод автоматически унаследует редактирование истории в стиле bash (например, Control-P прокручивает назад к последней команде, Control-N вперед к следующей, Control-F перемещает курсор вправо без разрушения, Control-B перемещает курсор влево без разрушения и т. д.).

Конец файла во входных данных передаётся как строка 'EOF'.

Экземпляр интерпретатора распознает имя команды foo только в том случае, если у него есть метод do_foo(). В качестве специального случая, строка, начинающаяся с символа '?' , передается методу do_help(). Еще один специальный случай: строка, начинающаяся с символа '!' , передается методу do_shell() (если такой метод определен).

Этот метод вернётся, когда метод postcmd() вернёт истинное значение. Аргумент stop метода postcmd() — возвращаемое значение из соответствующего метода команды do_*().

Если включена автодополнение, завершение команд будет происходить автоматически, а завершение аргументов команд выполняется путём вызова complete_foo() с аргументами text, line, begidx и endidx. text — строка-префикс, которую мы пытаемся сопоставить: все возвращённые совпадения должны начинаться с неё. line — текущая строка ввода без ведущих пробелов, begidx и endidx — начальный и конечный индексы строки-префикса, которые могут быть использованы для предоставления различного автодополнения в зависимости от позиции аргумента.

Все подклассы Cmd наследуют предварительно определенный do_help(). Этот метод, вызванный с аргументом 'bar', вызывает соответствующий метод help_bar(), а если его нет, выводит строку документации do_bar(), если она доступна. Без аргумента do_help() перечисляет все доступные темы справки (то есть все команды с соответствующими методами help_*() или команды, имеющие строки документации), а также перечисляет все недокументированные команды.

Cmd.onecmd(str)

Интерпретирует аргумент так, как будто он был набран в ответ на приглашение. Это может быть переопределено, но обычно не требуется; см. методы precmd() и postcmd() для полезных функций привязки к выполнению. Возвращаемое значение — флаг, указывающий, следует ли прекратить интерпретацию команд интерпретатором. Если для команды str существует метод do_*() , возвращается значение этого метода, в противном случае возвращается значение метода default().

Cmd.emptyline()

Метод, вызываемый при вводе пустой строки в ответ на приглашение. Если этот метод не переопределён, он повторяет последнюю непустую введённую команду.

Cmd.default(line)

Метод, вызываемый при вводе строки, когда префикс команды не распознаётся. Если этот метод не переопределён, он выводит сообщение об ошибке и возвращает значение.

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

Метод, вызываемый для завершения строки ввода, когда метод автодополнения complete_*() для команды недоступен. По умолчанию он возвращает пустой список.

Cmd.precmd(line)

Метод-обработчик, выполняемый непосредственно перед интерпретацией строки команд line, но после вывода приглашения. Этот метод является заглушкой в Cmd; он предназначен для переопределения подклассами. Возвращаемое значение используется в качестве команды, которая будет выполнена методом onecmd(); реализация precmd() может переписать команду или просто вернуть line без изменений.

Cmd.postcmd(stop, line)

Метод-обработчик, выполняемый сразу после завершения обработки команды. Этот метод является заглушкой в Cmd; он предназначен для переопределения подклассами. line — строка команды, которая была выполнена, а stop — флаг, который указывает, будет ли выполнение завершено после вызова postcmd(); это будет возвращаемое значение метода onecmd(). Возвращаемое значение этого метода будет использоваться в качестве нового значения для внутреннего флага, соответствующего stop; возвращение false приведёт к продолжению интерпретации.

Cmd.preloop()

Метод-обработчик, выполняемый один раз при вызове cmdloop(). Этот метод является заглушкой в Cmd; он предназначен для переопределения подклассами.

Cmd.postloop()

Метод-обработчик, выполняемый один раз при приближении cmdloop() к завершению. Этот метод является заглушкой в Cmd; он предназначен для переопределения подклассами.

Экземпляры подклассов Cmd имеют некоторые публичные переменные экземпляров:

Cmd.prompt

Выводимое приглашение для запроса ввода.

Cmd.identchars

Строка символов, принимаемых для префикса команды.

Cmd.lastcmd

Последний непустой префикс команды, увиденный.

Cmd.cmdqueue

Список очереди команд. Список cmdqueue проверяется в cmdloop() при необходимости нового ввода; если он не пуст, его элементы будут обрабатываться по порядку, как если бы они были введены в приглашении.

Cmd.intro

Строка, которую нужно вывести как вводную или баннер. Может быть переопределена, передав метод cmdloop() аргумент.

Cmd.doc_header

Заголовок, который нужно вывести, если в выводе справки есть раздел для документированных команд.

Cmd.misc_header

Заголовок, который нужно вывести, если в выводе справки есть раздел для дополнительных тем справки (то есть, есть методы help_*() без соответствующих методов do_*()).

Cmd.undoc_header

Заголовок, который нужно вывести, если в выводе справки есть раздел для недокументированных команд (то есть, есть методы do_*() без соответствующих методов help_*()).

Cmd.ruler

Символ, используемый для рисования разделительных линий под заголовками сообщений справки. Если пустая строка, то линейка не рисуется. По умолчанию '='.

Cmd.use_rawinput

Флаг, по умолчанию true. Если true, cmdloop() использует input() для отображения приглашения и чтения следующей команды; если false, используются sys.stdout.write() и sys.stdin.readline(). (Это означает, что импортировав readline на системах, которые его поддерживают, интерпретатор автоматически поддерживает редактирование строк в стиле Emacs и нажатия клавиш для истории команд.)

Пример Cmd

Модуль cmd в основном полезен для создания пользовательских оболочек, которые позволяют пользователю работать с программой интерактивно.

Этот раздел представляет простой пример того, как создать оболочку вокруг нескольких команд в модуле turtle.

Базовые команды черепахи, такие как forward(), добавляются в подкласс Cmd с методом с именем do_forward(). Аргумент преобразуется в число и передаётся в модуль черепахи. Строка документации используется в утилите справки, предоставляемой оболочкой.

Пример также включает в себя базовую систему записи и воспроизведения, реализованную с помощью метода precmd(), который отвечает за преобразование входных данных в нижний регистр и запись команд в файл. Метод do_playback() считывает файл и добавляет записанные команды в cmdqueue для немедленного воспроизведения:

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

Вот пример сеанса работы с оболочкой черепахи, демонстрирующий функции справки, использование пустых строк для повторения команд и простую систему записи и воспроизведения:

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