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

Все подклассы 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.columnize(list, displaywidth=80)

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

Cmd.precmd(line)

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

Cmd.postcmd(stop, line)

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

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.

Базовые команды 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

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

Ниже приведён пример сеанса работы с оболочкой 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