readline.md
1> **Источник:** https://python-all.ru/3.13/library/readline.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# `readline` – интерфейс GNU readline89---1011Модуль `readline` определяет ряд функций для упрощения дополнения и чтения/записи файлов истории из интерпретатора Python. Этот модуль можно использовать напрямую или через модуль [`rlcompleter`](https://python-all.ru/3.13/library/rlcompleter.html#module-rlcompleter), который поддерживает дополнение идентификаторов Python в интерактивной строке. Настройки, сделанные с помощью этого модуля, влияют на поведение как интерактивной строки интерпретатора, так и строк, предлагаемых встроенной функцией [`input()`](https://python-all.ru/3.13/library/functions.html#input).1213Привязки клавиш Readline можно настроить через файл инициализации, обычно `.inputrc` в вашем домашнем каталоге. Смотрите [Файл инициализации Readline](https://python-all.ru/3.13/library/readline.html) в руководстве GNU Readline для получения информации о формате и допустимых конструкциях этого файла, а также о возможностях библиотеки Readline в целом.1415[Доступность](https://python-all.ru/3.13/library/intro.html#availability): не Android, не iOS, не WASI.1617Этот модуль не поддерживается на [мобильных платформах](https://python-all.ru/3.13/library/intro.html#mobile-availability) или [платформах WebAssembly](https://python-all.ru/3.13/library/intro.html#wasm-availability).1819[Доступность](https://python-all.ru/3.13/library/intro.html#availability): Unix.2021> **Примечание**22>23> API базовой библиотеки Readline может быть реализовано библиотекой `editline` (`libedit`) вместо GNU readline. В macOS модуль `readline` определяет, какая библиотека используется во время выполнения.24>25> Файл конфигурации для `editline` отличается от файла GNU readline. Если вы программно загружаете строки конфигурации, вы можете использовать [`backend`](https://python-all.ru/3.13/library/readline.html#readline.backend), чтобы определить, какая библиотека используется.26>27> Если вы используете эмуляцию readline `editline`/`libedit` в macOS, файл инициализации, расположенный в вашем домашнем каталоге, называется `.editrc`. Например, следующее содержимое в `~/.editrc` включит привязки клавиш *vi* и дополнение по TAB:28>29> ```python30> python:bind -v31> python:bind ^I rl_complete32> ```33>34> Также обратите внимание, что разные библиотеки могут использовать разные форматы файлов истории. При смене базовой библиотеки существующие файлы истории могут стать непригодными для использования.3536#### `readline.backend`3738Имя используемой базовой библиотеки Readline: либо `"readline"`, либо `"editline"`.3940Добавлено в версии 3.13.4142## Файл инициализации4344Следующие функции относятся к файлу инициализации и пользовательской конфигурации:4546#### `readline.parse_and_bind(string)`4748Выполняет строку инициализации, переданную в аргументе *string*. Это вызывает `rl_parse_and_bind()` в базовой библиотеке.4950#### `readline.read_init_file([filename])`5152Выполняет файл инициализации readline. По умолчанию используется имя последнего использованного файла. Вызывает `rl_read_init_file()` в базовой библиотеке.5354## Буфер строки5556Следующие функции работают с буфером строки:5758#### `readline.get_line_buffer()`5960Возвращает текущее содержимое буфера строки (`rl_line_buffer` в базовой библиотеке).6162#### `readline.insert_text(string)`6364Вставляет текст в буфер строки в позиции курсора. Это вызывает `rl_insert_text()` в базовой библиотеке, но игнорирует возвращаемое значение.6566#### `readline.redisplay()`6768Изменяет отображаемое на экране, чтобы отразить текущее содержимое буфера строки. Это вызывает `rl_redisplay()` в базовой библиотеке.6970## Файл истории7172Следующие функции работают с файлом истории:7374#### `readline.read_history_file([filename])`7576Загружает файл истории readline и добавляет его в список истории. По умолчанию используется имя файла `~/.history`. Вызывает `read_history()` в базовой библиотеке.7778#### `readline.write_history_file([filename])`7980Сохраняет список истории в файл истории readline, перезаписывая любой существующий файл. По умолчанию используется имя файла `~/.history`. Вызывает `write_history()` в базовой библиотеке.8182#### `readline.append_history_file(nelements[, filename])`8384Добавляет последние *nelements* элементов истории в файл. По умолчанию используется имя файла `~/.history`. Файл уже должен существовать. Вызывает `append_history()` в базовой библиотеке. Эта функция существует, только если Python был собран с версией библиотеки, которая её поддерживает.8586Добавлено в версии 3.5.8788#### `readline.get_history_length()`8990#### `readline.set_history_length(length)`9192Устанавливает или возвращает нужное количество строк для сохранения в файле истории. Функция [`write_history_file()`](https://python-all.ru/3.13/library/readline.html#readline.write_history_file) использует это значение для усечения файла истории, вызывая `history_truncate_file()` в нижележащей библиотеке. Отрицательные значения означают неограниченный размер файла истории.9394## Список истории9596Следующие функции работают с глобальным списком истории:9798#### `readline.clear_history()`99100Очищает текущую историю. Вызывает `clear_history()` в нижележащей библиотеке. Функция Python существует только если Python был скомпилирован для версии библиотеки, которая её поддерживает.101102#### `readline.get_current_history_length()`103104Возвращает количество элементов, находящихся в истории. (Отличается от [`get_history_length()`](https://python-all.ru/3.13/library/readline.html#readline.get_history_length), которая возвращает максимальное количество строк, которое будет записано в файл истории.)105106#### `readline.get_history_item(index)`107108Возвращает текущее содержимое элемента истории по *index*. Индекс элемента начинается с 1. Вызывает `history_get()` в нижележащей библиотеке.109110#### `readline.remove_history_item(pos)`111112Удаляет элемент истории, заданный по его позиции, из истории. Позиция начинается с 0. Вызывает `remove_history()` в нижележащей библиотеке.113114#### `readline.replace_history_item(pos, line)`115116Заменяет элемент истории, заданный по его позиции, на *line*. Позиция начинается с 0. Вызывает `replace_history_entry()` в нижележащей библиотеке.117118#### `readline.add_history(line)`119120Добавляет *line* в буфер истории, как если бы это была последняя введённая строка. Вызывает `add_history()` в нижележащей библиотеке.121122#### `readline.set_auto_history(enabled)`123124Включает или отключает автоматические вызовы `add_history()` при чтении ввода через readline. Аргумент *enabled* должен быть булевым значением: если true – включает авто-историю, если false – отключает авто-историю.125126Добавлено в версии 3.6.127128**Деталь реализации CPython:** Авто-история включена по умолчанию, и изменения не сохраняются между сеансами.129130## Хуки запуска131132#### `readline.set_startup_hook([function])`133134Устанавливает или удаляет функцию, вызываемую колбэком `rl_startup_hook` нижележащей библиотеки. Если указан *function*, он будет использоваться как новая функция-хук; если опущен или `None`, любая ранее установленная функция удаляется. Хук вызывается без аргументов непосредственно перед тем, как readline выведет первое приглашение.135136#### `readline.set_pre_input_hook([function])`137138Устанавливает или удаляет функцию, вызываемую колбэком `rl_pre_input_hook` нижележащей библиотеки. Если указан *function*, он будет использоваться как новая функция-хук; если опущен или `None`, любая ранее установленная функция удаляется. Хук вызывается без аргументов после вывода первого приглашения и непосредственно перед тем, как readline начнёт читать вводимые символы. Эта функция существует только если Python был скомпилирован для версии библиотеки, которая его поддерживает.139140## Завершение141142Следующие функции относятся к реализации пользовательской функции завершения слов. Обычно она вызывается клавишей Tab и может предлагать и автоматически завершать вводимое слово. По умолчанию Readline настроен для использования [`rlcompleter`](https://python-all.ru/3.13/library/rlcompleter.html#module-rlcompleter) для завершения идентификаторов Python в интерактивном интерпретаторе. Если модуль `readline` должен использоваться с пользовательским комплитером, следует задать другой набор разделителей слов.143144#### `readline.set_completer([function])`145146Установить или удалить функцию дополнения. Если указана *function*, она будет использоваться как новая функция дополнения; если опущена или `None`, любая установленная ранее функция дополнения удаляется. Функция дополнения вызывается как `function(text, state)` для *state* в `0`, `1`, `2`, … пока не вернет нестроковое значение. Она должна возвращать следующее возможное дополнение, начинающееся с *text*.147148Установленная функция дополнения вызывается колбэком *entry\_func*, переданным в `rl_completion_matches()` в нижележащей библиотеке. Строка *text* берется из первого параметра колбэка `rl_attempted_completion_function` нижележащей библиотеки.149150#### `readline.get_completer()`151152Возвращает функцию дополнения или `None`, если функция дополнения не была установлена.153154#### `readline.get_completion_type()`155156Возвращает тип выполняемого дополнения. Возвращает переменную `rl_completion_type` из нижележащей библиотеки в виде целого числа.157158#### `readline.get_begidx()`159160#### `readline.get_endidx()`161162Возвращает начальный или конечный индекс области дополнения. Эти индексы – аргументы *start* и *end*, передаваемые в колбэк `rl_attempted_completion_function` нижележащей библиотеки. Значения могут различаться в одном и том же сценарии редактирования ввода в зависимости от реализации C readline. Например, libedit, как известно, ведет себя иначе, чем libreadline.163164#### `readline.set_completer_delims(string)`165166#### `readline.get_completer_delims()`167168Устанавливает или возвращает разделители слов для дополнения. Они определяют начало слова, для которого рассматривается дополнение (область дополнения). Эти функции обращаются к переменной `rl_completer_word_break_characters` в нижележащей библиотеке.169170#### `readline.set_completion_display_matches_hook([function])`171172Устанавливает или удаляет функцию отображения дополнений. Если указана *function*, она будет использоваться как новая функция отображения дополнений; если опущена или `None`, любая установленная ранее функция отображения дополнений удаляется. Эта функция устанавливает или очищает колбэк `rl_completion_display_matches_hook` в нижележащей библиотеке. Функция отображения дополнений вызывается как `function(substitution, [matches], longest_match_length)` каждый раз, когда нужно отобразить совпадения.173174## Пример175176Следующий пример демонстрирует, как использовать функции чтения и записи истории модуля `readline` для автоматической загрузки и сохранения файла истории с именем `.python_history` из домашнего каталога пользователя. Приведенный ниже код обычно выполняется автоматически во время интерактивных сессий из файла [`PYTHONSTARTUP`](https://python-all.ru/3.13/using/cmdline.html#envvar-PYTHONSTARTUP) пользователя.177178```python179import atexit180import os181import readline182183histfile = os.path.join(os.path.expanduser("~"), ".python_history")184try:185 readline.read_history_file(histfile)186 # длина истории по умолчанию равна -1 (бесконечность), что может привести к неконтролируемому росту187 readline.set_history_length(1000)188except FileNotFoundError:189 pass190191atexit.register(readline.write_history_file, histfile)192```193194Этот код фактически выполняется автоматически при запуске Python в [интерактивном режиме](https://python-all.ru/3.13/tutorial/interpreter.html#tut-interactive) (см. [Настройка Readline](https://python-all.ru/3.13/library/site.html#rlcompleter-config)).195196Следующий пример достигает той же цели, но поддерживает параллельные интерактивные сессии, добавляя только новую историю.197198```python199import atexit200import os201import readline202histfile = os.path.join(os.path.expanduser("~"), ".python_history")203204try:205 readline.read_history_file(histfile)206 h_len = readline.get_current_history_length()207except FileNotFoundError:208 open(histfile, 'wb').close()209 h_len = 0210211def save(prev_h_len, histfile):212 new_h_len = readline.get_current_history_length()213 readline.set_history_length(1000)214 readline.append_history_file(new_h_len - prev_h_len, histfile)215atexit.register(save, h_len, histfile)216```217218Следующий пример расширяет класс [`code.InteractiveConsole`](https://python-all.ru/3.13/library/code.html#code.InteractiveConsole) для поддержки сохранения и восстановления истории.219220```python221import atexit222import code223import os224import readline225226class HistoryConsole(code.InteractiveConsole):227 def __init__(self, locals=None, filename="<console>",228 histfile=os.path.expanduser("~/.console-history")):229 code.InteractiveConsole.__init__(self, locals, filename)230 self.init_history(histfile)231232 def init_history(self, histfile):233 readline.parse_and_bind("tab: complete")234 if hasattr(readline, "read_history_file"):235 try:236 readline.read_history_file(histfile)237 except FileNotFoundError:238 pass239 atexit.register(self.save_history, histfile)240241 def save_history(self, histfile):242 readline.set_history_length(1000)243 readline.write_history_file(histfile)244```245246> **Примечание**247>248> Новая [REPL](https://python-all.ru/3.13/glossary.html#term-REPL), представленная в версии 3.13, не поддерживает readline. Однако readline по-прежнему можно использовать, задав переменную окружения [`PYTHON_BASIC_REPL`](https://python-all.ru/3.13/using/cmdline.html#envvar-PYTHON_BASIC_REPL).249