AutoCompleter

AutoCompleter is a component responsible for interactive command autocompletion. It improves user experience by offering suggestions and completing input based on command history, which speeds up work and reduces the likelihood of typos.

Initialization

__init__(self, history_filename: str | None = None,
         autocomplete_button: str = "tab") -> None

Creates and configures an AutoCompleter instance.

  • history_filename: Filename for saving command history. If specified, history will be saved between sessions. When set to None, history is stored only within the session context.

  • autocomplete_button: Key that activates autocompletion. Defaults to Tab.

Purpose and Features

Main features of AutoCompleter:

  • History-based autocompletion: When the autocompletion key is pressed (by default Tab), the system searches history for commands starting with the already entered text.

  • Common prefix: If multiple commands with a common prefix are found, only the common part will be inserted. For example, for commands show_users and show_profile, when entering sho and pressing Tab, the input will be completed to show_.

  • Persistent history: If history_filename is specified, command history is saved to a file on exit and loaded on the next startup. This makes autocompletion “smarter” over time.

  • History cleanup: When saving, AutoCompleter removes duplicates and non-existent commands, keeping the history up to date.

  • Key customization: The autocompletion key can be changed using the autocomplete_button parameter.

Usage Example

AutoCompleter is passed as an argument when initializing App.

 1from argenta import App
 2from argenta.app import AutoCompleter
 3
 4# Setting up autocompletion with saving history to a file
 5my_autocompleter = AutoCompleter(history_filename="argenta_history.txt")
 6
 7# Passing the configured autocompleter to the application
 8app = App(autocompleter=my_autocompleter)
 9
10# ... the rest of the application logic