argenta 0.1.0__py3-none-any.whl

argenta/__init__.py

@@ -0,0 +1,2 @@
+from .router import *
+from .app import *

argenta/app/entity.py

@@ -0,0 +1,145 @@
+from typing import Callable
+from ..router.entity import Router
+from .exceptions import (InvalidRouterInstanceException,
+                         InvalidDescriptionMessagePatternException,
+                         OnlyOneMainRouterIsAllowedException,
+                         MissingMainRouterException,
+                         MissingHandlersForUnknownCommandsOnMainRouterException,
+                         HandlerForUnknownCommandsCanOnlyBeDeclaredForMainRouterException)
+
+
+class App:
+    def __init__(self,
+                 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',
+                 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.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}'
+
+
+    def start_polling(self) -> None:
+        self.print_func(self.initial_greeting)
+        self.validate_main_router()
+
+        while True:
+            self.print_command_group_description()
+            self.print_func(self.prompt)
+
+            command: str = input()
+
+            self.checking_command_for_exit_command(command)
+            self.print_func(self.line_separate)
+
+            is_unknown_command: bool = self.check_is_command_unknown(command)
+
+            if is_unknown_command:
+                continue
+
+            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
+
+
+    def set_goodbye_message(self, message: str) -> None:
+        self.goodbye_message = message
+
+
+    def set_description_message_pattern(self, pattern: str) -> None:
+        try:
+            pattern.format(command='command',
+                           description='description')
+        except KeyError:
+            raise InvalidDescriptionMessagePatternException(pattern)
+        self._description_message_pattern = pattern
+
+
+    def validate_main_router(self):
+        if not self.main_app_router:
+            raise MissingMainRouterException()
+
+        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:
+                raise HandlerForUnknownCommandsCanOnlyBeDeclaredForMainRouterException()
+
+
+    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)
+                exit(0)
+            else:
+                if command == self.exit_command:
+                    self.print_func(self.goodbye_message)
+                    exit(0)
+
+
+    def check_is_command_unknown(self, command: str):
+        registered_commands = self.registered_commands
+        for router in registered_commands:
+            for command_entity in router['commands']:
+                if command_entity['command'].lower() == command.lower():
+                    if router['router'].ignore_command_register:
+                        return False
+                    else:
+                        if command_entity['command'] == command:
+                            return False
+        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:
+            self.print_func(router['name'])
+            for command_entity in router['commands']:
+                self.print_func(self._description_message_pattern.format(
+                        command=command_entity['command'],
+                        description=command_entity['description']
+                    )
+                )
+            self.print_func(self.command_group_description_separate)
+
+
+    def include_router(self, router: Router, is_main: bool = False) -> None:
+        if not isinstance(router, Router):
+            raise InvalidRouterInstanceException()
+
+        if is_main:
+            if not self.main_app_router:
+                self.main_app_router = router
+                router.set_router_as_main()
+            else:
+                raise OnlyOneMainRouterIsAllowedException(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(),
+                                         'router': router,
+                                         'commands': registered_commands})
+

argenta/app/exceptions.py

@@ -0,0 +1,39 @@
+class InvalidRouterInstanceException(Exception):
+    def __str__(self):
+        return "Invalid Router Instance"
+
+
+class InvalidDescriptionMessagePatternException(Exception):
+    def __init__(self, pattern: str):
+        self.pattern = pattern
+    def __str__(self):
+        return ("Invalid Description Message Pattern\n"
+                "Correct pattern example: [{command}] *=*=* {description}\n"
+                "The pattern must contain two variables: `command` and `description` - description of the command\n"
+                f"Your pattern: {self.pattern}")
+
+
+class OnlyOneMainRouterIsAllowedException(Exception):
+    def __init__(self, existing_main_router):
+        self.existing_main_router = existing_main_router
+
+    def __str__(self):
+        return ("Only One Main Router Allowed\n"
+                f"Existing main router is: {self.existing_main_router}")
+
+
+class MissingMainRouterException(Exception):
+    def __str__(self):
+        return ("Missing Main Router\n"
+                "One of the registered routers must be the main one")
+
+
+class MissingHandlersForUnknownCommandsOnMainRouterException(Exception):
+    def __str__(self):
+        return ("Missing Handlers For Unknown Commands On The Main Router\n"
+                "The main router must have a declared handler for unknown commands")
+
+
+class HandlerForUnknownCommandsCanOnlyBeDeclaredForMainRouterException(Exception):
+    def __str__(self):
+        return '\nThe handler for unknown commands can only be declared for the main router'

argenta/router/entity.py

