feat: impl docs (#4)

The entire public api is covered with documentation in two languages - Russian and English.

the library now supports the latest three versions of python - 3.12, 3.13 and 3.14

minor design changes: now, when a Boolean flag is entered, its value is an empty string, not None.

tests have been adapted to the supported versions of python, readmi has been redesigned in two languages, German is no longer available.

src/argenta/app/autocompleter/__init__.py

@@ -1,4 +1 @@
-__all__ = ["AutoCompleter"]
-
-
-from argenta.app.autocompleter.entity import AutoCompleter
+from argenta.app.autocompleter.entity import AutoCompleter as AutoCompleter

src/argenta/app/autocompleter/entity.py

@@ -1,12 +1,12 @@
+__all__ = ["AutoCompleter"]
+
 import os
 import readline
 from typing import Never
 
 
 class AutoCompleter:
-    def __init__(
-        self, history_filename: str | None = None, autocomplete_button: str = "tab"
-    ) -> None:
+    def __init__(self, history_filename: str | None = None, 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
@@ -23,22 +23,16 @@ class AutoCompleter:
         :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 _get_history_items() if cmd.startswith(text)
-        )
+        matches: list[str] = sorted(cmd for cmd in _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]
-                ):
+                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.insert_text(common_prefix[len(text) :])
                 readline.redisplay()
             return None
         elif len(matches) == 1:
@@ -54,37 +48,45 @@ class AutoCompleter:
         """
         if self.history_filename:
             if os.path.exists(self.history_filename):
-                readline.read_history_file(self.history_filename) 
+                readline.read_history_file(self.history_filename)
             else:
                 for line in all_commands:
-                    readline.add_history(line) 
+                    readline.add_history(line)
+
+        if not self.history_filename:
+            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, all_commands: list[str]) -> None:
+    def exit_setup(self, all_commands: list[str], ignore_command_register: bool) -> None:
         """
         Private. Exit setup function
         :return: None
         """
         if self.history_filename:
-            readline.write_history_file(self.history_filename) 
+            readline.write_history_file(self.history_filename)
             with open(self.history_filename, "r") as history_file:
                 raw_history = history_file.read()
             pretty_history: list[str] = []
             for line in set(raw_history.strip().split("\n")):
-                if line.split()[0] in all_commands:
+                if _is_command_exist(line.split()[0], all_commands, ignore_command_register):
                     pretty_history.append(line)
             with open(self.history_filename, "w") as history_file:
                 _ = history_file.write("\n".join(pretty_history))
 
+
+def _is_command_exist(command: str, existing_commands: list[str], ignore_command_register: bool) -> bool:
+    if ignore_command_register:
+        return command.lower() in existing_commands
+    return command in existing_commands
+
+
 def _get_history_items() -> list[str] | list[Never]:
     """
     Private. Returns a list of all commands entered by the user
     :return: all commands entered by the user as list[str] | list[Never]
     """
-    return [
-        readline.get_history_item(i)
-        for i in range(1, readline.get_current_history_length() + 1) 
-    ]
+    return [readline.get_history_item(i) for i in range(1, readline.get_current_history_length() + 1)]