Refactor wrap and indent functionality

Author: zooba

src/manage/commands.py

@@ -569,27 +569,13 @@ def show_usage(cls):
         if usage_ljust % 4:
             usage_ljust += 4 - (usage_ljust % 4)
         usage_ljust = max(usage_ljust, 16) + 1
-        sp = " " * usage_ljust
 
         LOGGER.print("!G!Usage:!W!")
         for k, d in usage_docs:
-            if k.endswith("\n") and len(logging.strip_colour(k)) >= usage_ljust:
-                LOGGER.print(k.rstrip())
-                r = sp
-            else:
-                k = k.rstrip()
-                r = k.ljust(usage_ljust + len(k) - len(logging.strip_colour(k)))
-            for b in d.split(" "):
-                if len(r) >= logging.CONSOLE_MAX_WIDTH:
-                    LOGGER.print(r.rstrip())
-                    r = sp
-                r += b + " "
-            if r.rstrip():
-                LOGGER.print(r)
-
-        LOGGER.print()
-        LOGGER.print("Find additional information at !B!%s!W!.", HELP_URL)
-        LOGGER.print()
+            for s in logging.wrap_and_indent(d, indent=usage_ljust, hang=k.rstrip()):
+                LOGGER.print(s)
+
+        LOGGER.print("\nFind additional information at !B!%s!W!.\n", HELP_URL)
 
     @classmethod
     def help_text(cls):
@@ -907,7 +893,7 @@ def execute(self):
         self.show_welcome(copyright=False)
         if not self.args:
             self.show_usage()
-        LOGGER.print(BaseCommand.help_text(commands_only))
+        LOGGER.print(BaseCommand.help_text())
         for a in self.args:
             try:
                 cls = COMMANDS[a.lower()]
@@ -993,7 +979,7 @@ def execute(self):
         first_run(self)
         if not self.explicit:
             self.show_usage()
-            if self.confirm and not self.ask_ny(f"View online help?"):
+            if self.confirm and not self.ask_ny("View online help?"):
                 import os
                 os.startfile(HELP_URL)
 

src/manage/logging.py

@@ -48,6 +48,40 @@ def strip_colour(msg):
     return msg
 
 
+def _len_without_codes(s, codes_subbed=False):
+    n = len(s)
+    for k, v in COLOURS.items():
+        if not codes_subbed:
+            n -= len(k) * s.count(k)
+        n -= len(v) * s.count(v)
+    return n
+
+
+def wrap_and_indent(s, indent=0, width=None, hang="", codes_subbed=False):
+    if width is None:
+        width = CONSOLE_MAX_WIDTH
+    
+    bits = [" " * indent]
+    if hang:
+        cchw = _len_without_codes(hang, codes_subbed=codes_subbed)
+        if cchw <= indent - 1:
+            bits = [hang + " " * (indent - cchw)]
+        else:
+            yield hang
+    cch = indent
+    for w in s.split(" "):
+        cchw = _len_without_codes(w, codes_subbed=codes_subbed)
+        if len(bits) > 1 and cch + cchw > width:
+            yield "".join(bits).rstrip()
+            bits = [" " * indent]
+            cch = indent
+        bits.append(w)
+        bits.append(" ")
+        cch += cchw + 1
+    if bits:
+        yield "".join(bits).rstrip()
+
+
 def supports_colour(stream):
     if os.getenv("PYTHON_COLORS", "").lower() in ("0", "no", "false"):
         return False
@@ -62,7 +96,7 @@ def supports_colour(stream):
     if type(stream).__name__ != "_WindowsConsoleIO":
         return False
     try:
-        # Allows us to import logging on its own
+        # Lazy import to allow us to import logging on its own
         from _native import fd_supports_vt100
         return fd_supports_vt100(stream.fileno())
     except Exception:
@@ -187,16 +221,10 @@ def print(self, msg=None, *args, always=False, level=INFO, colours=True, wrap=Fa
         else:
             msg = ""
         if wrap:
-            while len(msg) > CONSOLE_MAX_WIDTH:
-                part = msg[:CONSOLE_MAX_WIDTH]
-                n = 0
-                while len(part) > n:
-                    n = len(part)
-                    part = msg[:CONSOLE_MAX_WIDTH + 5 * part.count("\033")]
-                pre, sep, rest = part.rpartition(" ")
-                print(pre, **kwargs, file=self.print_console)
-                msg = rest + msg[len(part):]
-        print(msg, **kwargs, file=self.print_console)
+            for s in wrap_and_indent(msg, codes_subbed=True):
+                print(s, **kwargs, file=self.print_console)
+        else:
+            print(msg, **kwargs, file=self.print_console)
 
     def print_raw(self, *msg, **kwargs):
         kwargs["always"] = True

tests/test_logging.py

@@ -0,0 +1,59 @@
+import pytest
+
+from manage import logging
+
+
+def test_wrap_and_indent():
+    r = list(logging.wrap_and_indent("12345678 12345 123 1 123456 1234567890",
+                                     width=8))
+    assert r == [
+        "12345678",
+        "12345",
+        "123 1",
+        "123456",
+        "1234567890",
+    ]
+
+    r = list(logging.wrap_and_indent("12345678 12345 123 1 123456 1234567890",
+                                     indent=4, width=8))
+    assert r == [
+        "    12345678",
+        "    12345",
+        "    123",
+        "    1",
+        "    123456",
+        "    1234567890",
+    ]
+
+    r = list(logging.wrap_and_indent("12345678 12345 123 1 123456 1234567890",
+                                     indent=4, width=8, hang="AB"))
+    assert r == [
+        "AB  12345678",
+        "    12345",
+        "    123",
+        "    1",
+        "    123456",
+        "    1234567890",
+    ]
+
+    r = list(logging.wrap_and_indent("12345678 12345 123 1 123456 1234567890",
+                                     indent=4, width=8, hang="ABC"))
+    assert r == [
+        "ABC 12345678",
+        "    12345",
+        "    123",
+        "    1",
+        "    123456",
+        "    1234567890",
+    ]
+
+    r = list(logging.wrap_and_indent("12345678 12345 123 1 123456 1234567890",
+                                     indent=3, width=8, hang="ABCD"))
+    assert r == [
+        "ABC",
+        "   12345678",
+        "   12345",
+        "   123 1",
+        "   123456",
+        "   1234567890",
+    ]