Programmatically emit the help screen

[kristopolous]

First Check

• I added a very descriptive title here.
• I used the GitHub search to find a similar question and didn't find it.
• I searched the Typer documentation, with the integrated search.
• I already searched in Google "How to X in Typer" and didn't find any information.
• I already read and followed all the tutorials in the docs and didn't find an answer.
• I already checked if it is not related to Typer but to Click.

Commit to Help

• I commit to help with one of those options 👆

Example Code

This is a very simple ask, I'd like to programmatically emit the help screen, the one that shows up with --help.

Something like app.(anything you want to call it, literally anything at all) would be great. There is apparently absolutely no way to do it.

show_usage(), get_help(), anything at all...

Description

• Create any typer script, anything whatsoever
• try to emit the help screen programmatically

Operating System

Linux

Operating System Details

Any

Typer Version

all of them

Python Version

any

Additional Context

No response

[kristopolous]

Apparently this is the backtrace:

  /home/chris/code/cacher/cache-wrap.py(74)<module>()
-> app()
  /home/chris/code/cacher/venv/lib/python3.12/site-packages/typer/main.py(323)__call__()
-> return get_command(self)(*args, **kwargs)
  /home/chris/code/cacher/venv/lib/python3.12/site-packages/click/core.py(1161)__call__()
-> return self.main(*args, **kwargs)
  /home/chris/code/cacher/venv/lib/python3.12/site-packages/typer/core.py(677)main()
-> return _main(
  /home/chris/code/cacher/venv/lib/python3.12/site-packages/typer/core.py(194)_main()
-> with self.make_context(prog_name, args, **extra) as ctx:
  /home/chris/code/cacher/venv/lib/python3.12/site-packages/click/core.py(949)make_context()
-> self.parse_args(ctx, args)
  /home/chris/code/cacher/venv/lib/python3.12/site-packages/click/core.py(1417)parse_args()
-> value, args = param.handle_parse_result(ctx, opts, args)
  /home/chris/code/cacher/venv/lib/python3.12/site-packages/click/core.py(2403)handle_parse_result()
-> value = self.process_value(ctx, value)
  /home/chris/code/cacher/venv/lib/python3.12/site-packages/click/core.py(2365)process_value()
-> value = self.callback(ctx, self, value)
  /home/chris/code/cacher/venv/lib/python3.12/site-packages/click/decorators.py(550)show_help()
-> echo(ctx.get_help(), color=ctx.color)
  /home/chris/code/cacher/venv/lib/python3.12/site-packages/click/core.py(711)get_help()
-> return self.command.get_help(self)
  /home/chris/code/cacher/venv/lib/python3.12/site-packages/click/core.py(1334)get_help()
-> self.format_help(ctx, formatter)
  /home/chris/code/cacher/venv/lib/python3.12/site-packages/typer/core.py(691)format_help()
-> return rich_utils.rich_format_help(
> /home/chris/code/cacher/venv/lib/python3.12/site-packages/typer/rich_utils.py(597)rich_format_help()

I'd imagine looking at the call graph of (format|get|show)_help will work.

[kristopolous]

after an hour of source investigation, using this undocumented command from click of this hidden feature will work.

def run(
  ctx: typer.Context
): 
  ctx.get_help()

I have nothing nice to say about how impossible this was to find.