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_*() или команды, у которых есть doc-строки), а также список недокументированных команд.

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(). Аргумент преобразуется в число и передается модулю черепахи. Строка docstring используется в справочной утилите, предоставляемой оболочкой.

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