Improved txt_terminal_render helper

Author: dhondta

src/tinyscript/VERSION.txt

@@ -1 +1 @@
-1.30.13
+1.30.14

src/tinyscript/features/notify/__init__.py

@@ -21,14 +21,14 @@ def set_notify_items(glob):
     """
     a = glob['args']
     enabled = getattr(a, a._collisions.get("notify") or "notify", False)
-    appname = glob.get('__banner__', glob.get('__script__'))
+    appname = glob.get('__banner__', glob.get('__script__', "my-app"))
     timeout = positive_int(glob.get('NOTIFICATION_TIMEOUT', 5), zero=False)
     icon_path = folder_exists(glob.get('NOTIFICATION_ICONS_PATH', dirname(__file__)))
     level = positive_int(glob.get('NOTIFICATION_LEVEL', logging.SUCCESS))
 
     class NotificationHandler(logging.Handler):
         def emit(self, record):
-            title = "{}[{}]:".format(appname, record.name) if record.name != "main" else appname
+            title = f"{appname}[{record.name}]:" if record.name != "main" else appname
             icon = record.levelname.lower()
             ipath = join(icon_path, icon) + ".png"
             if isfile(ipath):

src/tinyscript/helpers/text.py

@@ -84,15 +84,36 @@ def hexdump(data, width=16, first=0, last=0):
         yield "%0.8x:  %s  %s" % (i, h.ljust(width*2+(width//2-1)), b)
 
 
-def txt_terminal_render(text, format=None, debug=False, alignleft=True):
+def txt_terminal_render(text, format=None, debug=False, alignleft=True, pad=None, syntax=None):
     """ This renders input text based on the selected format.
     
     :param format: selected format (one of FORMATS)
     """
+    from rich.console import Console
+    from rich.markup import escape
+    from rich.style import Style
+    from rich.theme import Theme
+    c = Console(theme=Theme(styles={n: Style(**s) for n, s in DOCFORMAT_THEME.items()}))
+    # inner function for capturing rich object's resulting text
+    def _capture(obj):
+        c.begin_capture()
+        c.print(obj)
+        return c.end_capture()
+    # inner function for rendering padding and/or syntax
+    def _beautify(txt, raw=False):
+        r = txt
+        if syntax:
+            from rich.syntax import Syntax
+            r = _capture(Syntax(r, syntax, padding=pad))
+        elif pad:
+            from rich.padding import Padding
+            r = _capture(Padding(escape(r) if raw else r, pad=pad))
+        return r
+    # start processing input text
     format = format or DOCFORMAT
     __check(format=format)
     if format is None:
-        return text
+        return _beautify(text, raw=True)
     # collect whitespaces in argument lines and line indentations
     ARG_REGEX = re.compile(r"((?P<h>\-{1,2})[a-z][a-z0-9_]*(?:\s+[A-Z][A-Z_]*)?"
                            r"(?:\,\s+(?P=h)\-[a-z][a-z0-9_]*(?:\s+[A-Z][A-Z_]*)?)?)(\s+)(.*)$")
@@ -159,17 +180,12 @@ def txt_terminal_render(text, format=None, debug=False, alignleft=True):
         for link in re.findall("(<(.*?)>)", md):
             md = md.replace(link[0], "[{0}]({1}{0})".format(link[1], ["", "mailto:"][is_email(link[1])]))
     # import only when required to render Markdown in the terminal
-    from rich.console import Console
-    from rich.markdown import Heading, Markdown
-    from rich.style import Style
-    from rich.theme import Theme
+    from rich.markdown import Markdown
     if alignleft:
+        from rich.markdown import Heading
         from tinyscript import code
         code.replace(Heading.__rich_console__, "text.justify = \"center\"", "")
-    c = Console(theme=Theme(styles={n: Style(**s) for n, s in DOCFORMAT_THEME.items()}))
-    c.begin_capture()
-    c.print(Markdown(md))
-    return c.end_capture()
+    return _beautify(_capture(Markdown(md)))
 
 
 def _txt_list(text, format=None, ordered=False):

src/tinyscript/parser.py

@@ -177,25 +177,21 @@ def __proxy_to_real_parser(value):
                            help=gt("remote interacting port"))
         if noarg and noargs_action == "interact":
             tokens[1:] = [opt.option_strings[-1]]
-        set_interact_items(glob)
     # notification feature, for displaying notifications during the execution
     if add['notify']:
         opt = i.add_argument("-n", "--notify", action="store_true", suffix="mode", help=gt("notify mode"))
         if noarg and noargs_action == "notify":
             tokens[1:] = [opt.option_strings[-1]]
-        set_notify_items(glob)
     # progress mode feature, for displaying a progress bar during the execution
     if add['progress']:
         opt = i.add_argument("-p", "--progress", action="store_true", suffix="mode", help=gt("progress mode"))
         if noarg and noargs_action == "progress":
             tokens[1:] = [opt.option_strings[-1]]
-        set_progress_items(glob)
     # stepping mode feature, for stepping within the tool during its execution, especially useful for debugging
     if add['step']:
         opt = i.add_argument("--step", action="store_true", last=True, suffix="mode", help=gt("stepping mode"))
         if noarg and noargs_action == "step":
             tokens[1:] = [opt.option_strings[-1]]
-        set_step_items(glob)
     # timing mode feature, for measuring time along the execution of the tool
     if add['time']:
         b = p.add_argument_group("timing arguments")
@@ -272,9 +268,10 @@ def __proxy_to_real_parser(value):
                      getattr(a, a._collisions.get("relative", "relative"), False),
                      getattr(a, a._collisions.get("logfile", "logfile"), None),
                      getattr(a, a._collisions.get("syslog", "syslog"), None))
-    # 5) configure features that need it (even if not enabled)
+    # 5) configure features (with glob['args'] computed)
+    for k in ['interact', 'notify', 'progress', 'step', 'time']:
+        globals()[f'set_{k}_items'](glob)
     set_hotkeys(glob)
-    set_time_items(glob)
     # 6) display a banner if relevant
     bf = glob.get('BANNER_FONT', BANNER_FONT)
     if add_banner or isinstance(bf, str):

src/tinyscript/preimports/ftools.py

@@ -13,7 +13,7 @@ def __init__(self, wrapped, assignents=functools.WRAPPER_ASSIGNMENTS):
             self.__wrapped__ = wrapped
             for attr in assignents:
                 setattr(self, attr, getattr(wrapped, attr))
-            super().__init__()
+            super().__init__(wrapped)
 
         def __repr__(self):
             return repr(self.__wrapped__)

tests/test_helpers_path.py

@@ -6,6 +6,7 @@
 from tempfile import gettempdir
 from unittest import TestCase
 
+from tinyscript import b
 from tinyscript.helpers.path import *
 
 from utils import *
@@ -14,7 +15,7 @@
 class TestHelpersPath(TestCase):
     @classmethod
     def setUpClass(cls):
-        global FILE, FILE2, MODULE, NOTEX, PATH, SPATH, TEST, TPATH1, TPATH2
+        global FILE, FILE2, MODULE, NOTEX, PATH, SPATH, TEST, TPATH1, TPATH2, TXT
         TEST = "test_dir"
         PATH = Path(TEST, expand=True, create=True)
         SPATH = PATH.joinpath("test")
@@ -36,6 +37,7 @@ def setUpClass(cls):
         FILE2 = PATH.joinpath("test2.txt")
         SPATH.joinpath("test.txt").touch()
         NOTEX = Path("DOES_NOT_EXIST")
+        TXT = "this is a\n test"
 
     @classmethod
     def tearDownClass(cls):
@@ -60,11 +62,11 @@ def test_file_extensions(self):
         self.assertIsNone(FILE.remove())
         self.assertFalse(FILE.exists())
         self.assertIsNone(FILE.touch())
-        self.assertEqual(FILE.write_text("this is a test"), 14)
-        self.assertEqual(list(FILE.read_lines()), [b"this is a test"])
-        self.assertEqual(list(FILE.read_lines(reverse=True)), [b"this is a test"])
-        self.assertEqual(list(FILE.read_lines(encoding="utf-8")), ["this is a test"])
-        self.assertEqual(list(FILE.read_lines(encoding="utf-8", reverse=True)), ["this is a test"])
+        self.assertEqual(FILE.write_text(TXT), 15)
+        self.assertEqual(list(FILE.read_lines()), list(map(b, TXT.split("\n"))))
+        self.assertEqual(list(FILE.read_lines(reverse=True)), list(map(b, TXT.split("\n")))[::-1])
+        self.assertEqual(list(FILE.read_lines(encoding="utf-8")), TXT.split("\n"))
+        self.assertEqual(list(FILE.read_lines(encoding="utf-8", reverse=True)), TXT.split("\n")[::-1])
         self.assertEqual(FILE.choice(), FILE)
         self.assertEqual(FILE.generate(), FILE)
         self.assertRaises(TypeError, FILE.append_text, 0)
@@ -81,7 +83,7 @@ def test_folder_extensions(self):
         self.assertEqual(str(PATH), str(Path(TEST).absolute()))
         self.assertEqual(Path(TEST).child, Path("."))
         self.assertEqual(SPATH.size, 4096)
-        self.assertEqual(PATH.size, [4096 + 4096 + 14, 8213][WINDOWS])  # PATH + SPATH + FILE
+        self.assertEqual(PATH.size, [4096 + 4096 + 15, 8213][WINDOWS])  # PATH + SPATH + FILE
         self.assertTrue(PATH.choice(".txt", ".py", ".other").is_samepath(FILE))
         self.assertIsInstance(PATH.generate(), Path)
         self.assertEqual(list(PATH.iterfiles()), [FILE.absolute()])

tests/test_helpers_text.py

@@ -132,6 +132,9 @@ def test_text_rendering(self):
         self.assertRaises(ValueError, txt2url, TXT)
         for help, fmt in zip([HTML, MD, RST, TEXTILE], ["html", "md", "rst", "textile"]):
             self.assertIsNotNone(txt_terminal_render(help, fmt))
+        self.assertIsNotNone(txt_terminal_render(TXT, pad=(2,2)))
+        self.assertIsNotNone(txt_terminal_render("test:\n  string: ok\n", pad=(2,2), syntax="yaml"))
+        self.assertIsNotNone(txt_terminal_render("test:\n  string: ok\n", format="rst", pad=(2,2), syntax="yaml"))
 
     def test_text_utils(self):
         self.assertEqual(list(hexdump(URL)), ["00000000:  6874 7470 733a 2f2f 6a6f 686e 3a64 6f65  https://john:doe",

tests/test_preimports_ftools.py

@@ -0,0 +1,38 @@
+# -*- coding: UTF-8 -*-
+"""Preimports code manipulation assets' tests.
+
+"""
+from tinyscript.preimports import functools
+
+from utils import *
+
+
+class TestPreimportsCode(TestCase):
+    def test_class_wrapper(self):
+        # source: https://stackoverflow.com/questions/6394511/python-functools-wraps-equivalent-for-classes
+        @functools.wraps_cls
+        class Memoized:
+            def __init__(self, func):
+                super().__init__()
+                self.__func, self.__cache = func, {}
+            def __call__(self, *args):
+                try:
+                    return self.__cache[args]
+                except KeyError:
+                    self.__cache[args] = v = self.__func(*args)
+                    return v
+                except TypeError:
+                    return self.__func(*args)
+            def __get__(self, obj, objtype):
+                return functools.partial(self.__call__, obj)
+        
+        @Memoized
+        def fibonacci(n):
+            """fibonacci docstring"""
+            if n in (0, 1):
+               return n
+            return fibonacci(n-1) + fibonacci(n-2)
+        
+        self.assertEqual(fibonacci.__doc__, "fibonacci docstring")
+        self.assertIn("wrapper.<locals>.fibonacci", repr(fibonacci))
+