readline — Интерфейс GNU readline

Модуль readline определяет ряд функций для облегчения автодополнения и чтения/записи файлов истории из интерпретатора Python. Этот модуль можно использовать напрямую или через модуль rlcompleter, который поддерживает автодополнение идентификаторов Python в интерактивном режиме. Настройки, сделанные с помощью этого модуля, влияют на поведение как интерактивного приглашения интерпретатора, так и приглашений, предлагаемых встроенной функцией input().

Настройки сочетаний клавиш readline могут быть настроены через файл инициализации, обычно .inputrc в вашем домашнем каталоге. См. Файл инициализации Readline в руководстве GNU Readline для получения информации о формате и допустимых конструкциях этого файла, а также о возможностях библиотеки Readline в целом.

6.7.1. Файл инициализации

Следующие функции относятся к файлу инициализации и пользовательской конфигурации:

readline.parse_and_bind(string)

Выполняет строку инициализации, предоставленную в аргументе string. Это вызывает rl_parse_and_bind() в базовой библиотеке.

readline.read_init_file([filename])

Выполняет файл инициализации readline. Имя файла по умолчанию — последнее использованное имя файла. Это вызывает rl_read_init_file() в базовой библиотеке.

6.7.2. Буфер строки

Следующие функции работают с буфером строки:

readline.get_line_buffer()

Возвращает текущее содержимое буфера строки (rl_line_buffer в базовой библиотеке).

readline.insert_text(string)

Вставляет текст в буфер строки в позиции курсора. Это вызывает rl_insert_text() в базовой библиотеке, но игнорирует возвращаемое значение.

readline.redisplay()

Изменяет отображаемое на экране содержимое, чтобы отразить текущее содержимое буфера строки. Это вызывает rl_redisplay() в базовой библиотеке.

6.7.3. Файл истории

Следующие функции работают с файлом истории:

readline.read_history_file([filename])

Загружает файл истории readline и добавляет его в список истории. Имя файла по умолчанию — ~/.history. Это вызывает read_history() в базовой библиотеке.

readline.write_history_file([filename])

Сохраняет список истории в файл истории readline, перезаписывая любой существующий файл. Имя файла по умолчанию — ~/.history. Это вызывает write_history() в базовой библиотеке.

readline.append_history_file(nelements[, filename])

Добавляет последние nelements элементов истории в файл. Имя файла по умолчанию — ~/.history. Файл должен уже существовать. Это вызывает append_history() в базовой библиотеке. Эта функция существует только если Python был скомпилирован для версии библиотеки, которая её поддерживает.

Новая в версии 3.5.

readline.get_history_length()

readline.set_history_length(length)

Устанавливает или возвращает желаемое количество строк для сохранения в файле истории. Функция write_history_file() использует это значение для обрезки файла истории, вызывая history_truncate_file() в базовой библиотеке. Отрицательные значения означают неограниченный размер файла истории.

6.7.4. Список истории

Следующие функции работают со глобальным списком истории:

readline.clear_history()

Очищает текущую историю. Это вызывает clear_history() в базовой библиотеке. Функция Python существует только если Python был скомпилирован для версии библиотеки, которая её поддерживает.

readline.get_current_history_length()

Возвращает количество элементов, в настоящее время находящихся в истории. (Это отличается от get_history_length(), которая возвращает максимальное количество строк, которые будут записаны в файл истории.)

readline.get_history_item(index)

Возвращает текущее содержимое элемента истории в позиции index. Индекс элемента основан на единице. Это вызывает history_get() в базовой библиотеке.

readline.remove_history_item(pos)

Удаляет элемент истории, указанный его позицией, из истории. Позиция основана на нуле. Это вызывает remove_history() в базовой библиотеке.

readline.replace_history_item(pos, line)

Заменяет элемент истории, указанный его позицией, на line. Позиция основана на нуле. Это вызывает replace_history_entry() в базовой библиотеке.

readline.add_history(line)

Добавляет line в буфер истории, как если бы это была последняя набранная строка. Это вызывает add_history() в базовой библиотеке.

readline.set_auto_history(enabled)

Включает или выключает автоматические вызовы add_history() при чтении ввода через readline. Аргумент enabled должен быть логическим значением, которое, будучи истинным, включает автоисторию, а будучи ложным, выключает автоисторию.

Новая в версии 3.6.

Деталь реализации CPython: Автоистория включена по умолчанию, и изменения в этом параметре не сохраняются между сессиями.

6.7.5. Обработчики запуска

readline.set_startup_hook([function])

Устанавливает или удаляет функцию, вызываемую обратным вызовом rl_startup_hook базовой библиотеки. Если function указан, он будет использоваться как новая функция-обработчик; если опущен или None, любая установленная функция удаляется. Обработчик вызывается без аргументов незадолго до того, как readline выведет первое приглашение.

readline.set_pre_input_hook([function])

