cmd – Поддержка построчных интерпретаторов команд¶cmd – Support for line-oriented command interpreters

Объекты Cmd¶Cmd Objects

Экземпляр 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¶

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

Cmd.intro¶

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

Cmd.doc_header¶

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

Cmd.misc_header¶

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

Cmd.undoc_header¶

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

Cmd.ruler¶

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

Cmd.use_rawinput¶

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

Пример ¶ CmdCmd Example

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

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

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

Пример также включает базовую функциональность записи и воспроизведения, реализованную с помощью метода 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

    # ----- основные команды turtle -----
    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

    # ----- запись и воспроизведение -----
    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()

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

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