argenta 1.0.0b1__py3-none-any.whl → 1.0.1__py3-none-any.whl

argenta/router/entity.py

@@ -1,38 +1,47 @@
 from typing import Callable, Literal, Type
-from inspect import getfullargspec, get_annotations
+from inspect import getfullargspec, get_annotations, getsourcefile, getsourcelines
 from rich.console import Console
 
 from argenta.command import Command
 from argenta.command.models import InputCommand
 from argenta.response import Response, Status
 from argenta.router.command_handler.entity import CommandHandlers, CommandHandler
-from argenta.command.flags.models import Flags, InputFlags, UndefinedInputFlags, ValidInputFlags, InvalidValueInputFlags
-from argenta.router.exceptions import (RepeatedFlagNameException,
-                                       TooManyTransferredArgsException,
-                                       RequiredArgumentNotPassedException,
-                                       TriggerContainSpacesException)
+from argenta.command.flags.models import (
+    Flags,
+    InputFlags,
+    UndefinedInputFlags,
+    ValidInputFlags,
+    InvalidValueInputFlags,
+)
+from argenta.router.exceptions import (
+    RepeatedFlagNameException,
+    TooManyTransferredArgsException,
+    RequiredArgumentNotPassedException,
+    TriggerContainSpacesException,
+)
 
 
 class Router:
-    def __init__(self, title: str = None):
+    def __init__(self, title: str | None = "Awesome title"):
         """
         Public. Directly configures and manages handlers
         :param title: the title of the router, displayed when displaying the available commands
         :return: None
         """
-        self._title = title
+        self.title = title
 
         self._command_handlers: CommandHandlers = CommandHandlers()
         self._ignore_command_register: bool = False
 
-
-    def command(self, command: Command) -> Callable:
+    def command(self, command: Command | str) -> Callable:
         """
         Public. Registers handler
         :param command: Registered command
         :return: decorated handler as Callable
         """
         self._validate_command(command)
+        if isinstance(command, str):
+            command = Command(command)
 
         def command_decorator(func):
             Router._validate_func_args(func)
@@ -40,11 +49,11 @@ class Router:
 
             def wrapper(*args, **kwargs):
                 return func(*args, **kwargs)
+
             return wrapper
 
         return command_decorator
 
-
     def finds_appropriate_handler(self, input_command: InputCommand) -> None:
         """
         Private. Finds the appropriate handler for given input command and passes control to it
@@ -61,8 +70,9 @@ class Router:
             if input_command_name.lower() in handle_command.get_aliases():
                 self.process_input_command(input_command_flags, command_handler)
 
-
-    def process_input_command(self, input_command_flags: InputFlags, command_handler: CommandHandler) -> None:
+    def process_input_command(
+        self, input_command_flags: InputFlags, command_handler: CommandHandler
+    ) -> None:
         """
         Private. Processes input command with the appropriate handler
         :param input_command_flags: input command flags as InputFlags
@@ -73,9 +83,9 @@ class Router:
         response: Response = Response()
         if handle_command.get_registered_flags().get_flags():
             if input_command_flags.get_flags():
-                flags, status = self._validate_input_flags(handle_command, input_command_flags)
-                response.valid_flags, response.undefined_flags, response.invalid_value_flags = flags
-                response.status = status
+                response: Response = self._structuring_input_flags(
+                    handle_command, input_command_flags
+                )
                 command_handler.handling(response)
             else:
                 response.status = Status.ALL_FLAGS_VALID
@@ -90,60 +100,76 @@ class Router:
                 response.status = Status.ALL_FLAGS_VALID
                 command_handler.handling(response)
 
-
     @staticmethod
-    def _validate_input_flags(handled_command: Command, input_flags: InputFlags) -> tuple[tuple[ValidInputFlags,
-                                                                                                UndefinedInputFlags,
-                                                                                                InvalidValueInputFlags],
-                                                                                          Status]:
+    def _structuring_input_flags(
+        handled_command: Command, input_flags: InputFlags
+    ) -> Response:
         """
         Private. Validates flags of input command
         :param handled_command: entity of the handled command
         :param input_flags:
-        :return: is flags of input command valid as bool
+        :return: entity of response as Response
         """
         valid_input_flags: ValidInputFlags = ValidInputFlags()
         invalid_value_input_flags: InvalidValueInputFlags = InvalidValueInputFlags()
         undefined_input_flags: UndefinedInputFlags = UndefinedInputFlags()
         for flag in input_flags:
