argenta 0.5.0b2__py3-none-any.whl → 1.0.0a0__py3-none-any.whl

argenta/app/autocompleter/entity.py

@@ -3,13 +3,25 @@ import readline
 
 
 class AutoCompleter:
-    def __init__(self, history_filename: str = False, autocomplete_button: str = 'tab'):
+    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 = []
+        self.matches: list[str] = []
 
-    def complete(self, text, state):
-        matches = sorted(cmd for cmd in self.get_history_items() if cmd.startswith(text))
+    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:]:
@@ -26,7 +38,12 @@ class AutoCompleter:
         else:
             return None
 
-    def initial_setup(self, all_commands: list[str]):
+    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)
@@ -38,10 +55,18 @@ class AutoCompleter:
         readline.set_completer_delims(readline.get_completer_delims().replace(' ', ''))
         readline.parse_and_bind(f'{self.autocomplete_button}: complete')
 
-    def exit_setup(self):
+    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():
+    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)]

argenta/app/defaults.py

@@ -2,7 +2,10 @@ from dataclasses import dataclass
 
 
 @dataclass
-class PredeterminedMessages:
+class PredefinedMessages:
+    """
+    Public. A dataclass with predetermined messages for quick use
+    """
     USAGE = '[b dim]Usage[/b dim]: [i]<command> <[green]flags[/green]>[/i]'
     HELP = '[b dim]Help[/b dim]: [i]<command>[/i] [b red]--help[/b red]'
     AUTOCOMPLETE = '[b dim]Autocomplete[/b dim]: [i]<part>[/i] [bold]<tab>'

argenta/app/dividing_line/models.py

@@ -1,24 +1,68 @@
-class BaseDividingLine:
-    def __init__(self, unit_part: str = '-'):
-        self.unit_part = unit_part
+from abc import ABC
 
-    def get_unit_part(self):
-        if len(self.unit_part) == 0:
+
+class BaseDividingLine(ABC):
+    def __init__(self, unit_part: str = '-') -> None:
+        """
+        Private. The basic dividing line
+        :param unit_part: the single part of the dividing line
+        :return: None
+        """
+        self._unit_part = unit_part
+
+    def get_unit_part(self) -> str:
+        """
+        Private. Returns the unit part of the dividing line
+        :return: unit_part of dividing line as str
+        """
+        if len(self._unit_part) == 0:
             return ' '
         else:
-            return self.unit_part[0]
+            return self._unit_part[0]
+
 
 class StaticDividingLine(BaseDividingLine):
-    def __init__(self, unit_part: str = '-', length: int = 25):
+    def __init__(self, unit_part: str = '-', length: int = 25) -> None:
+        """
+        Public. The static dividing line
+        :param unit_part: the single part of the dividing line
+        :param length: the length of the dividing line
+        :return: None
+        """
         super().__init__(unit_part)
         self.length = length
 
-    def get_full_line(self):
-        return f'\n[dim]{self.length * self.get_unit_part()}[/dim]\n'
+    def get_full_static_line(self, is_override: bool) -> str:
+        """
+        Private. Returns the full line of the dividing line
+        :param is_override: has the default text layout been redefined
+        :return: full line of dividing line as str
+        """
+        if is_override:
+            return f'\n{self.length * self.get_unit_part()}\n'
+        else:
+            return f'\n[dim]{self.length * self.get_unit_part()}[/dim]\n'
 
 
 class DynamicDividingLine(BaseDividingLine):
-    def get_full_line(self, length: int):
-        return f'\n[dim]{self.get_unit_part() * length}[/dim]\n'
+    def __init__(self, unit_part: str = '-') -> None:
+        """
+        Public. The dynamic dividing line
+        :param unit_part: the single part of the dividing line
+        :return: None
+        """
+        super().__init__(unit_part)
+
+    def get_full_dynamic_line(self, length: int, is_override: bool) -> str:
+        """
+        Private. Returns the full line of the dividing line
+        :param length: the length of the dividing line
+        :param is_override: has the default text layout been redefined
+        :return: full line of dividing line as str
+        """
+        if is_override:
+            return f'\n{length * self.get_unit_part()}\n'
+        else:
+            return f'\n[dim]{self.get_unit_part() * length}[/dim]\n'
 
 

