Increase output width of all commands

[rudyardrichter]

Use the context_settings argument to click.Command to adjust max content width to 80% of the terminal size.

[sirosen]

One thing which surprised me with this change is that globus transfer -h | cat became narrower.
I'm wondering if we should "widen out" if the terminal width is small, which will also cover the fallback case.

So, something like (and don't mind exactly how I write this please 😉 ):

cols = get_terminal_size(fallback=...).columns
if cols < 100: cols
else: cols * 0.8

Does that seem nice?

[rudyardrichter]

Oh, right. The fallback will take over for the pipe case, so we don't want to again take 80% of that.

I also wonder about cases where get_terminal_size could fail; I figure it doesn't hurt to catch those.

[sirosen]

Just looking at the py3.10 source for get_terminal_size I think this is already an "error handling variant" of os.get_terminal_size(sys.stdout.fileno()).

I would assume that it works as expected and we can handle any bug reports if someone finds a context where it does not. It doesn't look like there have been changes there since py3.5, so I bet it's pretty solid.

[sirosen]

I dropped the helptext from globus transfer -h before and after into files for a side-by-side (copy-paste, to avoid shutil shenanigans):

$ wc -l narrow.txt
136 narrow.txt
$ wc -l wide.txt
82 wide.txt

I think that's a huge improvement, and it's equally striking with commands that have shorter helptext.

I have a change to the --jmespath helptext I plan to suggest as a follow-up, to make that option help fit on one line in more cases.

example helptext with shorter jmespath help

Compare this:

$ globus whoami -h
Usage: globus whoami [OPTIONS]

  Display information for the currently logged-in user.

Options:
  --linked-identities            Also show identities linked to the currently logged-in primary identity.
  -v, --verbose                  Control level of output
  -h, --help                     Show this message and exit.
  -F, --format [unix|json|text]  Output format for stdout. Defaults to text
  --jmespath, --jq TEXT          A JMESPath expression to apply to json output. Forces the format to be json processed by this expression

vs main:

$ globus whoami -h
Usage: globus whoami [OPTIONS]

  Display information for the currently logged-in user.

Options:
  --linked-identities            Also show identities linked to the currently
                                 logged-in primary identity.
  -v, --verbose                  Control level of output
  -h, --help                     Show this message and exit.
  -F, --format [unix|json|text]  Output format for stdout. Defaults to text
  --jmespath, --jq TEXT          A JMESPath expression to apply to json
                                 output. Forces the format to be json
                                 processed by this expression

I would like to have the text widen to full width on very narrow terminals -- since I think that's an easy improvement -- and then we can merge.

[sirosen]

I see the change I asked for is in. Although a somewhat low-key improvement, I'm quite excited for this!