-            flag_status: Literal['Undefined', 'Valid', 'Invalid'] = handled_command.validate_input_flag(flag)
+            flag_status: Literal["Undefined", "Valid", "Invalid"] = (
+                handled_command.validate_input_flag(flag)
+            )
             match flag_status:
-                case 'Valid':
+                case "Valid":
                     valid_input_flags.add_flag(flag)
-                case 'Undefined':
+                case "Undefined":
                     undefined_input_flags.add_flag(flag)
-                case 'Invalid':
+                case "Invalid":
                     invalid_value_input_flags.add_flag(flag)
 
-        if not invalid_value_input_flags.get_flags() and not undefined_input_flags.get_flags():
+        if (
+            not invalid_value_input_flags.get_flags()
+            and not undefined_input_flags.get_flags()
+        ):
             status = Status.ALL_FLAGS_VALID
-        elif invalid_value_input_flags.get_flags() and not undefined_input_flags.get_flags():
+        elif (
+            invalid_value_input_flags.get_flags()
+            and not undefined_input_flags.get_flags()
+        ):
             status = Status.INVALID_VALUE_FLAGS
-        elif not invalid_value_input_flags.get_flags() and undefined_input_flags.get_flags():
+        elif (
+            not invalid_value_input_flags.get_flags()
+            and undefined_input_flags.get_flags()
+        ):
             status = Status.UNDEFINED_FLAGS
         else:
             status = Status.UNDEFINED_AND_INVALID_FLAGS
 
-        return (valid_input_flags, undefined_input_flags, invalid_value_input_flags), status
-
+        return Response(
+            invalid_value_flags=invalid_value_input_flags,
+            valid_flags=valid_input_flags,
+            status=status,
+            undefined_flags=undefined_input_flags,
+        )
 
     @staticmethod
-    def _validate_command(command: Command) -> None:
+    def _validate_command(command: Command | str) -> None:
         """
         Private. Validates the command registered in handler
         :param command: validated command
         :return: None if command is valid else raise exception
         """
-        command_name: str = command.get_trigger()
-        if command_name.find(' ') != -1:
-            raise TriggerContainSpacesException()
-
-        flags: Flags = command.get_registered_flags()
-        if flags:
-            flags_name: list = [x.get_string_entity().lower() for x in flags]
-            if len(set(flags_name)) < len(flags_name):
-                raise RepeatedFlagNameException()
-
+        match type(command).__name__:
+            case "Command":
+                command_name: str = command.get_trigger()
+                if command_name.find(" ") != -1:
+                    raise TriggerContainSpacesException()
+                flags: Flags = command.get_registered_flags()
+                if flags:
+                    flags_name: list = [x.get_string_entity().lower() for x in flags]
+                    if len(set(flags_name)) < len(flags_name):
+                        raise RepeatedFlagNameException()
+            case "str":
+                if command.find(" ") != -1:
+                    raise TriggerContainSpacesException()
 
     @staticmethod
     def _validate_func_args(func: Callable) -> None:
@@ -158,12 +184,22 @@ class Router:
         elif len(transferred_args) == 0:
             raise RequiredArgumentNotPassedException()
 
-        arg_annotation: Type = get_annotations(func)[transferred_args[0]]
-        if not arg_annotation is Response:
-            Console().print(f'\n\n[b red]WARNING:[/b red] [i]The type of argument passed to the handler is [/i][blue]{Response}[/blue],'
-                            f' [i]but[/i] [bold blue]{arg_annotation}[/bold blue] [i]is specified[/i]', highlight=False)
-
+        transferred_arg: str = transferred_args[0]
+        func_annotations: dict[str, Type] = get_annotations(func)
 
+        if arg_annotation := func_annotations.get(transferred_arg):
+            if arg_annotation is Response:
+                pass
+            else:
+                file_path: str = getsourcefile(func)
+                source_line: int = getsourcelines(func)[1] + 1
+                fprint = Console().print
+                fprint(
+                    f'\nFile "{file_path}", line {source_line}\n[b red]WARNING:[/b red] [i]The typehint '
+                    f"of argument([green]{transferred_arg}[/green]) passed to the handler is [/i][bold blue]{Response}[/bold blue],"
+                    f" [i]but[/i] [bold blue]{arg_annotation}[/bold blue] [i]is specified[/i]\n",
+                    highlight=False,
+                )
 
     def set_command_register_ignore(self, _: bool) -> None:
         """
@@ -173,7 +209,6 @@ class Router:
         """
         self._ignore_command_register = _
 