argenta/app/exceptions.py

@@ -1,10 +1,8 @@
-class NoRegisteredRoutersException(Exception):
-    def __str__(self):
-        return "No Registered Router Found"
-
-
 class NoRegisteredHandlersException(Exception):
-    def __init__(self, router_name):
+    """
+    The router has no registered handlers
+    """
+    def __init__(self, router_name) -> None:
         self.router_name = router_name
     def __str__(self):
         return f"No Registered Handlers Found For '{self.router_name}'"

argenta/app/models.py

@@ -15,29 +15,29 @@ from argenta.command.exceptions import (UnprocessedInputFlagException,
                                         RepeatedInputFlagsException,
                                         EmptyInputCommandException,
                                         BaseInputCommandException)
-from argenta.app.exceptions import (NoRegisteredRoutersException,
-                                    NoRegisteredHandlersException)
+from argenta.app.exceptions import NoRegisteredHandlersException
 from argenta.app.registered_routers.entity import RegisteredRouters
 
 
 
-class AppInit:
+class BaseApp:
     def __init__(self,
-                 prompt: str = '[italic dim bold]What do you want to do?\n',
-                 initial_message: str = '\nArgenta\n',
-                 farewell_message: str = '\nSee you\n',
-                 exit_command: Command = Command('Q', 'Exit command'),
-                 system_points_title: str | None = 'System points:',
-                 ignore_command_register: bool = True,
-                 dividing_line: StaticDividingLine | DynamicDividingLine = StaticDividingLine(),
-                 repeat_command_groups: bool = True,
-                 override_system_messages: bool = False,
-                 autocompleter: AutoCompleter = AutoCompleter(),
-                 print_func: Callable[[str], None] = Console().print) -> None:
+                 prompt: str,
+                 initial_message: str,
+                 farewell_message: str,
+                 exit_command: Command,
+                 system_router_title: str | None,
+                 ignore_command_register: bool,
+                 dividing_line: StaticDividingLine | DynamicDividingLine,
+                 repeat_command_groups: bool,
+                 override_system_messages: bool,
+                 autocompleter: AutoCompleter,
+                 print_func: Callable[[str], None]) -> None:
+
         self._prompt = prompt
         self._print_func = print_func
         self._exit_command = exit_command
-        self._system_points_title = system_points_title
+        self._system_router_title = system_router_title
         self._dividing_line = dividing_line
         self._ignore_command_register = ignore_command_register
         self._repeat_command_groups_description = repeat_command_groups
@@ -48,44 +48,79 @@ class AppInit:
         self._initial_message = initial_message
 
 
-        self._description_message_gen: Callable[[str, str], str] = lambda command, description: f'[bold red]{escape('['+command+']')}[/bold red] [blue dim]*=*=*[/blue dim] [bold yellow italic]{escape(description)}'
+        self._description_message_gen: Callable[[str, str], str] = lambda command, description: f'[{command}] *=*=* {description}'
         self._registered_routers: RegisteredRouters = RegisteredRouters()
-        self._messages_on_startup = []
+        self._messages_on_startup: list[str] = []
+
+        self._all_registered_triggers_in_lower: list[str] = []
+        self._all_registered_triggers_in_default_case: list[str] = []
 
-        self._invalid_input_flags_handler: Callable[[str], None] = lambda raw_command: print_func(f'[red bold]Incorrect flag syntax: {escape(raw_command)}')
-        self._repeated_input_flags_handler: Callable[[str], None] = lambda raw_command: print_func(f'[red bold]Repeated input flags: {escape(raw_command)}')
-        self._empty_input_command_handler: Callable[[], None] = lambda: print_func('[red bold]Empty input command')
-        self._unknown_command_handler: Callable[[InputCommand], None] = lambda command: print_func(f"[red bold]Unknown command: {escape(command.get_trigger())}")
+        self._invalid_input_flags_handler: Callable[[str], None] = lambda raw_command: print_func(f'Incorrect flag syntax: {raw_command}')
+        self._repeated_input_flags_handler: Callable[[str], None] = lambda raw_command: print_func(f'Repeated input flags: {raw_command}')
+        self._empty_input_command_handler: Callable[[], None] = lambda: print_func('Empty input command')
+        self._unknown_command_handler: Callable[[InputCommand], None] = lambda command: print_func(f"Unknown command: {command.get_trigger()}")
         self._exit_command_handler: Callable[[], None] = lambda: print_func(self._farewell_message)
 
 
