readline.md
1> **Источник:** https://python-all.ru/3.2/library/readline.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# 16.6. [`readline`](https://python-all.ru/3.2/library/readline.html#module-readline) – интерфейс GNU readline89*Платформы:* Unix1011Модуль [`readline`](https://python-all.ru/3.2/library/readline.html#module-readline) определяет несколько функций для автоматического дополнения и чтения/записи файлов истории из интерпретатора Python. Этот модуль можно использовать напрямую или через модуль [`rlcompleter`](https://python-all.ru/3.2/library/rlcompleter.html#module-rlcompleter). Настройки, сделанные с помощью этого модуля, влияют на поведение как интерактивной подсказки интерпретатора, так и подсказок, предоставляемых встроенной функцией [`input()`](https://python-all.ru/3.2/library/functions.html#input).1213> **Примечание**14>15> В MacOS X модуль [`readline`](https://python-all.ru/3.2/library/readline.html#module-readline) может быть реализован с использованием библиотеки `libedit` вместо GNU readline.16>17> Файл конфигурации для `libedit` отличается от файла GNU readline. Если программно загружать строки конфигурации, можно проверить наличие текста «libedit» в `readline.__doc__`, чтобы отличить GNU readline от libedit.1819Модуль [`readline`](https://python-all.ru/3.2/library/readline.html#module-readline) определяет следующие функции:2021#### `readline.parse_and_bind(string)`2223Разбирает и выполняет одну строку из файла инициализации readline.2425#### `readline.get_line_buffer()`2627Возвращает текущее содержимое буфера строки.2829#### `readline.insert_text(string)`3031Вставляет текст в командную строку.3233#### `readline.read_init_file([filename])`3435Разбирает файл инициализации readline. По умолчанию используется последнее имя файла.3637#### `readline.read_history_file([filename])`3839Загружает файл истории readline. По умолчанию используется имя файла `~/.history`.4041#### `readline.write_history_file([filename])`4243Сохраняет файл истории readline. По умолчанию используется имя файла `~/.history`.4445#### `readline.clear_history()`4647Очищает текущую историю. (Примечание: эта функция недоступна, если установленная версия GNU readline её не поддерживает.)4849#### `readline.get_history_length()`5051Возвращает желаемый размер файла истории. Отрицательные значения означают неограниченный размер.5253#### `readline.set_history_length(length)`5455Устанавливает количество строк для сохранения в файле истории. [`write_history_file()`](https://python-all.ru/3.2/library/readline.html#readline.write_history_file) использует это значение для усечения файла истории при сохранении. Отрицательные значения означают неограниченный размер.5657#### `readline.get_current_history_length()`5859Возвращает количество строк, находящихся в данный момент в истории. (Это отличается от [`get_history_length()`](https://python-all.ru/3.2/library/readline.html#readline.get_history_length), который возвращает максимальное количество строк, которое будет записано в файл истории.)6061#### `readline.get_history_item(index)`6263Возвращает текущее содержимое элемента истории с индексом *index*.6465#### `readline.remove_history_item(pos)`6667Удаляет элемент истории, указанный его позицией, из истории.6869#### `readline.replace_history_item(pos, line)`7071Заменяет элемент истории, указанный его позицией, на заданную строку.7273#### `readline.redisplay()`7475Изменяет отображаемое на экране, чтобы оно соответствовало текущему содержимому буфера строки.7677#### `readline.set_startup_hook([function])`7879Устанавливает или удаляет функцию startup\_hook. Если указан *function*, она будет использоваться как новая функция startup\_hook; если он опущен или равен `None`, любая уже установленная функция-перехватчик удаляется. Функция startup\_hook вызывается без аргументов непосредственно перед тем, как readline выводит первое приглашение.8081#### `readline.set_pre_input_hook([function])`8283Устанавливает или удаляет функцию pre\_input\_hook. Если указан *function*, она будет использоваться как новая функция pre\_input\_hook; если он опущен или равен `None`, любая уже установленная функция-перехватчик удаляется. Функция pre\_input\_hook вызывается без аргументов после вывода первого приглашения и непосредственно перед тем, как readline начинает чтение вводимых символов.8485#### `readline.set_completer([function])`8687Устанавливает или удаляет функцию завершения (completer). Если указан *function*, она будет использоваться как новая функция завершения; если он опущен или равен `None`, любая уже установленная функция завершения удаляется. Функция завершения вызывается в виде `function(text, state)`, для *state* в `0`, `1`, `2`, ..., пока она не вернёт значение, не являющееся строкой. Она должна возвращать следующее возможное завершение, начинающееся с *text*.8889#### `readline.get_completer()`9091Возвращает функцию завершения или `None`, если функция завершения не была установлена.9293#### `readline.get_completion_type()`9495Возвращает тип выполняемого завершения.9697#### `readline.get_begidx()`9899Возвращает начальный индекс области автодополнения readline.100101#### `readline.get_endidx()`102103Возвращает конечный индекс области автодополнения readline.104105#### `readline.set_completer_delims(string)`106107Устанавливает разделители слов readline для автодополнения.108109#### `readline.get_completer_delims()`110111Возвращает разделители слов readline для автодополнения.112113#### `readline.set_completion_display_matches_hook([function])`114115Устанавливает или удаляет функцию отображения завершений. Если указан *function*, она будет использоваться как новая функция отображения завершений; если он опущен или равен `None`, любая уже установленная функция отображения завершений удаляется. Функция отображения завершений вызывается в виде `function(substitution, [matches], longest_match_length)` каждый раз, когда необходимо отобразить совпадения.116117#### `readline.add_history(line)`118119Добавляет строку в буфер истории, как если бы это была последняя введённая строка.120121> **См. также**122>123> **Модуль [`rlcompleter`](https://python-all.ru/3.2/library/rlcompleter.html#module-rlcompleter)**124>125> Завершение идентификаторов Python в интерактивном приглашении.126127## 16.6.1. Пример128129Следующий пример демонстрирует, как использовать функции чтения и записи истории модуля [`readline`](https://python-all.ru/3.2/library/readline.html#module-readline) для автоматической загрузки и сохранения файла истории с именем `.pyhist` из домашнего каталога пользователя. Код ниже обычно выполняется автоматически во время интерактивных сеансов из файла [`PYTHONSTARTUP`](https://python-all.ru/3.2/using/cmdline.html#envvar-PYTHONSTARTUP).130131```python132import os133import readline134histfile = os.path.join(os.path.expanduser("~"), ".pyhist")135try:136 readline.read_history_file(histfile)137except IOError:138 pass139import atexit140atexit.register(readline.write_history_file, histfile)141del os, histfile142```143144Следующий пример расширяет класс [`code.InteractiveConsole`](https://python-all.ru/3.2/library/code.html#code.InteractiveConsole) для поддержки сохранения и восстановления истории.145146```python147import code148import readline149import atexit150import os151152class HistoryConsole(code.InteractiveConsole):153 def __init__(self, locals=None, filename="<console>",154 histfile=os.path.expanduser("~/.console-history")):155 code.InteractiveConsole.__init__(self, locals, filename)156 self.init_history(histfile)157158 def init_history(self, histfile):159 readline.parse_and_bind("tab: complete")160 if hasattr(readline, "read_history_file"):161 try:162 readline.read_history_file(histfile)163 except IOError:164 pass165 atexit.register(self.save_history, histfile)166167 def save_history(self, histfile):168 readline.write_history_file(histfile)169```170