Wrap ./pants help based on actual terminal width

[Eric-Arellano]

Rather than assuming 96 columns, we can use shutil to query how wide the user's terminal actually is.

Because we do not memoize this function, it works with terminal resizes. This is crucial when using Pantsd, otherwise the memoization would last the lifetime of the daemon instance.

[ci skip-rust]
[ci skip-build-wheels]

[stuhood]

@Eric-Arellano : This can likely be refreshed post #11536: I spent some time investigating an issue with widths not propagating, and the Console now deals with "real" file handles. So it should be possible to get them now.

[Eric-Arellano]

No luck. Using os.get_terminal_size() results in this with --pantsd:

23:37:09.13 [ERROR] [Errno 25] Inappropriate ioctl for device
Traceback (most recent call last):
  File "/Users/eric/code/pants/src/python/pants/bin/daemon_pants_runner.py", line 134, in single_daemonized_run
    return runner.run(start_time)
  File "/Users/eric/code/pants/src/python/pants/bin/local_pants_runner.py", line 229, in run
    return self._print_help(self.options.help_request)
  File "/Users/eric/code/pants/src/python/pants/bin/local_pants_runner.py", line 210, in _print_help
    return help_printer.print_help()
  File "/Users/eric/code/pants/src/python/pants/help/help_printer.py", line 57, in print_help
    self._print_thing_help()
  File "/Users/eric/code/pants/src/python/pants/help/help_printer.py", line 106, in _print_thing_help
    self._print_options_help(thing, help_request.advanced)
  File "/Users/eric/code/pants/src/python/pants/help/help_printer.py", line 246, in _print_options_help
    formatted_lines = help_formatter.format_options(oshi)
  File "/Users/eric/code/pants/src/python/pants/help/help_formatter.py", line 49, in format_options
    add_option(oshi.basic)
  File "/Users/eric/code/pants/src/python/pants/help/help_formatter.py", line 38, in add_option
    lines.extend(hard_wrap(oshi.description, width=terminal_width()))
  File "/Users/eric/code/pants/src/python/pants/util/memo.py", line 123, in memoize
    result = func(*args, **kwargs)
  File "/Users/eric/code/pants/src/python/pants/util/docutil.py", line 14, in terminal_width
    print(os.get_terminal_size())
OSError: [Errno 25] Inappropriate ioctl for device

shutil.get_terminal_size() calls that function when $COLUMNS isn't defined. Any idea if that's fixable?

[stuhood]

Ok, interesting. The rust terminal_size crate is able to get it (the UI uses it) using code like this: https://github.com/eminence/terminal-size/blob/68753331337bbf61f19d60511811fc981e67a528/src/unix.rs#L11-L43

Assuming that this is actually a backport: https://github.com/Snaipe/python-rst2ansi/blob/c6f390b45be689a5760060c990e3fe10f502e671/rst2ansi/get_terminal_size.py#L70-L125 ... it's mostly the same code, and the difference appears to be that it's using sys.__stdout__.fileno() rather than sys.stdout.fileno().

The diff below correctly renders:

09:15:51.80 [INFO] terminal_size: os.terminal_size(columns=314, lines=81)

diff --git a/src/python/pants/bin/daemon_pants_runner.py b/src/python/pants/bin/daemon_pants_runner.py
index dff459867..89a0ebf2b 100644
--- a/src/python/pants/bin/daemon_pants_runner.py
+++ b/src/python/pants/bin/daemon_pants_runner.py
@@ -166,6 +166,8 @@ class DaemonPantsRunner(RawFdRunner):
                     stdout_fileno=stdout_fileno,
                     stderr_fileno=stderr_fileno,
                 ), hermetic_environment_as(**env), argv_as((command,) + args):
+                    import shutil
+                    logger.info(f"terminal_size: {shutil.get_terminal_size()}")
                     return self.single_daemonized_run(
                         working_directory.decode(), cancellation_latch
                     )
diff --git a/src/python/pants/init/logging.py b/src/python/pants/init/logging.py
index 1e580f0f5..af8f5e8f3 100644
--- a/src/python/pants/init/logging.py
+++ b/src/python/pants/init/logging.py
@@ -163,10 +163,12 @@ def initialize_stdio(global_bootstrap_options: OptionValueContainer) -> Iterator
             tuple(message_regex_filters),
             log_path,
         )
+        sys.__stdin__, sys.__stdout__, sys.__stderr__ = sys.stdin, sys.stdout, sys.stderr
         # Install a Python logger that will route through the Rust logger.
         with _python_logging_setup(global_level, print_stacktrace):
             yield
     finally:
+        sys.__stdin__, sys.__stdout__, sys.__stderr__ = original_stdin, original_stdout, original_stderr
         sys.stdin, sys.stdout, sys.stderr = original_stdin, original_stdout, original_stderr
 
 

[stuhood]

Oh, so: alternatively, could use https://docs.python.org/3/library/os.html#os.get_terminal_size ?:

os.get_terminal_size(sys.stdout.fileno())

[stuhood]

If the sys.__std*__ replacement passes CI, that's a more holistic fix... mind trying that first?

[stuhood]

Thanks!

[stuhood]

Each call to terminal_width is a syscall, so it might be good to just call it once at the top.

[stuhood]

Nit: A bit nicer symmetry with the above maybe:

Suggested change

	sys.__stdin__, sys.__stdout__, sys.__stderr__ = (
	original_stdin,
	original_stdout,
	original_stderr,
	)
	sys.stdin, sys.stdout, sys.stderr = original_stdin, original_stdout, original_stderr
	sys.stdin, sys.stdout, sys.stderr = original_stdin, original_stdout, original_stderr
	sys.__stdin__, sys.__stdout__, sys.__stderr__ = sys.stdin, sys.stdout, sys.stderr