-class AppSetters(AppInit):
     def set_description_message_pattern(self, pattern: Callable[[str, str], str]) -> None:
+        """
+        Public. Sets the output pattern of the available commands
+        :param pattern: output pattern of the available commands
+        :return: None
+        """
         self._description_message_gen: Callable[[str, str], str] = pattern
 
 
     def set_invalid_input_flags_handler(self, handler: Callable[[str], None]) -> None:
+        """
+        Public. Sets the handler for incorrect flags when entering a command
+        :param handler: handler for incorrect flags when entering a command
+        :return: None
+        """
         self._invalid_input_flags_handler = handler
 
 
     def set_repeated_input_flags_handler(self, handler: Callable[[str], None]) -> None:
+        """
+        Public. Sets the handler for repeated flags when entering a command
+        :param handler: handler for repeated flags when entering a command
+        :return: None
+        """
         self._repeated_input_flags_handler = handler
 
 
     def set_unknown_command_handler(self, handler: Callable[[str], None]) -> None:
+        """
+        Public. Sets the handler for unknown commands when entering a command
+        :param handler: handler for unknown commands when entering a command
+        :return: None
+        """
         self._unknown_command_handler = handler
 
 
     def set_empty_command_handler(self, handler: Callable[[], None]) -> None:
+        """
+        Public. Sets the handler for empty commands when entering a command
+        :param handler: handler for empty commands when entering a command
+        :return: None
+        """
         self._empty_input_command_handler = handler
 
 
     def set_exit_command_handler(self, handler: Callable[[], None]) -> None:
+        """
+        Public. Sets the handler for exit command when entering a command
+        :param handler: handler for exit command when entering a command
+        :return: None
+        """
         self._exit_command_handler = handler
 
 
-class AppPrinters(AppInit):
-    def _print_command_group_description(self):
+    def _print_command_group_description(self) -> None:
+        """
+        Private. Prints the description of the available commands
+        :return: None
+        """
         for registered_router in self._registered_routers:
             if registered_router.get_title():
                 self._print_func(registered_router.get_title())
@@ -96,54 +131,74 @@ class AppPrinters(AppInit):
             self._print_func('')
 
 
-    def _print_framed_text_with_dynamic_line(self, text: str):
-        clear_text = re.sub(r'\u001b\[[0-9;]*m', '', text)
-        max_length_line = max([len(line) for line in clear_text.split('\n')])
-        max_length_line = max_length_line if 10 <= max_length_line <= 80 else 80 if max_length_line > 80 else 10
-        self._print_func(self._dividing_line.get_full_line(max_length_line))
-        print(text.strip('\n'))
-        self._print_func(self._dividing_line.get_full_line(max_length_line))
-
+    def _print_framed_text(self, text: str) -> None:
+        """
+        Private. Outputs text by framing it in a static or dynamic split strip
+        :param text: framed text
+        :return: None
+        """
+        if isinstance(self._dividing_line, StaticDividingLine):
+            self._print_func(self._dividing_line.get_full_static_line(self._override_system_messages))
+            self._print_func(text)
+            self._print_func(self._dividing_line.get_full_static_line(self._override_system_messages))
 
-class AppNonStandardHandlers(AppPrinters):
-    def _is_exit_command(self, command: InputCommand):
-        if command.get_trigger().lower() == self._exit_command.get_trigger().lower():
-            if self._ignore_command_register:
-                system_router.input_command_handler(command)
+        elif isinstance(self._dividing_line, DynamicDividingLine):
+            clear_text = re.sub(r'\u001b\[[0-9;]*m', '', text)
+            max_length_line = max([len(line) for line in clear_text.split('\n')])
+            max_length_line = max_length_line if 10 <= max_length_line <= 80 else 80 if max_length_line > 80 else 10
+
+            self._print_func(self._dividing_line.get_full_dynamic_line(max_length_line, self._override_system_messages))
+            print(text.strip('\n'))
+            self._print_func(self._dividing_line.get_full_dynamic_line(max_length_line, self._override_system_messages))
+
+
+    def _is_exit_command(self, command: InputCommand) -> bool:
+        """
+        Private. Checks if the given command is an exit command
+        :param command: command to check
+        :return: is it an exit command or not as bool
+        """
+        if self._ignore_command_register:
+            if command.get_trigger().lower() == self._exit_command.get_trigger().lower():
                 return True
