argenta 0.1.2__py3-none-any.whl → 0.1.3__py3-none-any.whl

argenta/app/entity.py

@@ -13,56 +13,56 @@ class App:
                  prompt: str = 'Enter a command',
                  exit_command: str = 'q',
                  ignore_exit_command_register: bool = True,
-                 initial_greeting: str = 'Hello',
-                 goodbye_message: str = 'GoodBye',
-                 line_separate: str = '\n',
-                 command_group_description_separate: str = '\n',
+                 initial_greeting: str = '\nHello, I am Argenta\n',
+                 farewell_message: str = 'GoodBye',
+                 line_separate: str = '',
+                 command_group_description_separate: str = '',
                  print_func: Callable[[str], None] = print) -> None:
         self.prompt = prompt
         self.print_func = print_func
         self.exit_command = exit_command
         self.ignore_exit_command_register = ignore_exit_command_register
-        self.goodbye_message = goodbye_message
+        self.farewell_message = farewell_message
         self.initial_greeting = initial_greeting
         self.line_separate = line_separate
         self.command_group_description_separate = command_group_description_separate
 
-        self.routers: list[Router] = []
-        self.registered_commands: list[dict[str, str | list[dict[str, Callable[[], None] | str]] | Router]] = []
-        self.main_app_router: Router | None = None
-        self._description_message_pattern = '[{command}] *=*=* {description}'
+        self._routers: list[Router] = []
+        self._registered_commands: list[dict[str, str | list[dict[str, Callable[[], None] | str]] | Router]] = []
+        self._main_app_router: Router | None = None
+        self._description_message_pattern: str = '[{command}] *=*=* {description}'
 
 
     def start_polling(self) -> None:
         self.print_func(self.initial_greeting)
-        self.validate_main_router()
+        self._validate_main_router()
 
         while True:
-            self.print_command_group_description()
+            self._print_command_group_description()
             self.print_func(self.prompt)
 
             command: str = input()
 
-            self.checking_command_for_exit_command(command)
+            self._checking_command_for_exit_command(command)
             self.print_func(self.line_separate)
 
-            is_unknown_command: bool = self.check_is_command_unknown(command)
+            is_unknown_command: bool = self._check_is_command_unknown(command)
 
             if is_unknown_command:
                 continue
 
-            for router in self.routers:
+            for router in self._routers:
                 router.input_command_handler(command)
             self.print_func(self.line_separate)
             self.print_func(self.command_group_description_separate)
 
 
     def set_initial_greeting(self, greeting: str) -> None:
-        self.initial_greeting = greeting
+        self.initial_greeting: str = greeting
 
 
-    def set_goodbye_message(self, message: str) -> None:
-        self.goodbye_message = message
+    def set_farewell_message(self, message: str) -> None:
+        self.farewell_message: str = message
 
 
     def set_description_message_pattern(self, pattern: str) -> None:
@@ -71,34 +71,34 @@ class App:
                            description='description')
         except KeyError:
             raise InvalidDescriptionMessagePatternException(pattern)
-        self._description_message_pattern = pattern
+        self._description_message_pattern: str = pattern
 
 
-    def validate_main_router(self):
-        if not self.main_app_router:
+    def _validate_main_router(self):
+        if not self._main_app_router:
             raise MissingMainRouterException()
 
-        if not self.main_app_router.unknown_command_func:
+        if not self._main_app_router.unknown_command_func:
             raise MissingHandlersForUnknownCommandsOnMainRouterException()
 
-        for router in self.routers:
-            if router.unknown_command_func and self.main_app_router is not router:
+        for router in self._routers:
+            if router.unknown_command_func and self._main_app_router is not router:
                 raise HandlerForUnknownCommandsCanOnlyBeDeclaredForMainRouterException()
 
 
-    def checking_command_for_exit_command(self, command: str):
+    def _checking_command_for_exit_command(self, command: str):
         if command.lower() == self.exit_command.lower():
             if self.ignore_exit_command_register:
-                self.print_func(self.goodbye_message)
+                self.print_func(self.farewell_message)
                 exit(0)
             else:
                 if command == self.exit_command:
-                    self.print_func(self.goodbye_message)
+                    self.print_func(self.farewell_message)
                     exit(0)
 
 
-    def check_is_command_unknown(self, command: str):
-        registered_commands = self.registered_commands
+    def _check_is_command_unknown(self, command: str):
+        registered_commands: list[dict[str, str | list[dict[str, Callable[[], None] | str]] | Router]] = self._registered_commands
         for router in registered_commands:
             for command_entity in router['commands']:
                 if command_entity['command'].lower() == command.lower():
@@ -107,14 +107,14 @@ class App:
                     else:
                         if command_entity['command'] == command:
                             return False
-        self.main_app_router.unknown_command_handler(command)
+        self._main_app_router.unknown_command_handler(command)
         self.print_func(self.line_separate)
         self.print_func(self.command_group_description_separate)
         return True
 
 
