cmd.md
1> **Источник:** https://python-all.ru/3.12/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.12/Lib/cmd.py)1011---1213Класс [`Cmd`](https://python-all.ru/3.12/library/cmd.html#cmd.Cmd) предоставляет простую основу для написания построчных интерпретаторов команд. Они часто полезны для тестовых стендов, административных инструментов и прототипов, которые позже будут обёрнуты в более сложный интерфейс.1415#### `class cmd.Cmd(completekey='tab', stdin=None, stdout=None)`1617Экземпляр [`Cmd`](https://python-all.ru/3.12/library/cmd.html#cmd.Cmd) или экземпляр подкласса представляет собой каркас построчного интерпретатора. Нет веских причин создавать экземпляр самого [`Cmd`](https://python-all.ru/3.12/library/cmd.html#cmd.Cmd); напротив, его удобно использовать как суперкласс для собственного класса интерпретатора, чтобы наследовать методы [`Cmd`](https://python-all.ru/3.12/library/cmd.html#cmd.Cmd) и инкапсулировать методы действий.1819Необязательный аргумент *completekey* – это имя клавиши автодополнения [`readline`](https://python-all.ru/3.12/library/readline.html#module-readline); по умолчанию оно равно `Tab`. Если *completekey* не равно [`None`](https://python-all.ru/3.12/library/constants.html#None) и доступен [`readline`](https://python-all.ru/3.12/library/readline.html#module-readline), автодополнение команд выполняется автоматически.2021Необязательные аргументы *stdin* и *stdout* задают объекты файлов ввода и вывода, которые экземпляр Cmd или экземпляр подкласса будет использовать для ввода и вывода. Если они не указаны, по умолчанию используются [`sys.stdin`](https://python-all.ru/3.12/library/sys.html#sys.stdin) и [`sys.stdout`](https://python-all.ru/3.12/library/sys.html#sys.stdout).2223Если требуется использовать определённый *stdin*, убедитесь, что атрибут [`use_rawinput`](https://python-all.ru/3.12/library/cmd.html#cmd.Cmd.use_rawinput) экземпляра установлен в `False`, иначе *stdin* будет проигнорирован.2425## Объекты Cmd2627Экземпляр [`Cmd`](https://python-all.ru/3.12/library/cmd.html#cmd.Cmd) имеет следующие методы:2829#### `Cmd.cmdloop(intro=None)`3031Многократно выводит приглашение, принимает ввод, выделяет из полученного ввода начальный префикс и передаёт его методам действий, передавая им остаток строки в качестве аргумента.3233Необязательный аргумент – это строка баннера или вступления, которая выводится перед первым приглашением (это переопределяет атрибут класса [`intro`](https://python-all.ru/3.12/library/cmd.html#cmd.Cmd.intro)).3435Если загружен модуль [`readline`](https://python-all.ru/3.12/library/readline.html#module-readline), ввод автоматически получает редактирование истории, подобное **bash** (например, `Control`-`P` прокручивает назад к последней команде, `Control`-`N` вперёд к следующей, `Control`-`F` перемещает курсор вправо без удаления, `Control`-`B` перемещает курсор влево без удаления и т.д.).3637Признак конца файла на вводе передаётся обратно в виде строки `'EOF'`.3839Экземпляр интерпретатора распознаёт имя команды `foo` только в том случае, если у него есть метод `do_foo()`. В частном случае строка, начинающаяся с символа `'?'`, передаётся методу [`do_help()`](https://python-all.ru/3.12/library/cmd.html#cmd.Cmd.do_help). В другом частном случае строка, начинающаяся с символа `'!'`, передаётся методу `do_shell()` (если такой метод определён).4041Этот метод завершается, когда метод [`postcmd()`](https://python-all.ru/3.12/library/cmd.html#cmd.Cmd.postcmd) возвращает истинное значение. Аргумент *stop* для [`postcmd()`](https://python-all.ru/3.12/library/cmd.html#cmd.Cmd.postcmd) – это возвращаемое значение соответствующего метода команды `do_*()`.4243Если автодополнение включено, дополнение команд выполняется автоматически, а дополнение аргументов команд – вызовом `complete_foo()` с аргументами *text*, *line*, *begidx* и *endidx*. *text* – это строковый префикс, который мы пытаемся сопоставить: все возвращённые совпадения должны с него начинаться. *line* – текущая строка ввода с удалёнными начальными пробелами, *begidx* и *endidx* – начальный и конечный индексы текста префикса, которые могут использоваться для разного дополнения в зависимости от позиции аргумента.4445#### `Cmd.do_help(arg)`4647Все подклассы [`Cmd`](https://python-all.ru/3.12/library/cmd.html#cmd.Cmd) наследуют предопределённый `do_help()`. Этот метод, вызванный с аргументом `'bar'`, вызывает соответствующий метод `help_bar()`, а если его нет, выводит строку документации `do_bar()`, если она доступна. Без аргументов `do_help()` выводит список всех доступных тем справки (то есть всех команд, у которых есть соответствующие методы `help_*()` или строки документации), а также перечисляет недокументированные команды.4849#### `Cmd.onecmd(str)`5051Интерпретирует аргумент так, как если бы он был введён в ответ на приглашение. Этот метод можно переопределить, но обычно в этом нет необходимости; см. методы [`precmd()`](https://python-all.ru/3.12/library/cmd.html#cmd.Cmd.precmd) и [`postcmd()`](https://python-all.ru/3.12/library/cmd.html#cmd.Cmd.postcmd) для полезных точек выполнения. Возвращаемое значение – флаг, указывающий, должна ли интерпретация команд интерпретатором остановиться. Если для команды *str* существует метод `do_*()`, возвращается его значение, иначе возвращается значение из метода [`default()`](https://python-all.ru/3.12/library/cmd.html#cmd.Cmd.default).5253#### `Cmd.emptyline()`5455Метод, вызываемый, когда в ответ на приглашение введена пустая строка. Если этот метод не переопределён, он повторяет последнюю введённую непустую команду.5657#### `Cmd.default(line)`5859Метод, вызываемый для строки ввода, когда префикс команды не распознан. Если этот метод не переопределён, он выводит сообщение об ошибке и завершается.6061#### `Cmd.completedefault(text, line, begidx, endidx)`6263Метод, вызываемый для автодополнения строки ввода, когда нет доступного метода `complete_*()`, специфичного для команды. По умолчанию возвращает пустой список.6465#### `Cmd.columnize(list, displaywidth=80)`6667Метод, вызываемый для отображения списка строк в виде компактного набора столбцов. Каждый столбец имеет ширину, достаточную для его содержимого. Столбцы разделяются двумя пробелами для удобочитаемости.6869#### `Cmd.precmd(line)`7071Метод-перехватчик, выполняемый непосредственно перед интерпретацией командной строки *line*, но после того, как приглашение ввода сгенерировано и выведено. Этот метод – заглушка в [`Cmd`](https://python-all.ru/3.12/library/cmd.html#cmd.Cmd); он существует для переопределения в подклассах. Возвращаемое значение используется как команда, которая будет выполнена методом [`onecmd()`](https://python-all.ru/3.12/library/cmd.html#cmd.Cmd.onecmd); реализация [`precmd()`](https://python-all.ru/3.12/library/cmd.html#cmd.Cmd.precmd) может переписать команду или просто вернуть *line* без изменений.7273#### `Cmd.postcmd(stop, line)`7475Метод-перехватчик, выполняемый сразу после завершения диспетчеризации команды. Этот метод – заглушка в [`Cmd`](https://python-all.ru/3.12/library/cmd.html#cmd.Cmd); он существует для переопределения в подклассах. *line* – это командная строка, которая была выполнена, а *stop* – флаг, указывающий, будет ли выполнение завершено после вызова [`postcmd()`](https://python-all.ru/3.12/library/cmd.html#cmd.Cmd.postcmd); это будет возвращаемым значением метода [`onecmd()`](https://python-all.ru/3.12/library/cmd.html#cmd.Cmd.onecmd). Возвращаемое значение этого метода будет использоваться как новое значение внутреннего флага, соответствующего *stop*; возврат false приведёт к продолжению интерпретации.7677#### `Cmd.preloop()`7879Метод-перехватчик, выполняемый один раз при вызове [`cmdloop()`](https://python-all.ru/3.12/library/cmd.html#cmd.Cmd.cmdloop). Этот метод – заглушка в [`Cmd`](https://python-all.ru/3.12/library/cmd.html#cmd.Cmd); он существует для переопределения в подклассах.8081#### `Cmd.postloop()`8283Метод-перехватчик, выполняемый один раз, когда [`cmdloop()`](https://python-all.ru/3.12/library/cmd.html#cmd.Cmd.cmdloop) собирается вернуть управление. Этот метод – заглушка в [`Cmd`](https://python-all.ru/3.12/library/cmd.html#cmd.Cmd); он существует для переопределения в подклассах.8485Экземпляры подклассов [`Cmd`](https://python-all.ru/3.12/library/cmd.html#cmd.Cmd) имеют несколько открытых переменных экземпляра:8687#### `Cmd.prompt`8889Приглашение, выводимое для запроса ввода.9091#### `Cmd.identchars`9293Строка символов, допустимых для префикса команды.9495#### `Cmd.lastcmd`9697Последний непустой префикс команды.9899#### `Cmd.cmdqueue`100101Список поставленных в очередь строк ввода. Список [`cmdloop()`](https://python-all.ru/3.12/library/cmd.html#cmd.Cmd.cmdloop) проверяется, когда требуется новый ввод; если он не пуст, его элементы обрабатываются по порядку, как если бы они были введены в приглашении.102103#### `Cmd.intro`104105Строка, выводимая как приветствие или баннер. Может быть переопределена путём передачи аргумента методу [`cmdloop()`](https://python-all.ru/3.12/library/cmd.html#cmd.Cmd.cmdloop).106107#### `Cmd.doc_header`108109Заголовок, выводимый, если в выводе справки есть раздел для документированных команд.110111#### `Cmd.misc_header`112113Заголовок, выводимый, если в выводе справки есть раздел для прочих тем (то есть существуют методы `help_*()` без соответствующих методов `do_*()`).114115#### `Cmd.undoc_header`116117Заголовок, выводимый, если в выводе справки есть раздел для недокументированных команд (то есть существуют методы `do_*()` без соответствующих методов `help_*()`).118119#### `Cmd.ruler`120121Символ, используемый для рисования разделительных линий под заголовками сообщений справки. Если пусто, линия не рисуется. По умолчанию равен `'='`.122123#### `Cmd.use_rawinput`124125Флаг, по умолчанию истинный. Если истина, [`cmdloop()`](https://python-all.ru/3.12/library/cmd.html#cmd.Cmd.cmdloop) использует [`input()`](https://python-all.ru/3.12/library/functions.html#input) для отображения приглашения и чтения следующей команды; если ложь, используются [`sys.stdout.write()`](https://python-all.ru/3.12/library/sys.html#sys.stdout) и [`sys.stdin.readline()`](https://python-all.ru/3.12/library/sys.html#sys.stdin). (Это означает, что импортировав [`readline`](https://python-all.ru/3.12/library/readline.html#module-readline), на поддерживающих это системах интерпретатор автоматически получит поддержку редактирования строк в стиле **Emacs** и клавиш истории команд.)126127## Пример Cmd128129Модуль [`cmd`](https://python-all.ru/3.12/library/cmd.html#module-cmd) в основном полезен для создания собственных оболочек, позволяющих пользователю работать с программой в интерактивном режиме.130131В этом разделе представлен простой пример создания оболочки для нескольких команд модуля [`turtle`](https://python-all.ru/3.12/library/turtle.html#module-turtle).132133Базовые команды turtle, такие как [`forward()`](https://python-all.ru/3.12/library/turtle.html#turtle.forward), добавляются в подкласс [`Cmd`](https://python-all.ru/3.12/library/cmd.html#cmd.Cmd) с помощью метода `do_forward()`. Аргумент преобразуется в число и передаётся модулю turtle. Докстринг используется в справочной утилите, предоставляемой оболочкой.134135Пример также включает базовую функциональность записи и воспроизведения, реализованную с помощью метода [`precmd()`](https://python-all.ru/3.12/library/cmd.html#cmd.Cmd.precmd), который отвечает за преобразование ввода в нижний регистр и запись команд в файл. Метод `do_playback()` читает файл и добавляет записанные команды в [`cmdqueue`](https://python-all.ru/3.12/library/cmd.html#cmd.Cmd.cmdqueue) для немедленного воспроизведения:136137```python138import cmd, sys139from turtle import *140141class TurtleShell(cmd.Cmd):142 intro = 'Welcome to the turtle shell. Type help or ? to list commands.\n'143 prompt = '(turtle) '144 file = None145146 # ----- основные команды turtle -----147 def do_forward(self, arg):148 'Move the turtle forward by the specified distance: FORWARD 10'149 forward(*parse(arg))150 def do_right(self, arg):151 'Turn turtle right by given number of degrees: RIGHT 20'152 right(*parse(arg))153 def do_left(self, arg):154 'Turn turtle left by given number of degrees: LEFT 90'155 left(*parse(arg))156 def do_goto(self, arg):157 'Move turtle to an absolute position with changing orientation. GOTO 100 200'158 goto(*parse(arg))159 def do_home(self, arg):160 'Return turtle to the home position: HOME'161 home()162 def do_circle(self, arg):163 'Draw circle with given radius an options extent and steps: CIRCLE 50'164 circle(*parse(arg))165 def do_position(self, arg):166 'Print the current turtle position: POSITION'167 print('Current position is %d %d\n' % position())168 def do_heading(self, arg):169 'Print the current turtle heading in degrees: HEADING'170 print('Current heading is %d\n' % (heading(),))171 def do_color(self, arg):172 'Set the color: COLOR BLUE'173 color(arg.lower())174 def do_undo(self, arg):175 'Undo (repeatedly) the last turtle action(s): UNDO'176 def do_reset(self, arg):177 'Clear the screen and return turtle to center: RESET'178 reset()179 def do_bye(self, arg):180 'Stop recording, close the turtle window, and exit: BYE'181 print('Thank you for using Turtle')182 self.close()183 bye()184 return True185186 # ----- запись и воспроизведение -----187 def do_record(self, arg):188 'Save future commands to filename: RECORD rose.cmd'189 self.file = open(arg, 'w')190 def do_playback(self, arg):191 'Playback commands from a file: PLAYBACK rose.cmd'192 self.close()193 with open(arg) as f:194 self.cmdqueue.extend(f.read().splitlines())195 def precmd(self, line):196 line = line.lower()197 if self.file and 'playback' not in line:198 print(line, file=self.file)199 return line200 def close(self):201 if self.file:202 self.file.close()203 self.file = None204205def parse(arg):206 'Convert a series of zero or more numbers to an argument tuple'207 return tuple(map(int, arg.split()))208209if __name__ == '__main__':210 TurtleShell().cmdloop()211```212213Ниже приведён пример сеанса работы с оболочкой turtle, демонстрирующий функции справки, использование пустых строк для повторения команд, а также простую возможность записи и воспроизведения:214215```text216Welcome to the turtle shell. Type help or ? to list commands.217218(turtle) ?219220Documented commands (type help <topic>):221========================================222bye color goto home playback record right223circle forward heading left position reset undo224225(turtle) help forward226Move the turtle forward by the specified distance: FORWARD 10227(turtle) record spiral.cmd228(turtle) position229Current position is 0 0230231(turtle) heading232Current heading is 0233234(turtle) reset235(turtle) circle 20236(turtle) right 30237(turtle) circle 40238(turtle) right 30239(turtle) circle 60240(turtle) right 30241(turtle) circle 80242(turtle) right 30243(turtle) circle 100244(turtle) right 30245(turtle) circle 120246(turtle) right 30247(turtle) circle 120248(turtle) heading249Current heading is 180250251(turtle) forward 100252(turtle)253(turtle) right 90254(turtle) forward 100255(turtle)256(turtle) right 90257(turtle) forward 400258(turtle) right 90259(turtle) forward 500260(turtle) right 90261(turtle) forward 400262(turtle) right 90263(turtle) forward 300264(turtle) playback spiral.cmd265Current position is 0 0266267Current heading is 0268269Current heading is 180270271(turtle) bye272Thank you for using Turtle273```274