Merge pull request #23 from mittel-labs/feat/improve-cli

Improving CLI

Author: fmamud

README.md

@@ -1,17 +1,46 @@
 # bibleit
 
-Interactive bible reading
+Interactive Bible reading.
 
 ## How to run
 
 ```sh
-python -m bibleit
+$ python -m bibleit
+
+usage: bibleit [-h] [--version] [--repl] [--linesep value] [--bible value] [--debug] [--screen] [--textwrap] [--bold] [--label] [args ...]
+
+positional arguments:
+  args             Arguments to be evaluated
+
+options:
+  -h, --help       show this help message and exit
+  --version        show program's version number and exit
+  --repl           Opens bibleit REPL
+  --linesep value  Configure line separator
+  --bible value    Use one or more Bible translations
+  --debug          Enable debug flag
+  --screen         Enable screen flag
+  --textwrap       Enable textwrap flag
+  --bold           Enable bold flag
+  --label          Enable label flag
 ```
 
+## REPL
+
+Bibleit has an interactive interpreter in order to interact with the Bible.
+
+You can use `--repl` argument:
+
 ```sh
-python -m bibleit help
+python -m bibleit --repl
 ```
 
+Or run directly from `bibleit.repl` module:
+
 ```sh
-python -m bibleit ref Joao 11
-```
+python -m bibleit.repl
+```
+
+After that you're going to see a console, so that you can start typing commands:
+
+![](repl.gif)

repl.gif

@@ -1,13 +1,39 @@
-import sys
+from bibleit.command import args as bargs
+from bibleit import repl
 
-args = sys.argv[1:]
+_FLAG_PREFIX = "flag_"
 
-if args:
-    from bibleit import command, context
+args = bargs.parser.parse_args()
+
+
+def get_active_flags(ctx):
+    for flag in (
+        flag.removeprefix(_FLAG_PREFIX)
+        for flag in dir(ctx)
+        if flag.startswith(_FLAG_PREFIX)
+    ):
+        if getattr(args, f"{_FLAG_PREFIX}{flag}"):
+            yield flag
 
-    if result := command.eval(context.Context(), *args):
-        print(result)
-else:
-    from bibleit import repl
 
+if args.repl:
     repl.run()
+else:
+    if args.args:
+        from bibleit import context, config
+        from bibleit.command import set
+
+        for flag in get_active_flags(args):
+            config.set_flag(flag, True)
+
+        ctx = context.Context()
+
+        if args.bible:
+            set.bible(ctx, ",".join(args.bible))
+
+        if args.linesep is not None:
+            set.linesep(ctx, str(args.linesep))
+
+        repl.eval(ctx, " ".join(args.args))
+    else:
+        bargs.parser.print_help()

src/bibleit/__main__.py

@@ -60,10 +60,14 @@ def __eq__(self, other):
         return self.__class__ == other.__class__ and self.version == other.version
 
     def labeled(self, value):
-        return f"✝ {self.version}{_config.context_ps1}\t{value}" if _config.label else value
+        return (
+            f"✝ {self.version}{_config.context_ps1}\t{value}"
+            if _config.flags.label
+            else value
+        )
 
     def bolded(self, value):
-        if _config.bold:
+        if _config.flags.bold:
             if ref_idx := re.search(r" \d+:\d+", value):
                 ref_idx = ref_idx.end()
             return f"{BOLD}{value[:ref_idx]}{END} {value[ref_idx + 1:]}"

src/bibleit/bible.py

@@ -26,7 +26,7 @@ def eval_module(name):
             return import_module(target)
         return sys.modules[target]
     except ModuleNotFoundError as e:
-        if config.debug:
+        if config.flags.debug:
             print(e)
         return eval_module(_default_module)
 
@@ -59,7 +59,7 @@ def eval(ctx, *line, module=None):
     except AssertionError as e:
         print(f"Error: {e}")
     except Exception as e:
-        if config.debug:
+        if config.flags.debug:
             print(f"*** {e}\n")
             print(traceback.format_exc())
         if module != _default_module:

src/bibleit/command/__init__.py

@@ -0,0 +1,37 @@
+import argparse
+
+from bibleit import config, bible
+
+parser = argparse.ArgumentParser(
+    prog=config.application,
+    description=f"{config.application} v{config.version}",
+    allow_abbrev=False,
+)
+
+parser.add_argument(
+    "--version", action="version", version=f"{config.application} v{config.version}"
+)
+parser.add_argument("--repl", action="store_true", help="Opens bibleit REPL")
+parser.add_argument(
+    "--linesep",
+    type=int,
+    choices=range(0, 11),
+    metavar="value",
+    help="Configure line separator",
+)
+parser.add_argument(
+    "--bible",
+    choices=bible.get_available_bibles(),
+    action="append",
+    metavar="value",
+    help="Use one or more Bible translations",
+)
+parser.add_argument("args", nargs="*", help="Arguments to be evaluated")
+
+for flag in config.flag_names:
+    parser.add_argument(
+        f"--{flag}",
+        action="store_true",
+        dest=f"flag_{flag}",
+        help=f"Enable {flag} flag",
+    )

src/bibleit/command/args.py

@@ -11,8 +11,8 @@
 
 
 def _format_lines(lines):
-    linesep = ("\n" * (_config.linesep + 1))
-    if _config.textwrap:
+    linesep = "\n" * (_config.linesep + 1)
+    if _config.flags.textwrap:
         lines = map(
             lambda x: linesep.join(x),
             map(lambda x: _tw.wrap(x, width=120, fix_sentence_endings=True), lines),

src/bibleit/command/core.py

@@ -9,8 +9,6 @@
 _FLAGS_OFF = ["false", "off"]
 _FLAGS_TOGGLE = _FLAGS_ON + _FLAGS_OFF
 
-_FLAGS = {"debug", "label", "screen", "textwrap", "bold"}
-
 
 def _flag(value):
     if value := value.lower():
@@ -21,11 +19,11 @@ def _flag(value):
     return False
 
 
-for _flag_name in _FLAGS:
+for _flag_name in _config.flag_names:
 
     def _flag_method(name):
         def fn(ctx, value):
-            setattr(_config, name, _flag(value))
+            _config.set_flag(name, _flag(value))
 
         fn.__doc__ = f"Configure {_flag_name} config\n\n    set {_flag_name} <{'|'.join(_FLAGS_TOGGLE)}>"
         return fn
@@ -40,13 +38,13 @@ def bible(ctx, *args):
 
     Examples:
         set bible kjv
-        set bible acf, nvi/pt"""
+        set bible acf, nvi"""
     translations = [value for arg in args for value in arg.split(",") if value]
     ctx.bible = sorted(
         {_Bible(translation.lower()) for translation in translations},
         key=_attrgetter("version"),
     )
-    _config.label = len(translations) > 1
+    _config.flags.label = len(translations) > 1
 
 
 def linesep(ctx, *args):
@@ -60,7 +58,7 @@ def linesep(ctx, *args):
     value = "".join(args)
     if value.isdigit():
         value = int(value)
-        assert 0 <= value < 10, "value must be a int between 0 and 10"
+        assert 0 <= value <= 10, "line separation value must be a int between 0 and 10"
         _config.linesep = value
     else:
-        raise AssertionError("value should be an int")
+        raise AssertionError("line separation value should be an int")

src/bibleit/command/set.py

@@ -1,9 +1,10 @@
+import sys
+
+from types import SimpleNamespace
+
+__this = sys.modules[__name__]
+
 # General
-debug = False
-label = False
-screen = False
-textwrap = False
-bold = False
 application = "bibleit"
 version = "0.0.17"
 help = 'Type "help" for more information.'
@@ -16,7 +17,17 @@
 # Bible
 default_bible = "nvi"
 
+# Config
+flags = SimpleNamespace(
+    debug=False, label=False, screen=False, textwrap=False, bold=False
+)
+flag_names = set(flags.__dict__)
+linesep = 1
+
 # Repl
 history_length = 1000
 context_ps1 = ">"
-linesep = 1
+
+
+def set_flag(name: str, value: bool):
+    setattr(flags, name, value)

src/bibleit/config.py

@@ -1,3 +1,4 @@
+import sys
 from bibleit import config
 from bibleit.bible import Bible, BibleNotFound, BOLD, END
 
@@ -6,6 +7,7 @@ class Context:
     def __init__(self):
         self._notes = set()
         self.screen = None
+        self.__main__ = None
         try:
             self.bible = [Bible(config.default_bible)]
         except BibleNotFound as e:
@@ -14,7 +16,7 @@ def __init__(self):
 
     def __repr__(self):
         line = f"{','.join(map(str,self.bible))}{config.context_ps1}"
-        if config.bold:
+        if config.flags.bold:
             line = f"{BOLD}{line}{END}"
         return f"✝ {line} "
 
@@ -24,3 +26,7 @@ def notes(self):
 
     def add_note(self, value):
         self._notes.add(value)
+
+    def exit_non_main(self):
+        if self.__main__ != "__main__":
+            sys.exit(0)