cmd.md
1> **Источник:** https://python-all.ru/3.7/library/cmd.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# [`cmd`](https://python-all.ru/3.7/library/cmd.html#module-cmd) – Поддержка построчных интерпретаторов команд89**Исходный код:** [Lib/cmd.py](https://python-all.ru/src/3.7/Lib/cmd.py)1011---1213Класс [`Cmd`](https://python-all.ru/3.7/library/cmd.html#cmd.Cmd) предоставляет простую основу для написания построчных интерпретаторов команд. Они часто полезны для тестовых стендов, административных инструментов и прототипов, которые позже будут обёрнуты в более сложный интерфейс.1415#### `class cmd.Cmd(completekey='tab', stdin=None, stdout=None)`1617Экземпляр [`Cmd`](https://python-all.ru/3.7/library/cmd.html#cmd.Cmd) или экземпляр подкласса представляет собой каркас построчного интерпретатора. Нет веских причин создавать экземпляр самого [`Cmd`](https://python-all.ru/3.7/library/cmd.html#cmd.Cmd); напротив, его удобно использовать как суперкласс для собственного класса интерпретатора, чтобы наследовать методы [`Cmd`](https://python-all.ru/3.7/library/cmd.html#cmd.Cmd) и инкапсулировать методы действий.1819Необязательный аргумент *completekey* – это имя клавиши автодополнения [`readline`](https://python-all.ru/3.7/library/readline.html#module-readline); по умолчанию оно равно `Tab`. Если *completekey* не равно [`None`](https://python-all.ru/3.7/library/constants.html#None) и доступен [`readline`](https://python-all.ru/3.7/library/readline.html#module-readline), автодополнение команд выполняется автоматически.2021Необязательные аргументы *stdin* и *stdout* задают объекты файлов ввода и вывода, которые экземпляр Cmd или экземпляр подкласса будет использовать для ввода и вывода. Если они не указаны, по умолчанию используются [`sys.stdin`](https://python-all.ru/3.7/library/sys.html#sys.stdin) и [`sys.stdout`](https://python-all.ru/3.7/library/sys.html#sys.stdout).2223Если требуется использовать определённый *stdin*, убедитесь, что атрибут [`use_rawinput`](https://python-all.ru/3.7/library/cmd.html#cmd.Cmd.use_rawinput) экземпляра установлен в `False`, иначе *stdin* будет проигнорирован.2425## Объекты Cmd2627Экземпляр [`Cmd`](https://python-all.ru/3.7/library/cmd.html#cmd.Cmd) имеет следующие методы:2829#### `Cmd.cmdloop(intro=None)`3031Многократно выводит приглашение, принимает ввод, выделяет из полученного ввода начальный префикс и передаёт его методам действий, передавая им остаток строки в качестве аргумента.3233Необязательный аргумент – это строка баннера или вступления, которая выводится перед первым приглашением (это переопределяет атрибут класса [`intro`](https://python-all.ru/3.7/library/cmd.html#cmd.Cmd.intro)).3435Если модуль [`readline`](https://python-all.ru/3.7/library/readline.html#module-readline) загружен, ввод будет автоматически поддерживать редактирование списка истории в стиле **bash** (например, `Control-P` прокручивает назад к последней команде, `Control-N` – вперёд к следующей, `Control-F` перемещает курсор вправо без удаления, `Control-B` перемещает курсор влево без удаления и т.д.).3637Признак конца файла на вводе передаётся обратно в виде строки `'EOF'`.3839Экземпляр интерпретатора распознаёт имя команды `foo` только в том случае, если у него есть метод `do_foo()`. В частном случае строка, начинающаяся с символа `'?'`, передаётся методу `do_help()`. В другом частном случае строка, начинающаяся с символа `'!'`, передаётся методу `do_shell()` (если такой метод определён).4041Этот метод завершается, когда метод [`postcmd()`](https://python-all.ru/3.7/library/cmd.html#cmd.Cmd.postcmd) возвращает истинное значение. Аргумент *stop* для [`postcmd()`](https://python-all.ru/3.7/library/cmd.html#cmd.Cmd.postcmd) – это возвращаемое значение соответствующего метода команды `do_*()`.4243Если автодополнение включено, дополнение команд выполняется автоматически, а дополнение аргументов команд – вызовом `complete_foo()` с аргументами *text*, *line*, *begidx* и *endidx*. *text* – это строковый префикс, который мы пытаемся сопоставить: все возвращённые совпадения должны с него начинаться. *line* – текущая строка ввода с удалёнными начальными пробелами, *begidx* и *endidx* – начальный и конечный индексы текста префикса, которые могут использоваться для разного дополнения в зависимости от позиции аргумента.4445Все подклассы [`Cmd`](https://python-all.ru/3.7/library/cmd.html#cmd.Cmd) наследуют предопределённый `do_help()`. Этот метод, вызванный с аргументом `'bar'`, вызывает соответствующий метод `help_bar()`, а если его нет, выводит строку документации `do_bar()`, если она доступна. Без аргументов `do_help()` выводит список всех доступных тем справки (то есть всех команд, у которых есть соответствующие методы `help_*()` или строки документации), а также перечисляет недокументированные команды.4647#### `Cmd.onecmd(str)`4849Интерпретирует аргумент так, как если бы он был введён в ответ на приглашение. Этот метод можно переопределить, но обычно в этом нет необходимости; см. методы [`precmd()`](https://python-all.ru/3.7/library/cmd.html#cmd.Cmd.precmd) и [`postcmd()`](https://python-all.ru/3.7/library/cmd.html#cmd.Cmd.postcmd) для полезных точек выполнения. Возвращаемое значение – флаг, указывающий, должна ли интерпретация команд интерпретатором остановиться. Если для команды *str* существует метод `do_*()`, возвращается его значение, иначе возвращается значение из метода [`default()`](https://python-all.ru/3.7/library/cmd.html#cmd.Cmd.default).5051#### `Cmd.emptyline()`5253Метод, вызываемый, когда в ответ на приглашение введена пустая строка. Если этот метод не переопределён, он повторяет последнюю введённую непустую команду.5455#### `Cmd.default(line)`5657Метод, вызываемый для строки ввода, когда префикс команды не распознан. Если этот метод не переопределён, он выводит сообщение об ошибке и завершается.5859#### `Cmd.completedefault(text, line, begidx, endidx)`6061Метод, вызываемый для автодополнения строки ввода, когда нет доступного метода `complete_*()`, специфичного для команды. По умолчанию возвращает пустой список.6263#### `Cmd.precmd(line)`6465Метод-перехватчик, выполняемый непосредственно перед интерпретацией командной строки *line*, но после того, как приглашение ввода сгенерировано и выведено. Этот метод – заглушка в [`Cmd`](https://python-all.ru/3.7/library/cmd.html#cmd.Cmd); он существует для переопределения в подклассах. Возвращаемое значение используется как команда, которая будет выполнена методом [`onecmd()`](https://python-all.ru/3.7/library/cmd.html#cmd.Cmd.onecmd); реализация [`precmd()`](https://python-all.ru/3.7/library/cmd.html#cmd.Cmd.precmd) может переписать команду или просто вернуть *line* без изменений.6667#### `Cmd.postcmd(stop, line)`6869Метод-перехватчик, выполняемый сразу после завершения диспетчеризации команды. Этот метод – заглушка в [`Cmd`](https://python-all.ru/3.7/library/cmd.html#cmd.Cmd); он существует для переопределения в подклассах. *line* – это командная строка, которая была выполнена, а *stop* – флаг, указывающий, будет ли выполнение завершено после вызова [`postcmd()`](https://python-all.ru/3.7/library/cmd.html#cmd.Cmd.postcmd); это будет возвращаемым значением метода [`onecmd()`](https://python-all.ru/3.7/library/cmd.html#cmd.Cmd.onecmd). Возвращаемое значение этого метода будет использоваться как новое значение внутреннего флага, соответствующего *stop*; возврат false приведёт к продолжению интерпретации.7071#### `Cmd.preloop()`7273Метод-перехватчик, выполняемый один раз при вызове [`cmdloop()`](https://python-all.ru/3.7/library/cmd.html#cmd.Cmd.cmdloop). Этот метод – заглушка в [`Cmd`](https://python-all.ru/3.7/library/cmd.html#cmd.Cmd); он существует для переопределения в подклассах.7475#### `Cmd.postloop()`7677Метод-перехватчик, выполняемый один раз, когда [`cmdloop()`](https://python-all.ru/3.7/library/cmd.html#cmd.Cmd.cmdloop) собирается вернуть управление. Этот метод – заглушка в [`Cmd`](https://python-all.ru/3.7/library/cmd.html#cmd.Cmd); он существует для переопределения в подклассах.7879Экземпляры подклассов [`Cmd`](https://python-all.ru/3.7/library/cmd.html#cmd.Cmd) имеют несколько открытых переменных экземпляра:8081#### `Cmd.prompt`8283Приглашение, выводимое для запроса ввода.8485#### `Cmd.identchars`8687Строка символов, допустимых для префикса команды.8889#### `Cmd.lastcmd`9091Последний непустой префикс команды.9293#### `Cmd.cmdqueue`9495Список поставленных в очередь строк ввода. Список [`cmdloop()`](https://python-all.ru/3.7/library/cmd.html#cmd.Cmd.cmdloop) проверяется, когда требуется новый ввод; если он не пуст, его элементы обрабатываются по порядку, как если бы они были введены в приглашении.9697#### `Cmd.intro`9899Строка, выводимая как приветствие или баннер. Может быть переопределена путём передачи аргумента методу [`cmdloop()`](https://python-all.ru/3.7/library/cmd.html#cmd.Cmd.cmdloop).100101#### `Cmd.doc_header`102103Заголовок, выводимый, если в выводе справки есть раздел для документированных команд.104105#### `Cmd.misc_header`106107Заголовок, выводимый, если в выводе справки есть раздел для прочих тем (то есть существуют методы `help_*()` без соответствующих методов `do_*()`).108109#### `Cmd.undoc_header`110111Заголовок, выводимый, если в выводе справки есть раздел для недокументированных команд (то есть существуют методы `do_*()` без соответствующих методов `help_*()`).112113#### `Cmd.ruler`114115Символ, используемый для рисования разделительных линий под заголовками сообщений справки. Если пусто, линия не рисуется. По умолчанию равен `'='`.116117#### `Cmd.use_rawinput`118119Флаг, по умолчанию истинный. Если истина, [`cmdloop()`](https://python-all.ru/3.7/library/cmd.html#cmd.Cmd.cmdloop) использует [`input()`](https://python-all.ru/3.7/library/functions.html#input) для отображения приглашения и чтения следующей команды; если ложь, используются `sys.stdout.write()` и `sys.stdin.readline()`. (Это означает, что импортировав [`readline`](https://python-all.ru/3.7/library/readline.html#module-readline), на поддерживающих это системах интерпретатор автоматически получит поддержку редактирования строк в стиле **Emacs** и клавиш истории команд.)120121## Пример Cmd122123Модуль [`cmd`](https://python-all.ru/3.7/library/cmd.html#module-cmd) в основном полезен для создания собственных оболочек, позволяющих пользователю работать с программой в интерактивном режиме.124125В этом разделе представлен простой пример создания оболочки для нескольких команд модуля [`turtle`](https://python-all.ru/3.7/library/turtle.html#module-turtle).126127Базовые команды turtle, такие как [`forward()`](https://python-all.ru/3.7/library/turtle.html#turtle.forward), добавляются в подкласс [`Cmd`](https://python-all.ru/3.7/library/cmd.html#cmd.Cmd) с помощью метода `do_forward()`. Аргумент преобразуется в число и передаётся модулю turtle. Докстринг используется в справочной утилите, предоставляемой оболочкой.128129Пример также включает базовую функциональность записи и воспроизведения, реализованную с помощью метода [`precmd()`](https://python-all.ru/3.7/library/cmd.html#cmd.Cmd.precmd), который отвечает за преобразование ввода в нижний регистр и запись команд в файл. Метод `do_playback()` читает файл и добавляет записанные команды в `cmdqueue` для немедленного воспроизведения:130131```python132import cmd, sys133from turtle import *134135class TurtleShell(cmd.Cmd):136 intro = 'Welcome to the turtle shell. Type help or ? to list commands.\n'137 prompt = '(turtle) '138 file = None139140 # ----- основные команды turtle -----141 def do_forward(self, arg):142 'Move the turtle forward by the specified distance: FORWARD 10'143 forward(*parse(arg))144 def do_right(self, arg):145 'Turn turtle right by given number of degrees: RIGHT 20'146 right(*parse(arg))147 def do_left(self, arg):148 'Turn turtle left by given number of degrees: LEFT 90'149 left(*parse(arg))150 def do_goto(self, arg):151 'Move turtle to an absolute position with changing orientation. GOTO 100 200'152 goto(*parse(arg))153 def do_home(self, arg):154 'Return turtle to the home position: HOME'155 home()156 def do_circle(self, arg):157 'Draw circle with given radius an options extent and steps: CIRCLE 50'158 circle(*parse(arg))159 def do_position(self, arg):160 'Print the current turtle position: POSITION'161 print('Current position is %d %d\n' % position())162 def do_heading(self, arg):163 'Print the current turtle heading in degrees: HEADING'164 print('Current heading is %d\n' % (heading(),))165 def do_color(self, arg):166 'Set the color: COLOR BLUE'167 color(arg.lower())168 def do_undo(self, arg):169 'Undo (repeatedly) the last turtle action(s): UNDO'170 def do_reset(self, arg):171 'Clear the screen and return turtle to center: RESET'172 reset()173 def do_bye(self, arg):174 'Stop recording, close the turtle window, and exit: BYE'175 print('Thank you for using Turtle')176 self.close()177 bye()178 return True179180 # ----- запись и воспроизведение -----181 def do_record(self, arg):182 'Save future commands to filename: RECORD rose.cmd'183 self.file = open(arg, 'w')184 def do_playback(self, arg):185 'Playback commands from a file: PLAYBACK rose.cmd'186 self.close()187 with open(arg) as f:188 self.cmdqueue.extend(f.read().splitlines())189 def precmd(self, line):190 line = line.lower()191 if self.file and 'playback' not in line:192 print(line, file=self.file)193 return line194 def close(self):195 if self.file:196 self.file.close()197 self.file = None198199def parse(arg):200 'Convert a series of zero or more numbers to an argument tuple'201 return tuple(map(int, arg.split()))202203if __name__ == '__main__':204 TurtleShell().cmdloop()205```206207Ниже приведён пример сеанса работы с оболочкой turtle, демонстрирующий функции справки, использование пустых строк для повторения команд, а также простую возможность записи и воспроизведения:208209```text210Welcome to the turtle shell. Type help or ? to list commands.211212(turtle) ?213214Documented commands (type help <topic>):215========================================216bye color goto home playback record right217circle forward heading left position reset undo218219(turtle) help forward220Move the turtle forward by the specified distance: FORWARD 10221(turtle) record spiral.cmd222(turtle) position223Current position is 0 0224225(turtle) heading226Current heading is 0227228(turtle) reset229(turtle) circle 20230(turtle) right 30231(turtle) circle 40232(turtle) right 30233(turtle) circle 60234(turtle) right 30235(turtle) circle 80236(turtle) right 30237(turtle) circle 100238(turtle) right 30239(turtle) circle 120240(turtle) right 30241(turtle) circle 120242(turtle) heading243Current heading is 180244245(turtle) forward 100246(turtle)247(turtle) right 90248(turtle) forward 100249(turtle)250(turtle) right 90251(turtle) forward 400252(turtle) right 90253(turtle) forward 500254(turtle) right 90255(turtle) forward 400256(turtle) right 90257(turtle) forward 300258(turtle) playback spiral.cmd259Current position is 0 0260261Current heading is 0262263Current heading is 180264265(turtle) bye266Thank you for using Turtle267```268