cmd.md
1> **Источник:** https://python-all.ru/3/library/cmd.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# `cmd` – Поддержка построчных интерпретаторов команд89**Исходный код:** [Lib/cmd.py](https://python-all.ru/src/3.14/Lib/cmd.py)1011---1213Класс [`Cmd`](https://python-all.ru/3/library/cmd.html#cmd.Cmd) предоставляет простую основу для написания построчных интерпретаторов команд. Они часто полезны для тестовых стендов, административных инструментов и прототипов, которые позже будут обёрнуты в более сложный интерфейс.1415#### `class cmd.Cmd(completekey='tab', stdin=None, stdout=None)`1617Экземпляр `Cmd` или экземпляр подкласса представляет собой каркас построчного интерпретатора. Нет веских причин создавать экземпляр самого `Cmd`; напротив, его удобно использовать как суперкласс для собственного класса интерпретатора, чтобы наследовать методы `Cmd` и инкапсулировать методы действий.1819Необязательный аргумент *completekey* – это имя клавиши автодополнения [`readline`](https://python-all.ru/3/library/readline.html#module-readline); по умолчанию оно равно `Tab`. Если *completekey* не равно [`None`](https://python-all.ru/3/library/constants.html#None) и доступен `readline`, автодополнение команд выполняется автоматически.2021Значение по умолчанию, `'tab'`, обрабатывается особым образом: оно соответствует клавише `Tab` на любой [`readline.backend`](https://python-all.ru/3/library/readline.html#readline.backend). В частности, если `readline.backend` равно `editline`, то `Cmd` будет использовать `'^I'` вместо `'tab'`. Обратите внимание, что другие значения так не обрабатываются и могут работать только с конкретной реализацией.2223Необязательные аргументы *stdin* и *stdout* задают объекты файлов ввода и вывода, которые экземпляр Cmd или экземпляр подкласса будет использовать для ввода и вывода. Если они не указаны, по умолчанию используются [`sys.stdin`](https://python-all.ru/3/library/sys.html#sys.stdin) и [`sys.stdout`](https://python-all.ru/3/library/sys.html#sys.stdout).2425Если требуется использовать определённый *stdin*, убедитесь, что атрибут [`use_rawinput`](https://python-all.ru/3/library/cmd.html#cmd.Cmd.use_rawinput) экземпляра установлен в `False`, иначе *stdin* будет проигнорирован.2627Изменено в версии 3.13: `completekey='tab'` заменён на `'^I'` для `editline`.2829## Объекты Cmd3031Экземпляр [`Cmd`](https://python-all.ru/3/library/cmd.html#cmd.Cmd) имеет следующие методы:3233#### `Cmd.cmdloop(intro=None)`3435Многократно выводит приглашение, принимает ввод, выделяет из полученного ввода начальный префикс и передаёт его методам действий, передавая им остаток строки в качестве аргумента.3637Необязательный аргумент – это строка баннера или вступления, которая выводится перед первым приглашением (это переопределяет атрибут класса [`intro`](https://python-all.ru/3/library/cmd.html#cmd.Cmd.intro)).3839Если загружен модуль [`readline`](https://python-all.ru/3/library/readline.html#module-readline), ввод автоматически получает редактирование истории, подобное **bash** (например, `Control`-`P` прокручивает назад к последней команде, `Control`-`N` вперёд к следующей, `Control`-`F` перемещает курсор вправо без удаления, `Control`-`B` перемещает курсор влево без удаления и т.д.).4041Признак конца файла на вводе передаётся обратно в виде строки `'EOF'`.4243Экземпляр интерпретатора распознаёт имя команды `foo` только в том случае, если у него есть метод `do_foo()`. В частном случае строка, начинающаяся с символа `'?'`, передаётся методу [`do_help()`](https://python-all.ru/3/library/cmd.html#cmd.Cmd.do_help). В другом частном случае строка, начинающаяся с символа `'!'`, передаётся методу `do_shell()` (если такой метод определён).4445Этот метод завершается, когда метод [`postcmd()`](https://python-all.ru/3/library/cmd.html#cmd.Cmd.postcmd) возвращает истинное значение. Аргумент *stop* для `postcmd()` – это возвращаемое значение соответствующего метода команды `do_*()`.4647Если автодополнение включено, дополнение команд выполняется автоматически, а дополнение аргументов команд – вызовом `complete_foo()` с аргументами *text*, *line*, *begidx* и *endidx*. *text* – это строковый префикс, который мы пытаемся сопоставить: все возвращённые совпадения должны с него начинаться. *line* – текущая строка ввода с удалёнными начальными пробелами, *begidx* и *endidx* – начальный и конечный индексы текста префикса, которые могут использоваться для разного дополнения в зависимости от позиции аргумента.4849#### `Cmd.do_help(arg)`5051Все подклассы [`Cmd`](https://python-all.ru/3/library/cmd.html#cmd.Cmd) наследуют предопределённый `do_help()`. Этот метод, вызванный с аргументом `'bar'`, вызывает соответствующий метод `help_bar()`, а если его нет, выводит строку документации `do_bar()`, если она доступна. Без аргументов `do_help()` выводит список всех доступных тем справки (то есть всех команд, у которых есть соответствующие методы `help_*()` или строки документации), а также перечисляет недокументированные команды.5253#### `Cmd.onecmd(str)`5455Интерпретирует аргумент так, как если бы он был введён в ответ на приглашение. Этот метод можно переопределить, но обычно в этом нет необходимости; см. методы [`precmd()`](https://python-all.ru/3/library/cmd.html#cmd.Cmd.precmd) и [`postcmd()`](https://python-all.ru/3/library/cmd.html#cmd.Cmd.postcmd) для полезных точек выполнения. Возвращаемое значение – флаг, указывающий, должна ли интерпретация команд интерпретатором остановиться. Если для команды *str* существует метод `do_*()`, возвращается его значение, иначе возвращается значение из метода [`default()`](https://python-all.ru/3/library/cmd.html#cmd.Cmd.default).5657#### `Cmd.emptyline()`5859Метод, вызываемый, когда в ответ на приглашение введена пустая строка. Если этот метод не переопределён, он повторяет последнюю введённую непустую команду.6061#### `Cmd.default(line)`6263Метод, вызываемый для строки ввода, когда префикс команды не распознан. Если этот метод не переопределён, он выводит сообщение об ошибке и завершается.6465#### `Cmd.completedefault(text, line, begidx, endidx)`6667Метод, вызываемый для автодополнения строки ввода, когда нет доступного метода `complete_*()`, специфичного для команды. По умолчанию возвращает пустой список.6869#### `Cmd.columnize(list, displaywidth=80)`7071Метод, вызываемый для отображения списка строк в виде компактного набора столбцов. Каждый столбец имеет ширину, достаточную для его содержимого. Столбцы разделяются двумя пробелами для удобочитаемости.7273#### `Cmd.precmd(line)`7475Метод-перехватчик, выполняемый непосредственно перед интерпретацией командной строки *line*, но после того, как приглашение ввода сгенерировано и выведено. Этот метод – заглушка в [`Cmd`](https://python-all.ru/3/library/cmd.html#cmd.Cmd); он существует для переопределения в подклассах. Возвращаемое значение используется как команда, которая будет выполнена методом [`onecmd()`](https://python-all.ru/3/library/cmd.html#cmd.Cmd.onecmd); реализация `precmd()` может переписать команду или просто вернуть *line* без изменений.7677#### `Cmd.postcmd(stop, line)`7879Метод-перехватчик, выполняемый сразу после завершения диспетчеризации команды. Этот метод – заглушка в [`Cmd`](https://python-all.ru/3/library/cmd.html#cmd.Cmd); он существует для переопределения в подклассах. *line* – это командная строка, которая была выполнена, а *stop* – флаг, указывающий, будет ли выполнение завершено после вызова `postcmd()`; это будет возвращаемым значением метода [`onecmd()`](https://python-all.ru/3/library/cmd.html#cmd.Cmd.onecmd). Возвращаемое значение этого метода будет использоваться как новое значение внутреннего флага, соответствующего *stop*; возврат false приведёт к продолжению интерпретации.8081#### `Cmd.preloop()`8283Метод-перехватчик, выполняемый один раз при вызове [`cmdloop()`](https://python-all.ru/3/library/cmd.html#cmd.Cmd.cmdloop). Этот метод – заглушка в [`Cmd`](https://python-all.ru/3/library/cmd.html#cmd.Cmd); он существует для переопределения в подклассах.8485#### `Cmd.postloop()`8687Метод-перехватчик, выполняемый один раз, когда [`cmdloop()`](https://python-all.ru/3/library/cmd.html#cmd.Cmd.cmdloop) собирается вернуть управление. Этот метод – заглушка в [`Cmd`](https://python-all.ru/3/library/cmd.html#cmd.Cmd); он существует для переопределения в подклассах.8889Экземпляры подклассов [`Cmd`](https://python-all.ru/3/library/cmd.html#cmd.Cmd) имеют несколько открытых переменных экземпляра:9091#### `Cmd.prompt`9293Приглашение, выводимое для запроса ввода.9495#### `Cmd.identchars`9697Строка символов, допустимых для префикса команды.9899#### `Cmd.lastcmd`100101Последний непустой префикс команды.102103#### `Cmd.cmdqueue`104105Список поставленных в очередь строк ввода. Список [`cmdloop()`](https://python-all.ru/3/library/cmd.html#cmd.Cmd.cmdloop) проверяется, когда требуется новый ввод; если он не пуст, его элементы обрабатываются по порядку, как если бы они были введены в приглашении.106107#### `Cmd.intro`108109Строка, выводимая как приветствие или баннер. Может быть переопределена путём передачи аргумента методу [`cmdloop()`](https://python-all.ru/3/library/cmd.html#cmd.Cmd.cmdloop).110111#### `Cmd.doc_header`112113Заголовок, выводимый, если в выводе справки есть раздел для документированных команд.114115#### `Cmd.misc_header`116117Заголовок, выводимый, если в выводе справки есть раздел для прочих тем (то есть существуют методы `help_*()` без соответствующих методов `do_*()`).118119#### `Cmd.undoc_header`120121Заголовок, выводимый, если в выводе справки есть раздел для недокументированных команд (то есть существуют методы `do_*()` без соответствующих методов `help_*()`).122123#### `Cmd.ruler`124125Символ, используемый для рисования разделительных линий под заголовками сообщений справки. Если пусто, линия не рисуется. По умолчанию равен `'='`.126127#### `Cmd.use_rawinput`128129Флаг, по умолчанию истинный. Если истина, [`cmdloop()`](https://python-all.ru/3/library/cmd.html#cmd.Cmd.cmdloop) использует [`input()`](https://python-all.ru/3/library/functions.html#input) для отображения приглашения и чтения следующей команды; если ложь, используются [`sys.stdout.write()`](https://python-all.ru/3/library/sys.html#sys.stdout) и [`sys.stdin.readline()`](https://python-all.ru/3/library/sys.html#sys.stdin). (Это означает, что импортировав [`readline`](https://python-all.ru/3/library/readline.html#module-readline), на поддерживающих это системах интерпретатор автоматически получит поддержку редактирования строк в стиле **Emacs** и клавиш истории команд.)130131## Пример Cmd132133Модуль `cmd` в основном полезен для создания собственных оболочек, позволяющих пользователю работать с программой в интерактивном режиме.134135В этом разделе представлен простой пример создания оболочки для нескольких команд модуля [`turtle`](https://python-all.ru/3/library/turtle.html#module-turtle).136137Базовые команды turtle, такие как [`forward()`](https://python-all.ru/3/library/turtle.html#turtle.forward), добавляются в подкласс [`Cmd`](https://python-all.ru/3/library/cmd.html#cmd.Cmd) с помощью метода `do_forward()`. Аргумент преобразуется в число и передаётся модулю turtle. Докстринг используется в справочной утилите, предоставляемой оболочкой.138139Пример также включает базовую функциональность записи и воспроизведения, реализованную с помощью метода [`precmd()`](https://python-all.ru/3/library/cmd.html#cmd.Cmd.precmd), который отвечает за преобразование ввода в нижний регистр и запись команд в файл. Метод `do_playback()` читает файл и добавляет записанные команды в [`cmdqueue`](https://python-all.ru/3/library/cmd.html#cmd.Cmd.cmdqueue) для немедленного воспроизведения:140141```python142import cmd, sys143from turtle import *144145class TurtleShell(cmd.Cmd):146 intro = 'Welcome to the turtle shell. Type help or ? to list commands.\n'147 prompt = '(turtle) '148 file = None149150 # ----- основные команды turtle -----151 def do_forward(self, arg):152 'Move the turtle forward by the specified distance: FORWARD 10'153 forward(*parse(arg))154 def do_right(self, arg):155 'Turn turtle right by given number of degrees: RIGHT 20'156 right(*parse(arg))157 def do_left(self, arg):158 'Turn turtle left by given number of degrees: LEFT 90'159 left(*parse(arg))160 def do_goto(self, arg):161 'Move turtle to an absolute position with changing orientation. GOTO 100 200'162 goto(*parse(arg))163 def do_home(self, arg):164 'Return turtle to the home position: HOME'165 home()166 def do_circle(self, arg):167 'Draw circle with given radius an options extent and steps: CIRCLE 50'168 circle(*parse(arg))169 def do_position(self, arg):170 'Print the current turtle position: POSITION'171 print('Current position is %d %d\n' % position())172 def do_heading(self, arg):173 'Print the current turtle heading in degrees: HEADING'174 print('Current heading is %d\n' % (heading(),))175 def do_color(self, arg):176 'Set the color: COLOR BLUE'177 color(arg.lower())178 def do_undo(self, arg):179 'Undo (repeatedly) the last turtle action(s): UNDO'180 def do_reset(self, arg):181 'Clear the screen and return turtle to center: RESET'182 reset()183 def do_bye(self, arg):184 'Stop recording, close the turtle window, and exit: BYE'185 print('Thank you for using Turtle')186 self.close()187 bye()188 return True189190 # ----- запись и воспроизведение -----191 def do_record(self, arg):192 'Save future commands to filename: RECORD rose.cmd'193 self.file = open(arg, 'w')194 def do_playback(self, arg):195 'Playback commands from a file: PLAYBACK rose.cmd'196 self.close()197 with open(arg) as f:198 self.cmdqueue.extend(f.read().splitlines())199 def precmd(self, line):200 line = line.lower()201 if self.file and 'playback' not in line:202 print(line, file=self.file)203 return line204 def close(self):205 if self.file:206 self.file.close()207 self.file = None208209def parse(arg):210 'Convert a series of zero or more numbers to an argument tuple'211 return tuple(map(int, arg.split()))212213if __name__ == '__main__':214 TurtleShell().cmdloop()215```216217Ниже приведён пример сеанса работы с оболочкой turtle, демонстрирующий функции справки, использование пустых строк для повторения команд, а также простую возможность записи и воспроизведения:218219```text220Welcome to the turtle shell. Type help or ? to list commands.221222(turtle) ?223224Documented commands (type help <topic>):225========================================226bye color goto home playback record right227circle forward heading left position reset undo228229(turtle) help forward230Move the turtle forward by the specified distance: FORWARD 10231(turtle) record spiral.cmd232(turtle) position233Current position is 0 0234235(turtle) heading236Current heading is 0237238(turtle) reset239(turtle) circle 20240(turtle) right 30241(turtle) circle 40242(turtle) right 30243(turtle) circle 60244(turtle) right 30245(turtle) circle 80246(turtle) right 30247(turtle) circle 100248(turtle) right 30249(turtle) circle 120250(turtle) right 30251(turtle) circle 120252(turtle) heading253Current heading is 180254255(turtle) forward 100256(turtle)257(turtle) right 90258(turtle) forward 100259(turtle)260(turtle) right 90261(turtle) forward 400262(turtle) right 90263(turtle) forward 500264(turtle) right 90265(turtle) forward 400266(turtle) right 90267(turtle) forward 300268(turtle) playback spiral.cmd269Current position is 0 0270271Current heading is 0272273Current heading is 180274275(turtle) bye276Thank you for using Turtle277```278