cli-ih 0.6.1.2__tar.gz → 0.6.2__tar.gz

{cli_ih-0.6.1.2 → cli_ih-0.6.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cli_ih
-Version: 0.6.1.2
+Version: 0.6.2
 Summary: A background command handler for python's command-line interface.
 Author-email: Hotment <michatchuplay@gmail.com>
 Requires-Python: >=3.8

{cli_ih-0.6.1.2 → cli_ih-0.6.2}/cli_ih/__init__.py

@@ -1,4 +1,5 @@
-from .Input_Handler import InputHandler
+from .client import InputHandler
+from .asyncClient import AsyncInputHandler
 import importlib.metadata
 
 try:

cli_ih-0.6.2/cli_ih/asyncClient.py

@@ -0,0 +1,169 @@
+from typing import Callable
+from .exceptions import HandlerClosed
+import logging, warnings, asyncio, inspect
+
+class AsyncInputHandler:
+    def __init__(self, cursor = "", *, logger: logging.Logger | None = None, register_defaults: bool = True):
+        self.commands = {}
+        self.is_running = False
+        self.cursor = f"{cursor.strip()} "
+        self.global_logger = logger if logger else None
+        self.logger = logger.getChild("InputHandler") if logger else None
+        self.register_defaults = register_defaults
+        if self.register_defaults:
+            self.register_default_commands()
+        else:
+            self.__warning("The default commands are disabled in the current instance.")
+
+    def get_logger(self):
+        return self.logger
+    
+    def __debug(self, msg: str):
+        if self.logger:
+            self.logger.debug(msg)
+        else:
+            print(f"[DEBUG]: {msg}")
+    
+    def __info(self, msg: str):
+        if self.logger:
+            self.logger.info(msg)
+        else:
+            print(f"[INFO]: {msg}")
+
+    def __warning(self, msg: str):
+        if self.logger:
+            self.logger.warning(msg)
+        else:
+            print(f"[WARNING]: {msg}")
+
+    def __error(self, msg: str):
+        if self.logger:
+            self.logger.error(msg)
+        else:
+            print(f"[ERROR]: {msg}")
+    
+    def __exeption(self, msg: str, e: Exception):
+        if self.logger:
+            self.logger.exception(f"{msg}: {e}")
+        else:
+            print(f"[EXEPTION]: {msg}: {e}")
+
+    def __register_cmd(self, name: str, func: Callable, description: str = "", legacy=False):
+        name = name.lower()
+        if not description:
+            description = "A command"
+        if ' ' in name:
+            raise SyntaxError("Command name must not have spaces")
+        if name in self.commands:
+            raise SyntaxError(f"Command '{name}' is already registered. If theese commands have a different case and they need to stay the same, downgrade the package version to 0.5.x")
+        self.commands[name] = {"cmd": func, "description": description, "legacy": legacy, "is_async": inspect.iscoroutinefunction(func)}
+
+    def register_command(self, name: str, func: Callable, description: str = ""):
+        """(DEPRECATED) Registers a command with its associated function."""
+        warnings.warn("Registering commands with `register_command` is deprecated, and should not be used.", DeprecationWarning, 2)
+        self.__register_cmd(name, func, description, legacy=True)
+
+    def command(self, *, name: str = "", description: str = ""):
+        """Registers a command with its associated function as a decorator."""
+        def decorator(func: Callable):
+            lname = name or func.__name__
+            self.__register_cmd(lname, func, description)
+            return func
+        return decorator
+
+    async def start(self):
+        """Starts the input handler loop in a separate thread if thread mode is enabled."""
+        self.is_running = True
+
+        while self.is_running:
+            try:
+                user_input = await asyncio.to_thread(input, self.cursor)
+                if not user_input:
+                    continue
+
+                cmdargs = user_input.split(' ')
+                command_name = cmdargs[0].lower()
+                args = cmdargs[1:]
+                if command_name in self.commands:
+                    await _run_command(self.commands, command_name, args)
+                else:
+                    self.__warning(f"Unknown command: '{command_name}'")
+            except EOFError:
+                self.__error("Input ended unexpectedly.")
+                break
+            except KeyboardInterrupt:
+                self.__error("Input interrupted.")
+                break
+            except HandlerClosed:
+                self.__info("Input Handler exited.")
+                break
+        self.is_running = False
+
+        async def _run_command(commands: dict, name: str, args: list):
+            """Executes a command from the command dictionary if it exists."""
+            command = commands.get(name)
+            if not command:
+                self.__warning(f"Command '{name}' not found.")
+
+            func = command.get("cmd")
+            is_legacy = command.get("legacy", False)
+            is_async = command.get("is_async", False)
+
+            if not callable(func):
+                raise ValueError(f"The command '{name}' is not callable.")
+
+            try:
+                sig = inspect.signature(func)
+                if is_legacy:
+                    sig.bind(args)
+                else:
+                    sig.bind(*args)
+            except TypeError as e:
+                self.__warning(f"Argument error for legacy command '{name}': {e}")
+                return
+
+            try:
+                if is_legacy:
+                    warnings.warn("This way of running commands id Deprecated. And should be changed to the new decorator way.", DeprecationWarning, 2)
+                    await asyncio.to_thread(func, args)
+                elif is_async:
+                    await func(*args)
+                else:
+                    await asyncio.to_thread(func, *args)
+
+            except HandlerClosed as e:
+                raise e
+            except Exception as e:
+                self.__exeption(f"An error occurred in command '{name}'", e)
+
+    def register_default_commands(self):
+        @self.command(name="help", description="Displays all the available commands")
+        def help():
+            str_out = "Available commands:\n"
+            for command, data in self.commands.items():
+                str_out += f"  {command}: {data['description']}\n"
+            print(str_out)
+
+        @self.command(name="debug", description="If a logger is present changes the logging level to DEBUG.")
+        def debug_mode():
+            logger = self.global_logger
+            if not logger:
+                return self.__warning("No logger defined for this InputHandler instance.")
+
+            if logger.getEffectiveLevel() == logging.DEBUG:
+                new_level = logging.INFO
+                message = "Debug mode is now off"
+            else: 
+                new_level = logging.DEBUG
+                message = "Debug mode is now on"
+
+            logger.setLevel(new_level)
+
+            for handler in logger.handlers:
+                if isinstance(handler, logging.StreamHandler):
+                    handler.setLevel(new_level)
+            self.__info(message)
+
+        @self.command(name="exit", description="Exits the Input Handler irreversibly.")
+        def exit_thread():
+            raise HandlerClosed("Handler was closed with exit command.")

cli_ih-0.6.1.2/cli_ih/Input_Handler.py → cli_ih-0.6.2/cli_ih/client.py

@@ -1,9 +1,7 @@
 from typing import Callable
+from .exceptions import HandlerClosed
 import logging, warnings
 
-class HandlerClosed(Exception): ...
-class MissingParameter(Exception): ...
-
 class InputHandler:
     def __init__(self, thread_mode = True, cursor = "", *, logger: logging.Logger | None = None, register_defaults: bool = True):
         self.commands = {}
@@ -63,16 +61,14 @@ class InputHandler:
         self.commands[name] = {"cmd": func, "description": description, "legacy": legacy}
 
     def register_command(self, name: str, func: Callable, description: str = ""):
-        """Registers a command with its associated function."""
-        warnings.warn("Registering commands with `register_command` is deprecated, and will be removed in the next big update.", DeprecationWarning, 2)
+        """(DEPRECATED) Registers a command with its associated function."""
+        warnings.warn("Registering commands with `register_command` is deprecated, and should not be used.", DeprecationWarning, 2)
         self.__register_cmd(name, func, description, legacy=True)
 
     def command(self, *, name: str = "", description: str = ""):
         """Registers a command with its associated function as a decorator."""
         def decorator(func: Callable):
-            lname = name
-            if not lname:
-                lname = func.__name__
+            lname = name or func.__name__
             self.__register_cmd(lname, func, description)
             return func
         return decorator
@@ -132,7 +128,7 @@ class InputHandler:
                         continue
 
                     cmdargs = user_input.split(' ')
-                    command_name = cmdargs[0]
+                    command_name = cmdargs[0].lower()
                     args = cmdargs[1:]
                     if command_name in self.commands:
                         _run_command(self.commands, command_name, args)

cli_ih-0.6.2/cli_ih/exceptions.py

@@ -0,0 +1,4 @@
+class HandlerException(Exception): ... # Base handler exception
+
+class HandlerClosed(HandlerException): ...
+class MissingParameter(HandlerException): ...

{cli_ih-0.6.1.2 → cli_ih-0.6.2}/cli_ih.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cli_ih
-Version: 0.6.1.2
+Version: 0.6.2
 Summary: A background command handler for python's command-line interface.
 Author-email: Hotment <michatchuplay@gmail.com>
 Requires-Python: >=3.8

{cli_ih-0.6.1.2 → cli_ih-0.6.2}/cli_ih.egg-info/SOURCES.txt

@@ -1,7 +1,9 @@
 README.md
 pyproject.toml
-cli_ih/Input_Handler.py
 cli_ih/__init__.py
+cli_ih/asyncClient.py
+cli_ih/client.py
+cli_ih/exceptions.py
 cli_ih.egg-info/PKG-INFO
 cli_ih.egg-info/SOURCES.txt
 cli_ih.egg-info/dependency_links.txt

{cli_ih-0.6.1.2 → cli_ih-0.6.2}/cli_ih.egg-info/top_level.txt

@@ -1,3 +1,2 @@
-build
 cli_ih
 dist

{cli_ih-0.6.1.2 → cli_ih-0.6.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "cli_ih"
-version = "0.6.1.2"
+version = "0.6.2"
 description = "A background command handler for python's command-line interface."
 readme = "README.md"
 requires-python = ">= 3.8"