Make show_usage() function print directly and add tests

Author: zooba

src/manage/commands.py

@@ -513,7 +513,7 @@ def execute(self):
         raise NotImplementedError(f"'{type(self).__name__}' does not implement 'execute()'")
 
     @classmethod
-    def usage_text_lines(cls):
+    def show_usage(cls):
         if EXE_NAME.casefold() in ("py".casefold(), "pyw".casefold()):
             usage_docs = PY_USAGE_DOCS
         else:
@@ -538,38 +538,34 @@ def usage_text_lines(cls):
         usage_ljust = max(usage_ljust, 16) + 1
         sp = " " * usage_ljust
 
-        yield "!G!Usage:!W!"
+        LOGGER.print("!G!Usage:!W!")
         for k, d in usage_docs:
             if k.endswith("\n") and len(logging.strip_colour(k)) >= usage_ljust:
-                yield k.rstrip()
+                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:
-                    yield r.rstrip()
+                    LOGGER.print(r.rstrip())
                     r = sp
                 r += b + " "
             if r.rstrip():
-                yield r
+                LOGGER.print(r)
 
-        yield ""
+        LOGGER.print()
         # TODO: Remove the 3.14 for stable release
-        yield "Find additional information at !B!https://docs.python.org/3.14/using/windows!W!."
-        yield ""
-
-    @classmethod
-    def usage_text(cls):
-        return "\n".join(cls.usage_text_lines())
+        LOGGER.print("Find additional information at !B!https://docs.python.org/3.14/using/windows!W!.")
+        LOGGER.print()
 
     @classmethod
     def help_text(cls):
         return GLOBAL_OPTIONS_HELP_TEXT.replace("\r\n", "\n")
 
     def help(self):
         if type(self) is BaseCommand:
-            LOGGER.print(self.usage_text())
+            self.show_usage()
         LOGGER.print(self.help_text())
         try:
             LOGGER.print(self.HELP_TEXT.lstrip())
@@ -857,7 +853,7 @@ def execute(self):
         LOGGER.print(COPYRIGHT)
         self.show_welcome(copyright=False)
         if not self.args:
-            LOGGER.print(BaseCommand.usage_text())
+            self.show_usage()
         LOGGER.print(BaseCommand.help_text())
         for a in self.args:
             try:
@@ -884,7 +880,7 @@ def execute(self):
         LOGGER.print(f"!R!Unknown command: {' '.join(args)}!W!")
         LOGGER.print(COPYRIGHT)
         self.show_welcome(copyright=False)
-        LOGGER.print(BaseCommand.usage_text())
+        self.show_usage()
         LOGGER.print(f"The command !R!{' '.join(args)}!W! was not recognized.")
 
 

tests/conftest.py

@@ -21,6 +21,10 @@
 manage.EXE_NAME = "pymanager-pytest"
 
 
+import manage.commands
+manage.commands.WELCOME = ""
+
+
 from manage.logging import LOGGER, DEBUG
 LOGGER.level = DEBUG
 

tests/test_commands.py

@@ -3,18 +3,44 @@
 from manage import commands
 
 
-def test_help_with_error_command(assert_log, monkeypatch):
+def test_pymanager_help_command(assert_log):
+    cmd = commands.HelpCommand([commands.HelpCommand.CMD], None)
+    cmd.execute()
+    assert_log(
+        assert_log.skip_until(r"Python installation manager \d+\.\d+.*"),
+        assert_log.skip_until(".*pymanager-pytest exec -V.*"),
+        assert_log.skip_until(".*pymanager-pytest exec -3.*"),
+        assert_log.skip_until(".*pymanager-pytest install.*"),
+        assert_log.skip_until(".*pymanager-pytest list.*"),
+        assert_log.skip_until(".*pymanager-pytest uninstall.*"),
+    )
+
+
+def test_py_help_command(assert_log, monkeypatch):
+    monkeypatch.setattr(commands, "EXE_NAME", "py")
+    cmd = commands.HelpCommand([commands.HelpCommand.CMD], None)
+    cmd.execute()
+    assert_log(
+        assert_log.skip_until(r"Python installation manager \d+\.\d+.*"),
+        assert_log.skip_until(".*pymanager-pytest -V.*"),
+        assert_log.skip_until(".*pymanager-pytest -3.*"),
+        assert_log.skip_until(".*py install.*"),
+        assert_log.skip_until(".*py list.*"),
+        assert_log.skip_until(".*py uninstall.*"),
+    )
+
+
+def test_help_with_error_command(assert_log):
     expect = secrets.token_hex(16)
     cmd = commands.HelpWithErrorCommand(
         [commands.HelpWithErrorCommand.CMD, expect, "-v", "-q"],
         None
     )
-    monkeypatch.setattr(commands, "WELCOME", "")
     cmd.execute()
     assert_log(
-        assert_log.skip_until(rf".*Unknown command: pymanager-pytest {expect} -v -q.*"),
+        assert_log.skip_until(f".*Unknown command: pymanager-pytest {expect} -v -q.*"),
         r"Python installation manager \d+\.\d+.*",
-        assert_log.skip_until(rf"The command .*?pymanager-pytest {expect} -v -q.*"),
+        assert_log.skip_until(f"The command .*?pymanager-pytest {expect} -v -q.*"),
     )