-
     def get_triggers(self) -> list[str]:
         """
         Public. Gets registered triggers
@@ -184,7 +219,6 @@ class Router:
             all_triggers.append(command_handler.get_handled_command().get_trigger())
         return all_triggers
 
-
     def get_aliases(self) -> list[str]:
         """
         Public. Gets registered aliases
@@ -196,27 +230,9 @@ class Router:
                 all_aliases.extend(command_handler.get_handled_command().get_aliases())
         return all_aliases
 
-
     def get_command_handlers(self) -> CommandHandlers:
         """
         Private. Gets registered command handlers
         :return: registered command handlers as CommandHandlers
         """
         return self._command_handlers
-
-
-    def get_title(self) -> str | None:
-        """
-        Public. Gets title of the router
-        :return: the title of the router as str or None
-        """
-        return self._title
-
-
-    def set_title(self, title: str) -> None:
-        """
-        Public. Sets the title of the router
-        :param title: title that will be setted
-        :return: None
-        """
-        self._title = title

argenta/router/exceptions.py

@@ -2,6 +2,7 @@ class RepeatedFlagNameException(Exception):
     """
     Private. Raised when a repeated flag name is registered
     """
+
     def __str__(self):
         return "Repeated registered flag names in register command"
 
@@ -10,6 +11,7 @@ class TooManyTransferredArgsException(Exception):
     """
     Private. Raised when too many arguments are passed
     """
+
     def __str__(self):
         return "Too many transferred arguments"
 
@@ -18,6 +20,7 @@ class RequiredArgumentNotPassedException(Exception):
     """
     Private. Raised when a required argument is not passed
     """
+
     def __str__(self):
         return "Required argument not passed"
 
@@ -26,5 +29,6 @@ class TriggerContainSpacesException(Exception):
     """
     Private. Raised when there is a space in the trigger being registered
     """
+
     def __str__(self):
         return "Command trigger cannot contain spaces"

argenta-1.0.1.dist-info/METADATA