@@ -0,0 +1,70 @@
+from typing import Callable, Any
+from src.core.router.exceptions import (InvalidCommandInstanceException,
+                                        UnknownCommandHandlerHasAlreadyBeenCreatedException,
+                                        InvalidDescriptionInstanceException)
+
+
+class Router:
+    def __init__(self,
+                 name: str,
+                 ignore_command_register: bool = False):
+
+        self.ignore_command_register: bool = ignore_command_register
+        self._name = name
+
+        self.processed_commands: list[dict[str, Callable[[], None] | str]] = []
+        self.unknown_command_func: Callable[[str], None] | None = None
+        self._is_main_router: bool = False
+
+
+    def command(self, command: str, description: str) -> Callable[[Any], Any]:
+        if not isinstance(command, str):
+            raise InvalidCommandInstanceException()
+        if not isinstance(description, str):
+            raise InvalidDescriptionInstanceException()
+        else:
+            def command_decorator(func):
+                self.processed_commands.append({'func': func,
+                                                'command': command,
+                                                'description': description})
+                def wrapper(*args, **kwargs):
+                    return func(*args, **kwargs)
+                return wrapper
+            return command_decorator
+
+
+    def unknown_command(self, func):
+        if self.unknown_command_func is not None:
+            raise UnknownCommandHandlerHasAlreadyBeenCreatedException()
+
+        self.unknown_command_func = func
+
+        def wrapper(*args, **kwargs):
+            return func(*args, **kwargs)
+        return wrapper
+
+
+    def input_command_handler(self, input_command):
+        for command_entity in self.processed_commands:
+            if input_command.lower() == command_entity['command'].lower():
+                if self.ignore_command_register:
+                    return command_entity['func']()
+                else:
+                    if input_command == command_entity['command']:
+                        return command_entity['func']()
+
+    def unknown_command_handler(self, unknown_command):
+        self.unknown_command_func(unknown_command)
+
+
+    def set_router_as_main(self):
+        self._is_main_router = True
+
+
+    def get_registered_commands(self) -> list[dict[str, Callable[[], None] | str]]:
+        return self.processed_commands
+
+
+    def get_name(self) -> str:
+        return self._name
+

argenta/router/exceptions.py

@@ -0,0 +1,13 @@
+class InvalidCommandInstanceException(Exception):
+    def __str__(self):
+        return "Invalid Command Instance"
+
+
+class InvalidDescriptionInstanceException(Exception):
+    def __str__(self):
+        return "Invalid Description Instance"
+
+
+class UnknownCommandHandlerHasAlreadyBeenCreatedException(Exception):
+    def __str__(self):
+        return "Only one unknown command handler can be declared"

argenta-0.1.0.dist-info/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 kolo
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

argenta-0.1.0.dist-info/METADATA

@@ -0,0 +1,18 @@
+Metadata-Version: 2.3
+Name: argenta
+Version: 0.1.0
+Summary: python library for creating cli apps
+License: MIT
+Author: kolo
+Author-email: kolo.is.main@gmail.com
+Requires-Python: >=3.11
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Description-Content-Type: text/markdown
+
+# Argenta
+python library for creating cli apps
+

argenta-0.1.0.dist-info/RECORD

@@ -0,0 +1,11 @@
+argenta/__init__.py,sha256=FebXtkVKUBK3d0JGA3Lov1mpjcOjDeT-vmcV93iaoYg,41
+argenta/app/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+argenta/app/entity.py,sha256=IYUeVGIYQS5J8vQ4gUz3TfXIxOUpDpTMjdxMd30AODU,5869
+argenta/app/exceptions.py,sha256=IW_o0hfAbsj4aeWifzT7tL3BL-6tBCqm0R9MwMXTIRE,1551
+argenta/router/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+argenta/router/entity.py,sha256=t3bkIW0pJPov6lQim388y0DdrekYWRE6VtXj4RQrtyk,2562
+argenta/router/exceptions.py,sha256=iNZIM84oTdiowF-r4RRlfxkN4pjZuGlg8k3vouOZCT0,414
+argenta-0.1.0.dist-info/LICENSE,sha256=zmqoGh2n5rReBv4s8wPxF_gZEZDgauJYSPMuPczgOiU,1082
+argenta-0.1.0.dist-info/METADATA,sha256=hu5dbaIOJV6Krp9AYQ4jFnpGeAdxxk1R5K_jPfI6N_8,525
+argenta-0.1.0.dist-info/WHEEL,sha256=IYZQI976HJqqOpQU6PHkJ8fb3tMNBFjg-Cn-pwAbaFM,88
+argenta-0.1.0.dist-info/RECORD,,

argenta-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: poetry-core 2.0.1
+Root-Is-Purelib: true
+Tag: py3-none-any