pre-release v1.0.0

src/argenta/app/autocompleter/entity.py

@@ -0,0 +1,72 @@
+import os
+import readline
+
+
+class AutoCompleter:
+    def __init__(self, history_filename: str = False, autocomplete_button: str = 'tab') -> None:
+        """
+        Public. Configures and implements auto-completion of input command
+        :param history_filename: the name of the file for saving the history of the autocompleter
+        :param autocomplete_button: the button for auto-completion
+        :return: None
+        """
+        self.history_filename = history_filename
+        self.autocomplete_button = autocomplete_button
+        self.matches: list[str] = []
+
+    def complete(self, text, state) -> str | None:
+        """
+        Private. Auto-completion function
+        :param text: part of the command being entered
+        :param state: the current cursor position is relative to the beginning of the line
+        :return: the desired candidate as str or None
+        """
+        matches: list[str] = sorted(cmd for cmd in self.get_history_items() if cmd.startswith(text))
+        if len(matches) > 1:
+            common_prefix = matches[0]
+            for match in matches[1:]:
+                i = 0
+                while i < len(common_prefix) and i < len(match) and common_prefix[i] == match[i]:
+                    i += 1
+                common_prefix = common_prefix[:i]
+            if state == 0:
+                readline.insert_text(common_prefix[len(text):])
+                readline.redisplay()
+            return None
+        elif len(matches) == 1:
+            return matches[0] if state == 0 else None
+        else:
+            return None
+
+    def initial_setup(self, all_commands: list[str]) -> None:
+        """
+        Private. Initial setup function
+        :param all_commands: Registered commands for adding them to the autocomplete history
+        :return: None
+        """
+        if self.history_filename:
+            if os.path.exists(self.history_filename):
+                readline.read_history_file(self.history_filename)
+            else:
+                for line in all_commands:
+                    readline.add_history(line)
+
+        readline.set_completer(self.complete)
+        readline.set_completer_delims(readline.get_completer_delims().replace(' ', ''))
+        readline.parse_and_bind(f'{self.autocomplete_button}: complete')
+
+    def exit_setup(self) -> None:
+        """
+        Private. Exit setup function
+        :return: None
+        """
+        if self.history_filename:
+            readline.write_history_file(self.history_filename)
+
+    @staticmethod
+    def get_history_items() -> list[str] | list:
+        """
+        Private. Returns a list of all commands entered by the user
+        :return: all commands entered by the user as list[str]
+        """
+        return [readline.get_history_item(i) for i in range(1, readline.get_current_history_length() + 1)]