# `cmd` — Support for line-oriented command interpreters

Вихідний код: Lib/cmd.py

Клас `Cmd` забезпечує просту структуру для написання рядково-орієнтованих інтерпретаторів команд. Вони часто корисні для тестових систем, інструментів адміністрування та прототипів, які пізніше будуть загорнуті в більш складний інтерфейс.

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

  Екземпляр `Cmd` або екземпляр підкласу — це рядково-орієнтована структура інтерпретатора. Немає вагомих причин створювати сам `Cmd`; скоріше, це корисно як суперклас класу інтерпретатора, який ви визначаєте самостійно, щоб успадкувати методи `Cmd` та інкапсулювати методи дії.

  Необов’язковий аргумент completekey є назвою `readline` ключа завершення; типово `Tab`. Якщо completekey не `None` і `readline` доступний, завершення команди виконується автоматично.

  The default, `'tab'`, is treated specially, so that it refers to the `Tab` key on every `readline.backend`. Specifically, if `readline.backend` is `editline`, `Cmd` will use `'^I'` instead of `'tab'`. Note that other values are not treated this way, and might only work with a specific backend.

  Необов’язкові аргументи stdin і stdout визначають вхідні та вихідні файлові об’єкти, які екземпляр Cmd або екземпляр підкласу використовуватиме для введення та виведення. Якщо не вказати, за замовчуванням вони будуть `sys.stdin` і `sys.stdout`.

  Якщо ви хочете, щоб використовувався заданий stdin, обов’язково встановіть для атрибута екземпляра `use_rawinput` значення `False`, інакше stdin буде проігноровано.

  Змінено в версії 3.13: `completekey='tab'` is replaced by `'^I'` for `editline`.

## Cmd об’єкти

Екземпляр `Cmd` має такі методи:

Cmd.cmdloop(intro=None)

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

  Необов’язковим аргументом є банер або вступний рядок, який буде виданий перед першою підказкою (це замінює атрибут класу `intro`).

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

  Кінець файлу при введенні передається назад як рядок `'EOF'`.

  An interpreter instance will recognize a command name `foo` if and only if it has a method `do_foo()`. As a special case, a line beginning with the character `'?'` is dispatched to the method `do_help()`. As another special case, a line beginning with the character `'!'` is dispatched to the method `do_shell()` (if such a method is defined).

  This method will return when the `postcmd()` method returns a true value. The stop argument to `postcmd()` is the return value from the command’s corresponding `do_*()` method.

  If completion is enabled, completing commands will be done automatically, and completing of commands args is done by calling `complete_foo()` with arguments text, line, begidx, and endidx. text is the string prefix we are attempting to match: all returned matches must begin with it. line is the current input line with leading whitespace removed, begidx and endidx are the beginning and ending indexes of the prefix text, which could be used to provide different completion depending upon which position the argument is in.

Cmd.do_help(arg)

  All subclasses of `Cmd` inherit a predefined `do_help()`. This method, called with an argument `'bar'`, invokes the corresponding method `help_bar()`, and if that is not present, prints the docstring of `do_bar()`, if available. With no argument, `do_help()` lists all available help topics (that is, all commands with corresponding `help_*()` methods or commands that have docstrings), and also lists any undocumented commands.

Cmd.onecmd(str)

  Interpret the argument as though it had been typed in response to the prompt. This may be overridden, but should not normally need to be; see the `precmd()` and `postcmd()` methods for useful execution hooks. The return value is a flag indicating whether interpretation of commands by the interpreter should stop. If there is a `do_*()` method for the command str, the return value of that method is returned, otherwise the return value from the `default()` method is returned.

Cmd.emptyline()

  Метод викликається, коли у відповідь на підказку вводиться порожній рядок. Якщо цей метод не перевизначено, він повторює останню введену непорожню команду.

Cmd.default(line)

  Метод, який викликається у рядку введення, коли префікс команди не розпізнається. Якщо цей метод не перевизначено, він друкує повідомлення про помилку та повертається.

Cmd.completedefault(text, line, begidx, endidx)

  Method called to complete an input line when no command-specific `complete_*()` method is available. By default, it returns an empty list.

Cmd.columnize(list, displaywidth=80)

  Method called to display a list of strings as a compact set of columns. Each column is only as wide as necessary. Columns are separated by two spaces for readability.

Cmd.precmd(line)

  Метод підхоплення виконується безпосередньо перед інтерпретацією рядка командного рядка, але після створення та видачі підказки введення. Цей метод є заглушкою в `Cmd`; він існує, щоб бути заміненим підкласами. Повернене значення використовується як команда, яка буде виконана методом `onecmd()`; реалізація `precmd()` може переписати команду або просто повернути рядок без змін.

Cmd.postcmd(stop, line)

  Метод підхоплення виконується відразу після завершення відправки команди. Цей метод є заглушкою в `Cmd`; він існує, щоб бути заміненим підкласами. рядок — це командний рядок, який було виконано, а стоп — це позначка, яка вказує, чи буде виконання припинено після виклику `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

  The header to issue if the help output has a section for miscellaneous help topics (that is, there are `help_*()` methods without corresponding `do_*()` methods).

Cmd.undoc_header

  The header to issue if the help output has a section for undocumented commands (that is, there are `do_*()` methods without corresponding `help_*()` methods).

Cmd.ruler

  Символ, який використовується для малювання роздільних ліній під заголовками довідкових повідомлень. Якщо поле пусте, лінія лінійки не малюється. За замовчуванням `'='`.

Cmd.use_rawinput

  A flag, defaulting to true. If true, `cmdloop()` uses `input()` to display a prompt and read the next command; if false, `sys.stdout.write()` and `sys.stdin.readline()` are used. (This means that by importing `readline`, on systems that support it, the interpreter will automatically support Emacs-like line editing and command-history keystrokes.)

## Приклад команди

The `cmd` module is mainly useful for building custom shells that let a user work with a program interactively.

У цьому розділі представлено простий приклад того, як створити оболонку навколо кількох команд у модулі `turtle`.

Basic turtle commands such as `forward()` are added to a `Cmd` subclass with method named `do_forward()`. The argument is converted to a number and dispatched to the turtle module. The docstring is used in the help utility provided by the shell.

The example also includes a basic record and playback facility implemented with the `precmd()` method which is responsible for converting the input to lowercase and writing the commands to a file. The `do_playback()` method reads the file and adds the recorded commands to the `cmdqueue` for immediate playback:

    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