-    def print_command_group_description(self):
-        for router in self.registered_commands:
+    def _print_command_group_description(self):
+        for router in self._registered_commands:
             self.print_func(router['name'])
             for command_entity in router['commands']:
                 self.print_func(self._description_message_pattern.format(
@@ -130,16 +130,16 @@ class App:
             raise InvalidRouterInstanceException()
 
         if is_main:
-            if not self.main_app_router:
-                self.main_app_router = router
+            if not self._main_app_router:
+                self._main_app_router = router
                 router.set_router_as_main()
             else:
                 raise OnlyOneMainRouterIsAllowedException(router)
 
-        self.routers.append(router)
+        self._routers.append(router)
 
         registered_commands: list[dict[str, Callable[[], None] | str]] = router.get_registered_commands()
-        self.registered_commands.append({'name': router.get_name(),
+        self._registered_commands.append({'name': router.get_name(),
                                          'router': router,
                                          'commands': registered_commands})
 

argenta/router/entity.py

@@ -9,10 +9,10 @@ class Router:
                  name: str,
                  ignore_command_register: bool = False):
 
-        self.ignore_command_register: bool = ignore_command_register
-        self._name = name
+        self.ignore_command_register = ignore_command_register
+        self.name = name
 
-        self.processed_commands: list[dict[str, Callable[[], None] | str]] = []
+        self._processed_commands: list[dict[str, Callable[[], None] | str]] = []
         self.unknown_command_func: Callable[[str], None] | None = None
         self._is_main_router: bool = False
 
@@ -24,7 +24,7 @@ class Router:
             raise InvalidDescriptionInstanceException()
         else:
             def command_decorator(func):
-                self.processed_commands.append({'func': func,
+                self._processed_commands.append({'func': func,
                                                 'command': command,
                                                 'description': description})
                 def wrapper(*args, **kwargs):
@@ -37,7 +37,7 @@ class Router:
         if self.unknown_command_func is not None:
             raise UnknownCommandHandlerHasAlreadyBeenCreatedException()
 
-        self.unknown_command_func = func
+        self.unknown_command_func: Callable = func
 
         def wrapper(*args, **kwargs):
             return func(*args, **kwargs)
@@ -45,7 +45,7 @@ class Router:
 
 
     def input_command_handler(self, input_command):
-        for command_entity in self.processed_commands:
+        for command_entity in self._processed_commands:
             if input_command.lower() == command_entity['command'].lower():
                 if self.ignore_command_register:
                     return command_entity['func']()
@@ -53,6 +53,7 @@ class Router:
                     if input_command == command_entity['command']:
                         return command_entity['func']()
 
+
     def unknown_command_handler(self, unknown_command):
         self.unknown_command_func(unknown_command)
 
@@ -62,9 +63,9 @@ class Router:
 
 
     def get_registered_commands(self) -> list[dict[str, Callable[[], None] | str]]:
-        return self.processed_commands
+        return self._processed_commands
 
 
     def get_name(self) -> str:
-        return self._name
+        return self.name
 

{argenta-0.1.2.dist-info → argenta-0.1.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: argenta
-Version: 0.1.2
+Version: 0.1.3
 Summary: python library for creating cli apps
 License: MIT
 Author: kolo

{argenta-0.1.2.dist-info → argenta-0.1.3.dist-info}/RECORD

@@ -1,11 +1,11 @@
 argenta/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 argenta/app/__init__.py,sha256=WGPNy7LzkE6vjgRIITFYuJIB96vgDMFPRLOh4SV3R3E,443
-argenta/app/entity.py,sha256=IYUeVGIYQS5J8vQ4gUz3TfXIxOUpDpTMjdxMd30AODU,5869
+argenta/app/entity.py,sha256=TTkVvQ2TBRDGacMAbT0R9gUsr6UHYajVrZYnvAIObUU,6008
 argenta/app/exceptions.py,sha256=IW_o0hfAbsj4aeWifzT7tL3BL-6tBCqm0R9MwMXTIRE,1551
 argenta/router/__init__.py,sha256=gjneUFVbKVgwil8TbHRvCN89wT_U9CaakSbFmMC_fxk,227
-argenta/router/entity.py,sha256=G63P6vj4qxNI9PVw7Cdc9y9gFDlkdv7zA2ydaOcabHM,2541
+argenta/router/entity.py,sha256=_o3jT5RkD5XGDGOlN2LGnHQ3entopr8xVtlWuSBvayw,2549
 argenta/router/exceptions.py,sha256=iNZIM84oTdiowF-r4RRlfxkN4pjZuGlg8k3vouOZCT0,414
-argenta-0.1.2.dist-info/LICENSE,sha256=zmqoGh2n5rReBv4s8wPxF_gZEZDgauJYSPMuPczgOiU,1082
-argenta-0.1.2.dist-info/METADATA,sha256=Xkp04g7UmihvCL9-qizuEZva6wpews8aPrCycWBJ8jY,525
-argenta-0.1.2.dist-info/WHEEL,sha256=IYZQI976HJqqOpQU6PHkJ8fb3tMNBFjg-Cn-pwAbaFM,88
-argenta-0.1.2.dist-info/RECORD,,
+argenta-0.1.3.dist-info/LICENSE,sha256=zmqoGh2n5rReBv4s8wPxF_gZEZDgauJYSPMuPczgOiU,1082
+argenta-0.1.3.dist-info/METADATA,sha256=Ts3DIjwtLi7uyiFQ4j9nJ96EsGsIHCBFKpGM17sJtfk,525
+argenta-0.1.3.dist-info/WHEEL,sha256=IYZQI976HJqqOpQU6PHkJ8fb3tMNBFjg-Cn-pwAbaFM,88
+argenta-0.1.3.dist-info/RECORD,,