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; возвращение 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