Implement "folded table" output, as an opt-in feature for all tabular outputs (#1231)

Author: sirosen

changelog.d/20260220_181030_sirosen_folded_table.md

@@ -0,0 +1,6 @@
+### Enhancements
+
+* When using table output on narrow terminals, the Globus CLI will now stack
+  table elements in a new "folded table" layout. This behavior is only used
+  when the output device is a TTY. To disable the new output altogether, users
+  can set `GLOBUS_CLI_FOLD_TABLES=0`.

src/globus_cli/termio/_display.py

@@ -6,10 +6,16 @@
 import click
 import globus_sdk
 
-from .context import outformat_is_json, outformat_is_text, outformat_is_unix
+from .context import (
+    fold_tables,
+    outformat_is_json,
+    outformat_is_text,
+    outformat_is_unix,
+)
 from .field import Field
 from .printers import (
     CustomPrinter,
+    FoldedTablePrinter,
     JsonPrinter,
     Printer,
     RecordListPrinter,
@@ -172,7 +178,10 @@ def _resolve_printer(
 
             _assert_iterable(data)
             if text_mode == self.TABLE:
-                return TablePrinter(fields)
+                if fold_tables():
+                    return FoldedTablePrinter(fields)
+                else:
+                    return TablePrinter(fields)
             if text_mode == self.RECORD_LIST:
                 return RecordListPrinter(fields)
 

src/globus_cli/termio/context.py

@@ -108,3 +108,8 @@ def term_is_interactive() -> bool:
         return True
 
     return os.getenv("PS1") is not None
+
+
+def fold_tables() -> bool | None:
+    val = os.getenv("GLOBUS_CLI_FOLD_TABLES")
+    return val is None or utils.str2bool(val)

src/globus_cli/termio/printers/__init__.py

@@ -1,5 +1,6 @@
 from .base import Printer
 from .custom_printer import CustomPrinter
+from .folded_table_printer import FoldedTablePrinter
 from .json_printer import JsonPrinter
 from .record_printer import RecordListPrinter, RecordPrinter
 from .table_printer import TablePrinter
@@ -11,6 +12,7 @@
     "JsonPrinter",
     "UnixPrinter",
     "TablePrinter",
+    "FoldedTablePrinter",
     "RecordPrinter",
     "RecordListPrinter",
 )