Merge pull request #35 from mittel-labs/feat/enhancing-commands

Enhancing commands

Author: fmamud

src/bibleit/command/__init__.py

@@ -31,16 +31,19 @@ def eval_module(name):
         return eval_module(_default_module)
 
 
-def eval(ctx, *line, module=None):
+def eval(ctx, *line, module=None):  # noqa: C901
     """Evaluate a function with arbitrary arguments."""
     if module is None:
         module = _default_module
     try:
         name, *args = line
 
-        if name.startswith("!"):
-            args.insert(0, name[1:])
-            name = "set"
+        if any(name.startswith(alias) for alias in core._ALIASES):
+            alias = name.strip()[0]
+            name = "".join(filter(None, map(str.strip, name.split(alias))))
+            if target := core._ALIASES.get(alias):
+                args.insert(0, name)
+                name = target
 
         ctx.module = eval_module(module)
         ctx.methods = eval_methods(ctx.module)

src/bibleit/command/core.py

@@ -9,6 +9,22 @@
 
 from operator import attrgetter as _attrgetter
 
+_ALIASES = {
+    "!": "set",
+    "@": "ref",
+    "?": "help",
+    "&": "search",
+    "%": "count",
+    "-": "note",
+    "\\": "notes",
+}
+
+
+def _format_alias(name):
+    if alias := next((alias for alias, cmd in _ALIASES.items() if cmd == name), None):
+        return f"(alias: '{alias}')"
+    return ""
+
 
 def _format_lines(lines):
     linesep = "\n" * (_config.linesep + 1)
@@ -29,8 +45,13 @@ def _ref_parse(ctx, bible_fn, target, term):
     return result if result else f"{term} '{' '.join(target)}' not found"
 
 
+def _doc(hdoc, name):
+    if hdoc and name:
+        return hdoc.replace("@alias", _format_alias(name))
+
+
 def help(ctx, *args):
-    """Prints this help."""
+    """Prints this help. @alias"""
     if args:
         match args:
             case ["help", *sub_command]:
@@ -40,17 +61,18 @@ def help(ctx, *args):
                     sys.modules[__name__], name
                 ), f"command '{name}' not found"
                 if target := getattr(sys.modules[__name__], name).__doc__:
-                    print(target)
+                    print(_doc(target, name))
             case [name, sub_command]:
                 module = _command.eval_module(name)
-                print(getattr(module, sub_command).__doc__)
+                if target := getattr(module, sub_command).__doc__:
+                    print(_doc(target, name))
             case _:
                 print(
                     "Error: You must use help for command and one sub-command only.\n\nhelp <command> [<sub-command>]"
                 )
     else:
         methods = sorted(
-            f"{method.__name__:<20} {method.__doc__.splitlines()[0]}"
+            f"{method.__name__:<20} {_doc(method.__doc__.splitlines()[0], method.__name__)}"
             for method in [getattr(ctx.module, name) for name in ctx.methods]
         )
 
@@ -59,7 +81,7 @@ def help(ctx, *args):
 
 
 def set(ctx, *args):
-    """Configure a sub-command with a new value.
+    """Configure a sub-command with a new value. @alias
 
     set <config> <value>
 
@@ -69,7 +91,7 @@ def set(ctx, *args):
 
 
 def ref(ctx, *args):
-    """Search a reference(s) by chapters and verses.
+    """Search a reference(s) by chapters and verses. @alias
 
     ref <book> [<chapter>[:<verse[-verse]>]]
 
@@ -85,7 +107,7 @@ def ref(ctx, *args):
 
 
 def search(ctx, *args):
-    """Search one or more words.
+    """Search one or more words. @alias
 
     search <word [word2 [...]]>
 
@@ -101,7 +123,7 @@ def search(ctx, *args):
 
 
 def count(ctx, *args):
-    """Count how much words.
+    """Count how much words. @alias
 
     count <word [word2 [...]]>
 
@@ -164,16 +186,17 @@ def blb(ctx, *args):
 
 
 def notes(ctx, *args):
-    """List all notes."""
+    """List all notes. @alias"""
+    assert not args, "you should use only notes"
     return _format_lines(ctx.notes) if ctx.notes else None
 
 
 def note(ctx, *args):
-    """Adds a new note.
+    """Adds a new note. @alias
 
     notes <string>"""
     target = " ".join(args)
 
-    assert target, "you should use notes <string>"
+    assert target, "you should use note <string>"
     ctx.add_note(target)
     return None

src/bibleit/command/set.py

@@ -39,6 +39,7 @@ def bible(ctx, *args):
     Examples:
         set bible kjv
         set bible acf, nvi"""
+    assert args, "you should use bible <translation[, translation[, ...]]>"
     translations = [value for arg in args for value in arg.split(",") if value]
     ctx.bible = sorted(
         {_Bible(translation.lower()) for translation in translations},