-            elif command.get_trigger() == self._exit_command.get_trigger():
-                system_router.input_command_handler(command)
+            elif command.get_trigger().lower() in [x.lower() for x in self._exit_command.get_aliases()]:
+                return True
+        else:
+            if command.get_trigger() == self._exit_command.get_trigger():
+                return True
+            elif command.get_trigger() in self._exit_command.get_aliases():
                 return True
         return False
 
 
-    def _is_unknown_command(self, command: InputCommand):
-        for router_entity in self._registered_routers:
-            for command_handler in router_entity.get_command_handlers():
-                handled_command_trigger = command_handler.get_handled_command().get_trigger()
-                handled_command_aliases = command_handler.get_handled_command().get_aliases()
-                if handled_command_trigger.lower() == command.get_trigger().lower() and self._ignore_command_register:
-                    return False
-                elif handled_command_trigger == command.get_trigger():
-                    return False
-                elif handled_command_aliases:
-                    if (command.get_trigger().lower() in [x.lower() for x in handled_command_aliases]) and self._ignore_command_register:
-                        return False
-                    elif command.get_trigger() in handled_command_trigger:
-                        return False
-        if isinstance(self._dividing_line, StaticDividingLine):
-            self._print_func(self._dividing_line.get_full_line())
+    def _is_unknown_command(self, command: InputCommand) -> bool:
+        """
+        Private. Checks if the given command is an unknown command
+        :param command: command to check
+        :return: is it an unknown command or not as bool
+        """
+        input_command_trigger = command.get_trigger()
+        if self._ignore_command_register:
+            if input_command_trigger.lower() in self._all_registered_triggers_in_lower:
+                return False
+        else:
+            if input_command_trigger in self._all_registered_triggers_in_default_case:
+                return False
+
+        with redirect_stdout(io.StringIO()) as f:
             self._unknown_command_handler(command)
-            self._print_func(self._dividing_line.get_full_line())
-        elif isinstance(self._dividing_line, DynamicDividingLine):
-            with redirect_stdout(io.StringIO()) as f:
-                self._unknown_command_handler(command)
-                res: str = f.getvalue()
-            self._print_framed_text_with_dynamic_line(res)
+            res: str = f.getvalue()
+        self._print_framed_text(res)
         return True
 
 
     def _error_handler(self, error: BaseInputCommandException, raw_command: str) -> None:
+        """
+        Private. Handles parsing errors of the entered command
+        :param error: error being handled
+        :param raw_command: the raw input command
+        :return: None
+        """
         match error:
             case UnprocessedInputFlagException():
                 self._invalid_input_flags_handler(raw_command)
@@ -153,61 +208,127 @@ class AppNonStandardHandlers(AppPrinters):
                 self._empty_input_command_handler()
 
 
-class AppValidators(AppInit):
-    def _validate_number_of_routers(self) -> None:
-        if not self._registered_routers:
-            raise NoRegisteredRoutersException()
-
-
     def _validate_included_routers(self) -> None:
+        """
+        Private. Validates included routers
+        :return: None
+        """
         for router in self._registered_routers:
             if not router.get_command_handlers():
                 raise NoRegisteredHandlersException(router.get_name())
 
 
-class AppSetups(AppValidators, AppPrinters):
-    def _setup_system_router(self):
-        system_router.set_title(self._system_points_title)
+    def _setup_system_router(self) -> None:
+        """
+        Private. Sets up system router
+        :return: None
+        """
+        system_router.set_title(self._system_router_title)
 
         @system_router.command(self._exit_command)
         def exit_command():
             self._exit_command_handler()
 
         if system_router not in self._registered_routers.get_registered_routers():
