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

Исходный код: Lib/cmd.py

Класс Cmd предоставляет простую основу для написания интерпретаторов команд с ориентированной на строки обработкой. Они часто полезны для наборов тестов, административных инструментов и прототипов, которые впоследствии будут обернуты в более сложный интерфейс.

class cmd.Cmd(completekey='tab', stdin=None, stdout=None)

Экземпляр класса Cmd или экземпляр подкласса — это фреймворк интерпретатора команд с ориентированной на строки обработкой. Нет веской причины создавать экземпляр Cmd напрямую; он полезен как суперкласс класса интерпретатора, который вы определяете сами, чтобы унаследовать методы Cmd и инкапсулировать методы действий.

Необязательный аргумент completekey — это имя клавиши завершения в readline; по умолчанию это Tab. Если completekey не None и доступен readline, завершение команд выполняется автоматически.

Необязательные аргументы stdin и stdout задают объекты файлов ввода и вывода, которые экземпляр класса Cmd или подкласс будут использовать для ввода и вывода. Если они не указаны, они будут по умолчанию равны sys.stdin и sys.stdout.

Если вы хотите использовать заданный stdin, убедитесь, что атрибут экземпляра use_rawinput установлен в значение False, иначе stdin будет проигнорирован.

1. Объекты 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

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

2. Пример 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