readline.md
1> **Источник:** https://python-all.ru/3.10/library/readline.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# [`readline`](https://python-all.ru/3.10/library/readline.html#module-readline) – интерфейс GNU readline89---1011Модуль [`readline`](https://python-all.ru/3.10/library/readline.html#module-readline) определяет ряд функций для упрощения дополнения и чтения/записи файлов истории из интерпретатора Python. Этот модуль можно использовать напрямую или через модуль [`rlcompleter`](https://python-all.ru/3.10/library/rlcompleter.html#module-rlcompleter), который поддерживает дополнение идентификаторов Python в интерактивной строке. Настройки, сделанные с помощью этого модуля, влияют на поведение как интерактивной строки интерпретатора, так и строк, предлагаемых встроенной функцией [`input()`](https://python-all.ru/3.10/library/functions.html#input).1213Привязки клавиш Readline можно настроить через файл инициализации, обычно `.inputrc` в вашем домашнем каталоге. Смотрите [Файл инициализации Readline](https://python-all.ru/3.10/library/readline.html) в руководстве GNU Readline для получения информации о формате и допустимых конструкциях этого файла, а также о возможностях библиотеки Readline в целом.1415> **Примечание**16>17> Базовый API библиотеки Readline может быть реализован библиотекой `libedit` вместо GNU readline. На macOS модуль [`readline`](https://python-all.ru/3.10/library/readline.html#module-readline) во время выполнения определяет, какая библиотека используется.18>19> Конфигурационный файл для `libedit` отличается от файла GNU readline. Если строки конфигурации загружаются программно, можно проверить наличие текста «libedit» в `readline.__doc__`, чтобы отличить GNU readline от libedit.20>21> Если на macOS используется эмуляция readline *editline*/`libedit`, файл инициализации в домашнем каталоге называется `.editrc`. Например, следующее содержимое в `~/.editrc` включит привязки клавиш *vi* и автодополнение по табуляции:22>23> ```python24> python:bind -v25> python:bind ^I rl_complete26> ```2728## Файл инициализации2930Следующие функции относятся к файлу инициализации и пользовательской конфигурации:3132#### `readline.parse_and_bind(string)`3334Выполняет строку инициализации, переданную в аргументе *string*. Это вызывает `rl_parse_and_bind()` в базовой библиотеке.3536#### `readline.read_init_file([filename])`3738Выполняет файл инициализации readline. По умолчанию используется имя последнего использованного файла. Вызывает `rl_read_init_file()` в базовой библиотеке.3940## Буфер строки4142Следующие функции работают с буфером строки:4344#### `readline.get_line_buffer()`4546Возвращает текущее содержимое буфера строки (`rl_line_buffer` в базовой библиотеке).4748#### `readline.insert_text(string)`4950Вставляет текст в буфер строки в позиции курсора. Это вызывает `rl_insert_text()` в базовой библиотеке, но игнорирует возвращаемое значение.5152#### `readline.redisplay()`5354Изменяет отображаемое на экране, чтобы отразить текущее содержимое буфера строки. Это вызывает `rl_redisplay()` в базовой библиотеке.5556## Файл истории5758Следующие функции работают с файлом истории:5960#### `readline.read_history_file([filename])`6162Загружает файл истории readline и добавляет его в список истории. По умолчанию используется имя файла `~/.history`. Вызывает `read_history()` в базовой библиотеке.6364#### `readline.write_history_file([filename])`6566Сохраняет список истории в файл истории readline, перезаписывая любой существующий файл. По умолчанию используется имя файла `~/.history`. Вызывает `write_history()` в базовой библиотеке.6768#### `readline.append_history_file(nelements[, filename])`6970Добавляет последние *nelements* элементов истории в файл. По умолчанию используется имя файла `~/.history`. Файл уже должен существовать. Вызывает `append_history()` в базовой библиотеке. Эта функция существует, только если Python был собран с версией библиотеки, которая её поддерживает.7172Новое в версии 3.5.7374#### `readline.get_history_length()`7576#### `readline.set_history_length(length)`7778Устанавливает или возвращает нужное количество строк для сохранения в файле истории. Функция [`write_history_file()`](https://python-all.ru/3.10/library/readline.html#readline.write_history_file) использует это значение для усечения файла истории, вызывая `history_truncate_file()` в нижележащей библиотеке. Отрицательные значения означают неограниченный размер файла истории.7980## Список истории8182Следующие функции работают с глобальным списком истории:8384#### `readline.clear_history()`8586Очищает текущую историю. Вызывает `clear_history()` в нижележащей библиотеке. Функция Python существует только если Python был скомпилирован для версии библиотеки, которая её поддерживает.8788#### `readline.get_current_history_length()`8990Возвращает количество элементов, находящихся в истории. (Отличается от [`get_history_length()`](https://python-all.ru/3.10/library/readline.html#readline.get_history_length), которая возвращает максимальное количество строк, которое будет записано в файл истории.)9192#### `readline.get_history_item(index)`9394Возвращает текущее содержимое элемента истории по *index*. Индекс элемента начинается с 1. Вызывает `history_get()` в нижележащей библиотеке.9596#### `readline.remove_history_item(pos)`9798Удаляет элемент истории, заданный по его позиции, из истории. Позиция начинается с 0. Вызывает `remove_history()` в нижележащей библиотеке.99100#### `readline.replace_history_item(pos, line)`101102Заменяет элемент истории, заданный по его позиции, на *line*. Позиция начинается с 0. Вызывает `replace_history_entry()` в нижележащей библиотеке.103104#### `readline.add_history(line)`105106Добавляет *line* в буфер истории, как если бы это была последняя введённая строка. Вызывает `add_history()` в нижележащей библиотеке.107108#### `readline.set_auto_history(enabled)`109110Включает или отключает автоматические вызовы `add_history()` при чтении ввода через readline. Аргумент *enabled* должен быть булевым значением: если true – включает авто-историю, если false – отключает авто-историю.111112Новое в версии 3.6.113114**Деталь реализации CPython:** Авто-история включена по умолчанию, и изменения не сохраняются между сеансами.115116## Хуки запуска117118#### `readline.set_startup_hook([function])`119120Устанавливает или удаляет функцию, вызываемую колбэком `rl_startup_hook` нижележащей библиотеки. Если указан *function*, он будет использоваться как новая функция-хук; если опущен или `None`, любая ранее установленная функция удаляется. Хук вызывается без аргументов непосредственно перед тем, как readline выведет первое приглашение.121122#### `readline.set_pre_input_hook([function])`123124Устанавливает или удаляет функцию, вызываемую колбэком `rl_pre_input_hook` нижележащей библиотеки. Если указан *function*, он будет использоваться как новая функция-хук; если опущен или `None`, любая ранее установленная функция удаляется. Хук вызывается без аргументов после вывода первого приглашения и непосредственно перед тем, как readline начнёт читать вводимые символы. Эта функция существует только если Python был скомпилирован для версии библиотеки, которая его поддерживает.125126## Завершение127128Следующие функции относятся к реализации пользовательской функции завершения слов. Обычно она вызывается клавишей Tab и может предлагать и автоматически завершать вводимое слово. По умолчанию Readline настроен для использования [`rlcompleter`](https://python-all.ru/3.10/library/rlcompleter.html#module-rlcompleter) для завершения идентификаторов Python в интерактивном интерпретаторе. Если модуль [`readline`](https://python-all.ru/3.10/library/readline.html#module-readline) должен использоваться с пользовательским комплитером, следует задать другой набор разделителей слов.129130#### `readline.set_completer([function])`131132Установить или удалить функцию дополнения. Если указана *function*, она будет использоваться как новая функция дополнения; если опущена или `None`, любая установленная ранее функция дополнения удаляется. Функция дополнения вызывается как `function(text, state)` для *state* в `0`, `1`, `2`, … пока не вернет нестроковое значение. Она должна возвращать следующее возможное дополнение, начинающееся с *text*.133134Установленная функция дополнения вызывается колбэком *entry\_func*, переданным в `rl_completion_matches()` в нижележащей библиотеке. Строка *text* берется из первого параметра колбэка `rl_attempted_completion_function` нижележащей библиотеки.135136#### `readline.get_completer()`137138Возвращает функцию дополнения или `None`, если функция дополнения не была установлена.139140#### `readline.get_completion_type()`141142Возвращает тип выполняемого дополнения. Возвращает переменную `rl_completion_type` из нижележащей библиотеки в виде целого числа.143144#### `readline.get_begidx()`145146#### `readline.get_endidx()`147148Возвращает начальный или конечный индекс области дополнения. Эти индексы – аргументы *start* и *end*, передаваемые в колбэк `rl_attempted_completion_function` нижележащей библиотеки. Значения могут различаться в одном и том же сценарии редактирования ввода в зависимости от реализации C readline. Например, libedit, как известно, ведет себя иначе, чем libreadline.149150#### `readline.set_completer_delims(string)`151152#### `readline.get_completer_delims()`153154Устанавливает или возвращает разделители слов для дополнения. Они определяют начало слова, для которого рассматривается дополнение (область дополнения). Эти функции обращаются к переменной `rl_completer_word_break_characters` в нижележащей библиотеке.155156#### `readline.set_completion_display_matches_hook([function])`157158Устанавливает или удаляет функцию отображения дополнений. Если указана *function*, она будет использоваться как новая функция отображения дополнений; если опущена или `None`, любая установленная ранее функция отображения дополнений удаляется. Эта функция устанавливает или очищает колбэк `rl_completion_display_matches_hook` в нижележащей библиотеке. Функция отображения дополнений вызывается как `function(substitution, [matches], longest_match_length)` каждый раз, когда нужно отобразить совпадения.159160## Пример161162Следующий пример демонстрирует, как использовать функции чтения и записи истории модуля [`readline`](https://python-all.ru/3.10/library/readline.html#module-readline) для автоматической загрузки и сохранения файла истории с именем `.python_history` из домашнего каталога пользователя. Приведенный ниже код обычно выполняется автоматически во время интерактивных сессий из файла [`PYTHONSTARTUP`](https://python-all.ru/3.10/using/cmdline.html#envvar-PYTHONSTARTUP) пользователя.163164```python165import atexit166import os167import readline168169histfile = os.path.join(os.path.expanduser("~"), ".python_history")170try:171 readline.read_history_file(histfile)172 # длина истории по умолчанию равна -1 (бесконечность), что может привести к неконтролируемому росту173 readline.set_history_length(1000)174except FileNotFoundError:175 pass176177atexit.register(readline.write_history_file, histfile)178```179180Этот код фактически выполняется автоматически при запуске Python в [интерактивном режиме](https://python-all.ru/3.10/tutorial/interpreter.html#tut-interactive) (см. [Настройка Readline](https://python-all.ru/3.10/library/site.html#rlcompleter-config)).181182Следующий пример достигает той же цели, но поддерживает параллельные интерактивные сессии, добавляя только новую историю.183184```python185import atexit186import os187import readline188histfile = os.path.join(os.path.expanduser("~"), ".python_history")189190try:191 readline.read_history_file(histfile)192 h_len = readline.get_current_history_length()193except FileNotFoundError:194 open(histfile, 'wb').close()195 h_len = 0196197def save(prev_h_len, histfile):198 new_h_len = readline.get_current_history_length()199 readline.set_history_length(1000)200 readline.append_history_file(new_h_len - prev_h_len, histfile)201atexit.register(save, h_len, histfile)202```203204Следующий пример расширяет класс [`code.InteractiveConsole`](https://python-all.ru/3.10/library/code.html#code.InteractiveConsole) для поддержки сохранения и восстановления истории.205206```python207import atexit208import code209import os210import readline211212class HistoryConsole(code.InteractiveConsole):213 def __init__(self, locals=None, filename="<console>",214 histfile=os.path.expanduser("~/.console-history")):215 code.InteractiveConsole.__init__(self, locals, filename)216 self.init_history(histfile)217218 def init_history(self, histfile):219 readline.parse_and_bind("tab: complete")220 if hasattr(readline, "read_history_file"):221 try:222 readline.read_history_file(histfile)223 except FileNotFoundError:224 pass225 atexit.register(self.save_history, histfile)226227 def save_history(self, histfile):228 readline.set_history_length(1000)229 readline.write_history_file(histfile)230```231