-            system_router.set_ignore_command_register(self._ignore_command_register)
+            system_router.set_command_register_ignore(self._ignore_command_register)
             self._registered_routers.add_registered_router(system_router)
 
-    def _setup_default_view(self):
-        if not self._override_system_messages:
-            self._initial_message = f'\n[bold red]{text2art(self._initial_message, font='tarty1')}\n\n'
-            self._farewell_message = (
-                f'[bold red]\n{text2art(f'\n{self._farewell_message}\n', font='chanky')}[/bold red]\n'
-                f'[red i]github.com/koloideal/Argenta[/red i] | [red bold i]made by kolo[/red bold i]\n')
 
-    def _pre_cycle_setup(self):
+    def _setup_default_view(self) -> None:
+        """
+        Private. Sets up default app view
+        :return: None
+        """
+        if not self._override_system_messages:
+            self._initial_message = f'\n[bold red]{text2art(self._initial_message, font="tarty1")}\n\n'
+            self._farewell_message = (f'[bold red]\n{text2art(f"\n{self._farewell_message}\n", font="chanky")}[/bold red]\n'
+                                      f'[red i]github.com/koloideal/Argenta[/red i] | [red bold i]made by kolo[/red bold i]\n')
+            self._description_message_gen = lambda command, description: (f'[bold red]{escape("[" + command + "]")}[/bold red] '
+                                                                          f'[blue dim]*=*=*[/blue dim] '
+                                                                          f'[bold yellow italic]{escape(description)}')
+            self._invalid_input_flags_handler = lambda raw_command: self._print_func(f'[red bold]Incorrect flag syntax: {escape(raw_command)}')
+            self._repeated_input_flags_handler = lambda raw_command: self._print_func(f'[red bold]Repeated input flags: {escape(raw_command)}')
+            self._empty_input_command_handler = lambda: self._print_func('[red bold]Empty input command')
+            self._unknown_command_handler = lambda command: self._print_func(f"[red bold]Unknown command: {escape(command.get_trigger())}")
+
+
+    def _pre_cycle_setup(self) -> None:
+        """
+        Private. Configures various aspects of the application before the start of the cycle
+        :return: None
+        """
         self._setup_default_view()
         self._setup_system_router()
-        self._validate_number_of_routers()
         self._validate_included_routers()
 
-        all_triggers: list[str] = []
         for router_entity in self._registered_routers:
-            all_triggers.extend(router_entity.get_triggers())
-            all_triggers.extend(router_entity.get_aliases())
-        self._autocompleter.initial_setup(all_triggers)
+            self._all_registered_triggers_in_default_case.extend(router_entity.get_triggers())
+            self._all_registered_triggers_in_default_case.extend(router_entity.get_aliases())
+
+            self._all_registered_triggers_in_lower.extend([x.lower() for x in router_entity.get_triggers()])
+            self._all_registered_triggers_in_lower.extend([x.lower() for x in router_entity.get_aliases()])
+
+        self._autocompleter.initial_setup(self._all_registered_triggers_in_lower)
 
         self._print_func(self._initial_message)
 
         for message in self._messages_on_startup:
             self._print_func(message)
-        print('\n\n')
+        if self._messages_on_startup:
+            print('\n\n')
 
         if not self._repeat_command_groups_description:
             self._print_command_group_description()
 
 
