feat(cli): add pager support to renku log (#2932)

Author: Panaetius

poetry.lock

@@ -65,6 +65,7 @@
     DatasetLogViewModel,
     LogViewModel,
 )
+from renku.ui.cli.utils.terminal import show_text_with_pager, strip_ansi_codes
 
 
 def _print_log(log_entry: LogViewModel) -> str:
@@ -208,14 +209,23 @@ def _print_dataset_log(log_entry: DatasetLogViewModel) -> str:
 )
 @click.option("-w", "--workflows", is_flag=True, default=False, help="Show only workflow executions.")
 @click.option("-d", "--datasets", is_flag=True, default=False, help="Show only dataset modifications.")
-def log(columns, format, workflows, datasets):
+@click.option("--no-pager", is_flag=True, help="Don't use pager (less) for output.")
+@click.option("-c", "--no-color", is_flag=True, help="Do not colorize output.")
+def log(columns, format, workflows, datasets, no_pager, no_color):
     """Show a history of renku workflow and dataset commands."""
     from renku.command.log import log_command
 
     result = log_command().with_database().build().execute(workflows_only=workflows, datasets_only=datasets).output
     if format == "detailed":
         entries = sorted(result, key=lambda e: e.date, reverse=True)
-        texts = [_print_log(e) for e in entries]
-        click.echo("\n\n".join(texts))
+        text = "\n\n".join([_print_log(e) for e in entries])
+
+        if no_color:
+            text = strip_ansi_codes(text)
+
+        if no_pager:
+            click.echo(text)
+        else:
+            show_text_with_pager(text)
     else:
-        click.echo(LOG_FORMATS[format](result, columns))
+        click.echo(LOG_FORMATS[format](result, columns), not no_pager)

renku/ui/cli/log.py

@@ -18,6 +18,9 @@
 """Utility functions for ViewModels."""
 
 import functools
+import pydoc
+import re
+import shutil
 from typing import TYPE_CHECKING
 
 import click
@@ -31,6 +34,27 @@
 style_key = functools.partial(click.style, bold=True, fg=color.MAGENTA)
 style_value = functools.partial(click.style, bold=True)
 
+ANSI_REGEX = re.compile(r"(?:\x1B[@-Z\\-_]|[\x80-\x9A\x9C-\x9F]|(?:\x1B\[|\x9B)[0-?]*[ -/]*[@-~])")
+
+
+def strip_ansi_codes(text: str) -> str:
+    """Remove ANSI formatting codes from text."""
+    return ANSI_REGEX.sub("", text)
+
+
+def show_text_with_pager(text: str) -> None:
+    """Print text with a pager (i.e. ``less``) if appropriate.
+
+    Args:
+        text(str): The text to print.
+    """
+    tty_size = shutil.get_terminal_size(fallback=(120, 40))
+
+    if len(text.splitlines()) >= tty_size.lines:
+        pydoc.pipepager(text, "less --chop-long-lines -R --tilde")
+    else:
+        click.echo(text)
+
 
 def print_markdown(text: str):
     """Print markdown text to console."""
@@ -44,7 +68,8 @@ def print_plan(plan: "PlanViewModel", err: bool = False):
     """Print a plan to stderr.
 
     Args:
-        err: Print to ``stderr``.
+        plan(PlanViewModel): The plan to print.
+        err(bool,optional): Print to ``stderr`` (Default value = False).
     """
 
     def print_key_value(key, value, print_empty: bool = True):

renku/ui/cli/utils/terminal.py

@@ -649,7 +649,6 @@
 """
 
 import os
-import pydoc
 import shutil
 import sys
 from pathlib import Path
@@ -665,6 +664,7 @@
 from renku.core import errors
 from renku.ui.cli.utils.callback import ClickCallback
 from renku.ui.cli.utils.plugins import available_workflow_providers, supported_formats
+from renku.ui.cli.utils.terminal import show_text_with_pager
 
 if TYPE_CHECKING:
     from renku.command.view_model.composite_plan import CompositePlanViewModel
@@ -1147,7 +1147,7 @@ def visualize(sources, columns, exclude_files, ascii, interactive, no_color, pag
             use_pager = True
 
         if use_pager:
-            pydoc.tempfilepager(text_output, "less --chop-long-lines -R --tilde")
+            show_text_with_pager(text_output)
         else:
             click.echo(text_output)
         return