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

Объекты Cmd¶

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

Cmd.cmdloop(intro=None)¶

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

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

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

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

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

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

Если включено завершение, то завершение команд будет выполняться автоматически, а завершение аргументов команд выполняется вызовом complete_foo() с аргументами text, line, begidx и endidx. text - это префикс строки, который мы пытаемся сопоставить: все возвращаемые совпадения должны начинаться с него. строка - это текущая строка ввода с удаленным начальным пробелом, 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() может переписать команду или просто вернуть строку без изменений.

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¶

Список строк ввода в очереди. Список очередей cmd проверяется в 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()

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

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