-class App(AppSetters, AppNonStandardHandlers, AppSetups):
-    def start_polling(self) -> None:
+
+class App(BaseApp):
+    def __init__(self,
+                 prompt: str = '[italic dim bold]What do you want to do?\n',
+                 initial_message: str = '\nArgenta\n',
+                 farewell_message: str = '\nSee you\n',
+                 exit_command: Command = Command('Q', 'Exit command'),
+                 system_router_title: str | None = 'System points:',
+                 ignore_command_register: bool = True,
+                 dividing_line: StaticDividingLine | DynamicDividingLine = StaticDividingLine(),
+                 repeat_command_groups: bool = True,
+                 override_system_messages: bool = False,
+                 autocompleter: AutoCompleter = AutoCompleter(),
+                 print_func: Callable[[str], None] = Console().print) -> None:
+        """
+        Public. The essence of the application itself.
+        Configures and manages all aspects of the behavior and presentation of the user interacting with the user
+        :param prompt: displayed before entering the command
+        :param initial_message: displayed at the start of the app
+        :param farewell_message: displayed at the end of the app
+        :param exit_command: the entity of the command that will be terminated when entered
+        :param system_router_title: system router title
+        :param ignore_command_register: whether to ignore the case of the entered commands
+        :param dividing_line: the entity of the dividing line
+        :param repeat_command_groups: whether to repeat the available commands and their description
+        :param override_system_messages: whether to redefine the default formatting of system messages
+        :param autocompleter: the entity of the autocompleter
+        :param print_func: system messages text output function
+        :return: None
+        """
+        super().__init__(prompt=prompt,
+                         initial_message=initial_message,
+                         farewell_message=farewell_message,
+                         exit_command=exit_command,
+                         system_router_title=system_router_title,
+                         ignore_command_register=ignore_command_register,
+                         dividing_line=dividing_line,
+                         repeat_command_groups=repeat_command_groups,
+                         override_system_messages=override_system_messages,
+                         autocompleter=autocompleter,
+                         print_func=print_func)
+
+
+    def run_polling(self) -> None:
+        """
+        Private. Starts the user input processing cycle
+        :return: None
+        """
         self._pre_cycle_setup()
         while True:
             if self._repeat_command_groups_description:
@@ -218,50 +339,55 @@ class App(AppSetters, AppNonStandardHandlers, AppSetups):
             try:
                 input_command: InputCommand = InputCommand.parse(raw_command=raw_command)
             except BaseInputCommandException as error:
-                if isinstance(self._dividing_line, StaticDividingLine):
-                    self._print_func(self._dividing_line.get_full_line())
+                with redirect_stdout(io.StringIO()) as f:
                     self._error_handler(error, raw_command)
-                    self._print_func(self._dividing_line.get_full_line())
-                elif isinstance(self._dividing_line, DynamicDividingLine):
-                    with redirect_stdout(io.StringIO()) as f:
-                        self._error_handler(error, raw_command)
-                        res: str = f.getvalue()
-                    self._print_framed_text_with_dynamic_line(res)
+                    res: str = f.getvalue()
+                self._print_framed_text(res)
                 continue
 
             if self._is_exit_command(input_command):
+                system_router.finds_appropriate_handler(input_command)
                 self._autocompleter.exit_setup()
                 return
 
             if self._is_unknown_command(input_command):
                 continue
 
-            if isinstance(self._dividing_line, StaticDividingLine):
-                self._print_func(self._dividing_line.get_full_line())
+            with redirect_stdout(io.StringIO()) as f:
                 for registered_router in self._registered_routers:
-                    registered_router.input_command_handler(input_command)
-                self._print_func(self._dividing_line.get_full_line())
-            elif isinstance(self._dividing_line, DynamicDividingLine):
-                with redirect_stdout(io.StringIO()) as f:
-                    for registered_router in self._registered_routers:
-                        registered_router.input_command_handler(input_command)
-                    res: str = f.getvalue()
-                self._print_framed_text_with_dynamic_line(res)
+                    registered_router.finds_appropriate_handler(input_command)
+                res: str = f.getvalue()
+            self._print_framed_text(res)
 
             if not self._repeat_command_groups_description:
                 self._print_func(self._prompt)
 
 
     def include_router(self, router: Router) -> None:
-        router.set_ignore_command_register(self._ignore_command_register)
+        """
+        Public. Registers the router in the application
+        :param router: registered router
+        :return: None
+        """
+        router.set_command_register_ignore(self._ignore_command_register)
         self._registered_routers.add_registered_router(router)
 
 
     def include_routers(self, *routers: Router) -> None:
+        """
+        Public. Registers the routers in the application
+        :param routers: registered routers
+        :return: None
+        """
         for router in routers:
             self.include_router(router)
 
 
     def add_message_on_startup(self, message: str) -> None:
+        """
+        Public. Adds a message that will be displayed when the application is launched
+        :param message: the message being added
+        :return: None
+        """
         self._messages_on_startup.append(message)