readline.md
1> **Источник:** https://python-all.ru/3.6/library/readline.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# 6.7. [`readline`](https://python-all.ru/3.6/library/readline.html#module-readline) – интерфейс GNU readline89---1011Модуль [`readline`](https://python-all.ru/3.6/library/readline.html#module-readline) определяет ряд функций для упрощения дополнения и чтения/записи файлов истории из интерпретатора Python. Этот модуль можно использовать напрямую или через модуль [`rlcompleter`](https://python-all.ru/3.6/library/rlcompleter.html#module-rlcompleter), который поддерживает дополнение идентификаторов Python в интерактивной строке. Настройки, сделанные с помощью этого модуля, влияют на поведение как интерактивной строки интерпретатора, так и строк, предлагаемых встроенной функцией [`input()`](https://python-all.ru/3.6/library/functions.html#input).1213> **Примечание**14>15> Базовый API библиотеки Readline может быть реализован библиотекой `libedit` вместо GNU readline. На MacOS X модуль [`readline`](https://python-all.ru/3.6/library/readline.html#module-readline) определяет, какая библиотека используется во время выполнения.16>17> Конфигурационный файл для `libedit` отличается от файла GNU readline. Если строки конфигурации загружаются программно, можно проверить наличие текста «libedit» в `readline.__doc__`, чтобы отличить GNU readline от libedit.1819Привязки клавиш Readline можно настроить через файл инициализации, обычно `.inputrc` в вашем домашнем каталоге. Смотрите [Файл инициализации Readline](https://python-all.ru/3.6/library/readline.html) в руководстве GNU Readline для получения информации о формате и допустимых конструкциях этого файла, а также о возможностях библиотеки Readline в целом.2021## 6.7.1. Файл инициализации2223Следующие функции относятся к файлу инициализации и пользовательской конфигурации:2425#### `readline.parse_and_bind(string)`2627Выполняет строку инициализации, переданную в аргументе *string*. Это вызывает `rl_parse_and_bind()` в базовой библиотеке.2829#### `readline.read_init_file([filename])`3031Выполняет файл инициализации readline. По умолчанию используется имя последнего использованного файла. Вызывает `rl_read_init_file()` в базовой библиотеке.3233## 6.7.2. Буфер строки3435Следующие функции работают с буфером строки:3637#### `readline.get_line_buffer()`3839Возвращает текущее содержимое буфера строки (`rl_line_buffer` в базовой библиотеке).4041#### `readline.insert_text(string)`4243Вставляет текст в буфер строки в позиции курсора. Это вызывает `rl_insert_text()` в базовой библиотеке, но игнорирует возвращаемое значение.4445#### `readline.redisplay()`4647Изменяет отображаемое на экране, чтобы отразить текущее содержимое буфера строки. Это вызывает `rl_redisplay()` в базовой библиотеке.4849## 6.7.3. Файл истории5051Следующие функции работают с файлом истории:5253#### `readline.read_history_file([filename])`5455Загружает файл истории readline и добавляет его в список истории. По умолчанию используется имя файла `~/.history`. Вызывает `read_history()` в базовой библиотеке.5657#### `readline.write_history_file([filename])`5859Сохраняет список истории в файл истории readline, перезаписывая любой существующий файл. По умолчанию используется имя файла `~/.history`. Вызывает `write_history()` в базовой библиотеке.6061#### `readline.append_history_file(nelements[, filename])`6263Добавляет последние *nelements* элементов истории в файл. По умолчанию используется имя файла `~/.history`. Файл уже должен существовать. Вызывает `append_history()` в базовой библиотеке. Эта функция существует, только если Python был собран с версией библиотеки, которая её поддерживает.6465Новое в версии 3.5.6667#### `readline.get_history_length()`6869#### `readline.set_history_length(length)`7071Устанавливает или возвращает нужное количество строк для сохранения в файле истории. Функция [`write_history_file()`](https://python-all.ru/3.6/library/readline.html#readline.write_history_file) использует это значение для усечения файла истории, вызывая `history_truncate_file()` в нижележащей библиотеке. Отрицательные значения означают неограниченный размер файла истории.7273## 6.7.4. Список истории7475Следующие функции работают с глобальным списком истории:7677#### `readline.clear_history()`7879Очищает текущую историю. Вызывает `clear_history()` в нижележащей библиотеке. Функция Python существует только если Python был скомпилирован для версии библиотеки, которая её поддерживает.8081#### `readline.get_current_history_length()`8283Возвращает количество элементов, находящихся в истории. (Отличается от [`get_history_length()`](https://python-all.ru/3.6/library/readline.html#readline.get_history_length), которая возвращает максимальное количество строк, которое будет записано в файл истории.)8485#### `readline.get_history_item(index)`8687Возвращает текущее содержимое элемента истории по *index*. Индекс элемента начинается с 1. Вызывает `history_get()` в нижележащей библиотеке.8889#### `readline.remove_history_item(pos)`9091Удаляет элемент истории, заданный по его позиции, из истории. Позиция начинается с 0. Вызывает `remove_history()` в нижележащей библиотеке.9293#### `readline.replace_history_item(pos, line)`9495Заменяет элемент истории, заданный по его позиции, на *line*. Позиция начинается с 0. Вызывает `replace_history_entry()` в нижележащей библиотеке.9697#### `readline.add_history(line)`9899Добавляет *line* в буфер истории, как если бы это была последняя введённая строка. Вызывает `add_history()` в нижележащей библиотеке.100101#### `readline.set_auto_history(enabled)`102103Включает или отключает автоматические вызовы `add_history()` при чтении ввода через readline. Аргумент *enabled* должен быть булевым значением: если true – включает авто-историю, если false – отключает авто-историю.104105Новое в версии 3.6.106107**Деталь реализации CPython:** Авто-история включена по умолчанию, и изменения не сохраняются между сеансами.108109## 6.7.5. Стартовые хуки110111#### `readline.set_startup_hook([function])`112113Устанавливает или удаляет функцию, вызываемую колбэком `rl_startup_hook` нижележащей библиотеки. Если указан *function*, он будет использоваться как новая функция-хук; если опущен или `None`, любая ранее установленная функция удаляется. Хук вызывается без аргументов непосредственно перед тем, как readline выведет первое приглашение.114115#### `readline.set_pre_input_hook([function])`116117Устанавливает или удаляет функцию, вызываемую колбэком `rl_pre_input_hook` нижележащей библиотеки. Если указан *function*, он будет использоваться как новая функция-хук; если опущен или `None`, любая ранее установленная функция удаляется. Хук вызывается без аргументов после вывода первого приглашения и непосредственно перед тем, как readline начнёт читать вводимые символы. Эта функция существует только если Python был скомпилирован для версии библиотеки, которая его поддерживает.118119## 6.7.6. Автодополнение120121Следующие функции относятся к реализации пользовательской функции завершения слов. Обычно она вызывается клавишей Tab и может предлагать и автоматически завершать вводимое слово. По умолчанию Readline настроен для использования [`rlcompleter`](https://python-all.ru/3.6/library/rlcompleter.html#module-rlcompleter) для завершения идентификаторов Python в интерактивном интерпретаторе. Если модуль [`readline`](https://python-all.ru/3.6/library/readline.html#module-readline) должен использоваться с пользовательским комплитером, следует задать другой набор разделителей слов.122123#### `readline.set_completer([function])`124125Установить или удалить функцию дополнения. Если указана *function*, она будет использоваться как новая функция дополнения; если опущена или `None`, любая установленная ранее функция дополнения удаляется. Функция дополнения вызывается как `function(text, state)` для *state* в `0`, `1`, `2`, … пока не вернет нестроковое значение. Она должна возвращать следующее возможное дополнение, начинающееся с *text*.126127Установленная функция дополнения вызывается колбэком *entry\_func*, переданным в `rl_completion_matches()` в нижележащей библиотеке. Строка *text* берется из первого параметра колбэка `rl_attempted_completion_function` нижележащей библиотеки.128129#### `readline.get_completer()`130131Возвращает функцию дополнения или `None`, если функция дополнения не была установлена.132133#### `readline.get_completion_type()`134135Возвращает тип выполняемого дополнения. Возвращает переменную `rl_completion_type` из нижележащей библиотеки в виде целого числа.136137#### `readline.get_begidx()`138139#### `readline.get_endidx()`140141Получить начальный или конечный индекс области завершения. Эти индексы – аргументы *start* и *end*, передаваемые в колбэк `rl_attempted_completion_function` нижележащей библиотеки.142143#### `readline.set_completer_delims(string)`144145#### `readline.get_completer_delims()`146147Устанавливает или возвращает разделители слов для дополнения. Они определяют начало слова, для которого рассматривается дополнение (область дополнения). Эти функции обращаются к переменной `rl_completer_word_break_characters` в нижележащей библиотеке.148149#### `readline.set_completion_display_matches_hook([function])`150151Устанавливает или удаляет функцию отображения дополнений. Если указана *function*, она будет использоваться как новая функция отображения дополнений; если опущена или `None`, любая установленная ранее функция отображения дополнений удаляется. Эта функция устанавливает или очищает колбэк `rl_completion_display_matches_hook` в нижележащей библиотеке. Функция отображения дополнений вызывается как `function(substitution, [matches], longest_match_length)` каждый раз, когда нужно отобразить совпадения.152153## 6.7.7. Пример154155Следующий пример демонстрирует, как использовать функции чтения и записи истории модуля [`readline`](https://python-all.ru/3.6/library/readline.html#module-readline) для автоматической загрузки и сохранения файла истории с именем `.python_history` из домашнего каталога пользователя. Приведенный ниже код обычно выполняется автоматически во время интерактивных сессий из файла [`PYTHONSTARTUP`](https://python-all.ru/3.6/using/cmdline.html#envvar-PYTHONSTARTUP) пользователя.156157```python158import atexit159import os160import readline161162histfile = os.path.join(os.path.expanduser("~"), ".python_history")163try:164 readline.read_history_file(histfile)165 # длина истории по умолчанию равна -1 (бесконечность), что может привести к неконтролируемому росту166 readline.set_history_length(1000)167except FileNotFoundError:168 pass169170atexit.register(readline.write_history_file, histfile)171```172173Этот код фактически выполняется автоматически при запуске Python в [интерактивном режиме](https://python-all.ru/3.6/tutorial/interpreter.html#tut-interactive) (см. [Настройка Readline](https://python-all.ru/3.6/library/site.html#rlcompleter-config)).174175Следующий пример достигает той же цели, но поддерживает параллельные интерактивные сессии, добавляя только новую историю.176177```python178import atexit179import os180import readline181histfile = os.path.join(os.path.expanduser("~"), ".python_history")182183try:184 readline.read_history_file(histfile)185 h_len = readline.get_current_history_length()186except FileNotFoundError:187 open(histfile, 'wb').close()188 h_len = 0189190def save(prev_h_len, histfile):191 new_h_len = readline.get_current_history_length()192 readline.set_history_length(1000)193 readline.append_history_file(new_h_len - prev_h_len, histfile)194atexit.register(save, h_len, histfile)195```196197Следующий пример расширяет класс [`code.InteractiveConsole`](https://python-all.ru/3.6/library/code.html#code.InteractiveConsole) для поддержки сохранения и восстановления истории.198199```python200import atexit201import code202import os203import readline204205class HistoryConsole(code.InteractiveConsole):206 def __init__(self, locals=None, filename="<console>",207 histfile=os.path.expanduser("~/.console-history")):208 code.InteractiveConsole.__init__(self, locals, filename)209 self.init_history(histfile)210211 def init_history(self, histfile):212 readline.parse_and_bind("tab: complete")213 if hasattr(readline, "read_history_file"):214 try:215 readline.read_history_file(histfile)216 except FileNotFoundError:217 pass218 atexit.register(self.save_history, histfile)219220 def save_history(self, histfile):221 readline.set_history_length(1000)222 readline.write_history_file(histfile)223```224