Nicer looking command line output (#3079)

Author: bouweandela

esmvalcore/_main.py

@@ -190,6 +190,7 @@ def show(
         """
         import yaml
         from nested_lookup import nested_delete
+        from rich.markdown import Markdown
         from rich.syntax import Syntax
 
         from esmvalcore.config import CFG
@@ -203,7 +204,9 @@ def show(
             if filter
             else ""
         )
-        self._console.print(f"# Current configuration{exclude_msg}:")
+        self._console.print(
+            Markdown(f"# Current configuration{exclude_msg}\n<br>"),
+        )
         self._console.print(
             Syntax(
                 yaml.safe_dump(cfg),
@@ -450,28 +453,48 @@ class Recipes:
     https://docs.esmvaltool.org/en/latest/recipes/index.html.
     """
 
-    @staticmethod
-    def list() -> None:
+    def __init__(self) -> None:
+        from rich.console import Console
+
+        self._console = Console(soft_wrap=True)
+
+    def list(self) -> None:
         """List all installed recipes.
 
         Show all installed recipes, grouped by folder.
         """
+        import yaml
+        from rich.markdown import Markdown
+
         from .config._diagnostics import DIAGNOSTICS
-        from .config._logging import configure_logging
 
-        configure_logging(console_log_level="info")
         recipes_folder = DIAGNOSTICS.recipes
-        logger.info("Showing recipes installed in %s", recipes_folder)
-        print("# Installed recipes")  # noqa: T201
-        for recipe_root, _, files in sorted(os.walk(recipes_folder)):
-            root = os.path.relpath(recipe_root, recipes_folder)
-            if root == ".":
-                root = ""
-            if root:
-                print(f"\n# {root.replace(os.sep, ' - ').title()}")  # noqa: T201
+        messages = [f"# ESMValTool recipes available in `{DIAGNOSTICS.path}`"]
+        for recipe_root, _, files in sorted(recipes_folder.walk()):
+            subdir = recipe_root.relative_to(recipes_folder).as_posix()
+            if subdir == ".":
+                subdir = ""
+            if subdir:
+                messages.append(
+                    f"\n## {subdir.replace(os.sep, ' - ').title()}",
+                )
             for filename in sorted(files):
-                if filename.endswith(".yml"):
-                    print(os.path.join(root, filename))  # noqa: T201
+                recipe = recipe_root / filename
+                if recipe.suffix == ".yml":
+                    title = (
+                        (
+                            yaml.safe_load(
+                                recipe.read_text(encoding="utf-8"),
+                            )
+                            or {}
+                        )
+                        .get("documentation", {})
+                        .get("title", "")
+                    )
+                    messages.append(
+                        f"- `{recipe.relative_to(recipes_folder)}`: {title}",
+                    )
+        self._console.print(Markdown("\n".join(messages)))
 
     @staticmethod
     def get(recipe: str) -> None:
@@ -502,8 +525,7 @@ def get(recipe: str) -> None:
         shutil.copy(installed_recipe, Path(recipe).name)
         logger.info("Recipe %s successfully copied", recipe)
 
-    @staticmethod
-    def show(recipe: str) -> None:
+    def show(self, recipe: str) -> None:
         """Show the given recipe in console.
 
         Use this command to see the contents of any installed recipe.
@@ -513,22 +535,27 @@ def show(recipe: str) -> None:
         recipe: str
             Name of the recipe to get, including any subdirectories.
         """
+        from rich.markdown import Markdown
+        from rich.syntax import Syntax
+
         from .config._diagnostics import DIAGNOSTICS
-        from .config._logging import configure_logging
         from .exceptions import RecipeError
 
-        configure_logging(console_log_level="info")
         installed_recipe = DIAGNOSTICS.recipes / recipe
         if not installed_recipe.exists():
             msg = (
                 f"Recipe {recipe} not found. To list all available recipes, "
                 'execute "esmvaltool list"'
             )
             raise RecipeError(msg)
-        msg = f"Recipe {recipe}"
-        logger.info(msg)
-        logger.info("=" * len(msg))
-        print(installed_recipe.read_text(encoding="utf-8"))  # noqa: T201
+        self._console.print(Markdown(f"# Recipe `{recipe}`"))
+        self._console.print(
+            Syntax(
+                installed_recipe.read_text(encoding="utf-8"),
+                "yaml",
+                background_color="default",
+            ),
+        )
 
 
 class ESMValTool:

tests/integration/test_main.py

@@ -208,7 +208,7 @@ def test_config_show(
     with arguments("esmvaltool", "config", "show", "--filter=None"):
         run()
     stdout = capsys.readouterr().out
-    expected_header = "# Current configuration:\n"
+    expected_header = "Current configuration\n"
     assert expected_header in stdout
     cfg_txt = stdout.split(expected_header)[1]
     cfg = yaml.safe_load(cfg_txt)
@@ -222,7 +222,7 @@ def test_config_show_brief_by_default(capsys: pytest.CaptureFixture) -> None:
         run()
     stdout = capsys.readouterr().out
     expected_header = (
-        "# Current configuration, excluding the keys 'extra_facets':\n"
+        "Current configuration, excluding the keys 'extra_facets'\n"
     )
     assert expected_header in stdout
     # Check that the configuration that is listed by default is sufficiently

tests/unit/main/test_recipes.py

@@ -1,20 +1,36 @@
 """Test the `Recipe` class implementing the `esmvaltool recipes` command."""
 
-import textwrap
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
 
 import pytest
+import yaml
 
 import esmvalcore.config._diagnostics
 from esmvalcore._main import Recipes
 from esmvalcore.exceptions import RecipeError
 
+if TYPE_CHECKING:
+    from pathlib import Path
+
+    import pytest_mock
 
-def test_list(mocker, tmp_path, capsys):
+
+def test_list(
+    mocker: pytest_mock.MockerFixture,
+    tmp_path: Path,
+    capsys: pytest.CaptureFixture,
+) -> None:
     """Test the command `esmvaltool recipes list`."""
-    recipe_dir = tmp_path
+    recipe_dir = tmp_path / "recipes"
+    recipe_dir.mkdir()
     recipe1 = recipe_dir / "recipe_test1.yml"
     recipe2 = recipe_dir / "subdir" / "recipe_test2.yml"
-    recipe1.touch()
+    recipe1.write_text(
+        yaml.safe_dump({"documentation": {"title": "This is a test recipe"}}),
+        encoding="utf-8",
+    )
     recipe2.parent.mkdir()
     recipe2.touch()
 
@@ -24,19 +40,14 @@ def test_list(mocker, tmp_path, capsys):
         create_autospec=True,
     )
     diagnostics.recipes = recipe_dir
+    diagnostics.path = tmp_path
 
     Recipes().list()
 
     msg = capsys.readouterr().out
-    expected = textwrap.dedent(f"""
-    # Installed recipes
-    {recipe1.relative_to(recipe_dir)}
-
-    # Subdir
-    {recipe2.relative_to(recipe_dir)}
-    """)
-    print(msg)
-    assert msg.endswith(expected)
+    assert f"ESMValTool recipes available in {diagnostics.path}" in msg
+    assert "\u2022 recipe_test1.yml: This is a test recipe" in msg
+    assert "\u2022 subdir/recipe_test2.yml" in msg
 
 
 def test_show(mocker, tmp_path, capsys):