@@ -0,0 +1,71 @@
+Metadata-Version: 2.4
+Name: argenta
+Version: 1.0.1
+Summary: Python library for building modular CLI applications
+Author-email: kolo <kolo.is.main@gmail.com>
+License: MIT
+License-File: LICENSE
+Requires-Python: <4.0,>=3.11
+Requires-Dist: art<7.0,>=6.4
+Requires-Dist: pyreadline3>=3.5.4
+Requires-Dist: rich<15.0.0,>=14.0.0
+Description-Content-Type: text/markdown
+
+# Argenta
+
+### Библиотека для создания модульных CLI приложeний
+
+![preview](https://github.com/koloideal/Argenta/blob/kolo/imgs/mock_app_preview4.png?raw=True)  
+
+---
+
+# Установка
+```bash
+pip install argenta
+```
+or
+```bash
+poetry add argenta
+```
+
+---
+
+# Быстрый старт
+
+Пример простейшего приложения
+```python
+# routers.py
+from argenta.router import Router
+from argenta.command import Command
+from argenta.response import Response
+
+
+router = Router()
+
+@router.command(Command("hello"))
+def handler(response: Response):
+    print("Hello, world!")
+```
+
+```python
+# main.py
+from argenta.app import App
+from argenta.orchestrator import Orchestrator
+from routers import router
+
+app: App = App()
+orchestrator: Orchestrator = Orchestrator()
+
+
+def main() -> None:
+    app.include_router(router)
+    orchestrator.start_polling(app)
+
+
+if __name__ == '__main__':
+    main()
+```
+## Полная [документация](https://argenta-docs.vercel.app) | MIT 2025 kolo | made by [kolo](https://t.me/kolo_id)
+
+
+

argenta-1.0.1.dist-info/RECORD

@@ -0,0 +1,37 @@
+argenta/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+argenta/app/__init__.py,sha256=I8FTXU17ajDI-hbC6Rw0LxLmvDYipdQaos3v1pmu14E,57
+argenta/app/defaults.py,sha256=z65HUXd1ogTk95-IWwluPDPz4MkZk1_3jfaSjdTZ4ME,393
+argenta/app/models.py,sha256=yG3IhR9IrEd2YwrtqoZni6wht2rDOyocfoe5SmPv6cw,19153
+argenta/app/autocompleter/__init__.py,sha256=VT_p3QA78UnczV7pYR2NnwQ0Atd8mnDUnLazvUQNqJk,93
+argenta/app/autocompleter/entity.py,sha256=QgEZ2Tzfp9liWBCd-BdRpUE-ELUOxAhPpW7KBLVcPRE,3556
+argenta/app/dividing_line/__init__.py,sha256=jJZDDZix8XYCAUWW4FzGJH0JmJlchYcx0FPWifjgv1I,147
+argenta/app/dividing_line/models.py,sha256=syBTrzcIIt6E6RiaKC9QH3kdAuWLBDNIX0cH7Bnn0mk,2265
+argenta/app/registered_routers/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+argenta/app/registered_routers/entity.py,sha256=OH7plYfjQrlyVliXE6OLVD2ftOAd5U1VO6SlyvLNikk,1078
+argenta/command/__init__.py,sha256=RvacrM84ZwBdVDy4MUwjLTyzQdDQrjjoikZxwh5ov-0,69
+argenta/command/exceptions.py,sha256=86Gs_9-NutmbSkduEMljtxQHWHhDRFcqyyOKDhQ440o,1060
+argenta/command/models.py,sha256=9zzOEJt-jn1ke9HcQGnTOIvNZYrXn347rDzVzm2Ve5Y,7180
+argenta/command/flag/__init__.py,sha256=4MOxfv8f2SkBzIfVo5LAZUTu4iH1jcs5WzPq60PhFMs,94
+argenta/command/flag/defaults.py,sha256=1F9bEngv6tB_yn5lLQg5pxWZSuinryfGGdXnWD7EvuY,1035
+argenta/command/flag/models.py,sha256=KAzyoNWVOVLiIT4f8auI15D0TCHosGXHGw_xXRuEtgY,3875
+argenta/command/flags/__init__.py,sha256=XFi7_xYjpjnet7FGO93PTcUexeTQ9QwFHuUg_19Ferk,289
+argenta/command/flags/models.py,sha256=U4nOwCqsCOURGigTKiQx07zBUKj0EoY0fCwgTNq4GIg,2332
+argenta/orchestrator/__init__.py,sha256=vFtJEJTjFfoYP3DZx0gNlhoa0Tk8u-yzkGIUN3SiABA,86
+argenta/orchestrator/entity.py,sha256=kgTHGrbWdsTDR7aAKv2Bvm8pO7LKFv7v8Dv1LDsdrTo,1093
+argenta/orchestrator/argparser/__init__.py,sha256=akbTPC5CfNrgJTVVu1A2E9KeI8KPN4JnMM8M8U21jc8,90
+argenta/orchestrator/argparser/entity.py,sha256=i3lCsCr_8JT09OosvxRuRD7KKP1MgeNFYz5kTTTqu9Q,2087
+argenta/orchestrator/argparser/arguments/__init__.py,sha256=lRsKyJeiibPYhFZoeB3BRfIYM4mlUFp6nZpy9RdbgYg,213
+argenta/orchestrator/argparser/arguments/models.py,sha256=wF4rIaEAx9Rt-c6rAeq6kZLfNPTn4v9WBNt9JHzJ0RA,1548
+argenta/response/__init__.py,sha256=u4NuwUQkWa55aX67hTQs_B_gIaZ9Dn4Fe7xhSFQ_Rpw,128
+argenta/response/entity.py,sha256=YcuKLnr7iiFewNqUH7bsdv-PccHfpitq-sm06tmSCjE,1042
+argenta/response/status.py,sha256=bWFMHvyIHpOA4LxUQFoSpld-F8gu183M9nY-zN-MiZM,244
+argenta/router/__init__.py,sha256=rvqAx80IXHFdVw7cWBRGaTtb94a4OQQEsMJ5f7YA1gU,68
+argenta/router/defaults.py,sha256=vvkwFYCQdwjtMntfyrJuisxFX8XxeyhDMA-RwteHZGg,87
+argenta/router/entity.py,sha256=Z3QZpntlZgt2bkJCb3zUsQ1_a05c61iN59-PBG0r7wg,9656
+argenta/router/exceptions.py,sha256=5k0mTHYYItWHzGC0NU5oHHYrHxU0M5fEbO5wne_wFg8,860
+argenta/router/command_handler/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+argenta/router/command_handler/entity.py,sha256=xmHgbXBvD_-JMLpUPc5w3VVe-upTJ-y4lR13rUiiygo,2387
+argenta-1.0.1.dist-info/METADATA,sha256=IH4CZ1jn49gksobDBswJMcdMqDj7CtGY9-QzeWF2BKY,1448
+argenta-1.0.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+argenta-1.0.1.dist-info/licenses/LICENSE,sha256=zmqoGh2n5rReBv4s8wPxF_gZEZDgauJYSPMuPczgOiU,1082
+argenta-1.0.1.dist-info/RECORD,,