cli-ih 0.6.0.1__py3-none-any.whl → 0.6.0.2.1__py3-none-any.whl

cli_ih/Input_Handler.py

@@ -1,5 +1,5 @@
 from typing import Callable
-import logging
+import logging, warnings
 
 class HandlerClosed(Exception): ...
 class MissingParameter(Exception): ...
@@ -52,21 +52,25 @@ class InputHandler:
         else:
             print(f"[EXEPTION]: {msg}: {e}")
 
-    def register_command(self, name: str, func: Callable, description: str = ""):
-        """Registers a command with its associated function."""
+    def __register_cmd(self, name: str, func: Callable, description: str = ""):
         if not description:
             description = "A command"
         if ' ' in name:
             raise SyntaxError("Command name must not have spaces")
         self.commands[name] = {"cmd": func, "description": description}
 
+    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)
+        self.__register_cmd(name, func, description)
+
     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__
-            self.register_command(lname, func, description)
+            self.__register_cmd(lname, func, description)
             return func
         return decorator
 

{cli_ih-0.6.0.1.dist-info → cli_ih-0.6.0.2.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cli_ih
-Version: 0.6.0.1
+Version: 0.6.0.2.1
 Summary: A background command handler for python's command-line interface.
 Author-email: Hotment <michatchuplay@gmail.com>
 Requires-Python: >=3.8
@@ -33,7 +33,7 @@ def greet(args):
 
 handler = InputHandler(cursor="> ")
 # NEW
-@handler.command(name="add", description="Performs the `+` operator on the first 2 arguments.")
+@handler.command(name="add", description="Performs the `+` operator on the first 2 arguments.") # The name param will use the func name if its not provided
 def add(args):
     print(int(args[0])+int(args[1]))
 
@@ -59,7 +59,7 @@ handler.start()
 
 ## Additional Info
 
-- You can also import the `logging` module from `cli-ih` to use the same config as the module
+- You can provide a valid logger `logger=logger` to the `InputHandler` to enable logging (this will be removed soon)
 - You can provide the `thread_mode` param to the `InputHandler` class to set if it shoud run in a thread or no.
 (If you are using the `cli-ih` module on its own without any other background task set `thread_mode=False` to false)
 - You can also provide a `cursor` param to the `InputHandler` class to set the cli cursor (default cusor is empty)

cli_ih-0.6.0.2.1.dist-info/RECORD

@@ -0,0 +1,6 @@
+cli_ih/Input_Handler.py,sha256=INlPvqlHHzN2tEDj4WUtztd2VkZZjT9FloGNSdQKc1Y,6876
+cli_ih/__init__.py,sha256=X1CBDfeflUjcXik3rHCo-YLrIDe6EsH2ShnK57DDRYc,210
+cli_ih-0.6.0.2.1.dist-info/METADATA,sha256=sztmZuw7GXAIvi-VSPXlO8SbEch9fdok1LKScvyRvik,2241
+cli_ih-0.6.0.2.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+cli_ih-0.6.0.2.1.dist-info/top_level.txt,sha256=Ve1CRLNXhPyPSkpN0xLu26roh30LQCpNzkF61BZYfk0,7
+cli_ih-0.6.0.2.1.dist-info/RECORD,,

cli_ih-0.6.0.1.dist-info/RECORD

@@ -1,6 +0,0 @@
-cli_ih/Input_Handler.py,sha256=BvL8xAbLswSyUdTTHk-CBSxVFKfa7a5D5CC0Mwn_JEw,6578
-cli_ih/__init__.py,sha256=X1CBDfeflUjcXik3rHCo-YLrIDe6EsH2ShnK57DDRYc,210
-cli_ih-0.6.0.1.dist-info/METADATA,sha256=z-VPeMVnYZ9m6_rcgsKAX_FLsMrfBOd-QcFzwFlC8_I,2156
-cli_ih-0.6.0.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-cli_ih-0.6.0.1.dist-info/top_level.txt,sha256=Ve1CRLNXhPyPSkpN0xLu26roh30LQCpNzkF61BZYfk0,7
-cli_ih-0.6.0.1.dist-info/RECORD,,