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 будет проигнорирован.

Объекты 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() вернёт значение true. Аргумент 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

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

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