Устанавливает или удаляет функцию, вызываемую обратным вызовом rl_pre_input_hook базовой библиотеки. Если function указан, он будет использоваться как новая функция-обработчик; если опущен или None, любая установленная функция удаляется. Обработчик вызывается без аргументов после вывода первого приглашения и непосредственно перед тем, как readline начнёт чтение символов ввода. Эта функция существует только если Python был скомпилирован для версии библиотеки, которая её поддерживает.

6.7.6. Автодополнение

Следующие функции относятся к реализации пользовательской функции автодополнения слов. Она обычно активируется нажатием клавиши Tab и может предлагать и автоматически завершать вводимое слово. По умолчанию Readline настроен для использования модулем rlcompleter для автодополнения идентификаторов Python в интерактивном интерпретаторе. Если модуль readline используется с пользовательской функцией автодополнения, следует задать другие разделители слов.

readline.set_completer([function])

Устанавливает или удаляет функцию автодополнения. Если function указан, он будет использоваться как новая функция автодополнения; если опущен или None, любая установленная функция автодополнения удаляется. Функция автодополнения вызывается как function(text, state), для state в 0, 1, 2, …, пока она не вернёт значение, отличное от строки. Она должна вернуть следующее возможное автодополнение, начинающееся с text.

Установленная функция автодополнения вызывается обратным вызовом entry_func, переданным rl_completion_matches() в базовой библиотеке. Строка text поступает из первого параметра обратного вызова rl_attempted_completion_function базовой библиотеки.

readline.get_completer()

Получает функцию автодополнения или None, если функция автодополнения не была установлена.

readline.get_completion_type()

Получает тип выполняемого автодополнения. Возвращает переменную rl_completion_type в базовой библиотеке в виде целого числа.

readline.get_begidx()

readline.get_endidx()

Получает начальный или конечный индекс области автодополнения. Эти индексы являются аргументами start и end, переданными обратному вызову rl_attempted_completion_function базовой библиотеки.

readline.set_completer_delims(string)

readline.get_completer_delims()

Устанавливает или получает разделители слов для автодополнения. Они определяют начало слова, которое будет рассматриваться для автодополнения (область автодополнения). Эти функции обращаются к переменной rl_completer_word_break_characters в базовой библиотеке.

readline.set_completion_display_matches_hook([function])

Устанавливает или удаляет функцию отображения совпадений автодополнения. Если указана функция, она будет использоваться в качестве новой функции отображения совпадений; если она опущена или None, любая установленная ранее функция отображения совпадений будет удалена. Это устанавливает или очищает обратный вызов rl_completion_display_matches_hook в базовой библиотеке. Функция отображения совпадений вызывается как function(substitution, [matches], longest_match_length) один раз каждый раз, когда необходимо отобразить совпадения.

6.7.7. Пример

Следующий пример демонстрирует, как использовать функции чтения и записи истории модуля readline для автоматической загрузки и сохранения файла истории с именем .python_history из домашнего каталога пользователя. Код ниже обычно выполнялся бы автоматически во время интерактивных сеансов из файла PYTHONSTARTUP пользователя.

import atexit
import os
import readline

histfile = os.path.join(os.path.expanduser("~"), ".python_history")
try:
    readline.read_history_file(histfile)
    # default history len is -1 (infinite), which may grow unruly
    readline.set_history_length(1000)
except FileNotFoundError:
    pass

atexit.register(readline.write_history_file, histfile)

Этот код фактически автоматически выполняется при запуске Python в интерактивном режиме (см. Настройка Readline).

Следующий пример достигает той же цели, но поддерживает одновременные интерактивные сеансы, только добавляя новую историю.

import atexit
import os
import readline
histfile = os.path.join(os.path.expanduser("~"), ".python_history")

try:
    readline.read_history_file(histfile)
    h_len = readline.get_current_history_length()
except FileNotFoundError:
    open(histfile, 'wb').close()
    h_len = 0

def save(prev_h_len, histfile):
    new_h_len = readline.get_current_history_length()
    readline.set_history_length(1000)
    readline.append_history_file(new_h_len - prev_h_len, histfile)
atexit.register(save, h_len, histfile)

Следующий пример расширяет класс code.InteractiveConsole для поддержки сохранения/восстановления истории.

import atexit
import code
import os
import readline

class HistoryConsole(code.InteractiveConsole):
    def __init__(self, locals=None, filename="<console>",
                 histfile=os.path.expanduser("~/.console-history")):
        code.InteractiveConsole.__init__(self, locals, filename)
        self.init_history(histfile)

    def init_history(self, histfile):
        readline.parse_and_bind("tab: complete")
        if hasattr(readline, "read_history_file"):
            try:
                readline.read_history_file(histfile)
            except FileNotFoundError:
                pass
            atexit.register(self.save_history, histfile)

    def save_history(self, histfile):
        readline.set_history_length(1000)
        readline.write_history_file(histfile)