Expose the command's console object

[bckohan]

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 documentation, with the integrated search.
• I already searched in Google "How to X" and didn't find any information.
• I already read and followed all the tutorials in the docs and didn't find an answer.

Example Code

# This monkey patch is required because typer does
# not expose a good way to custom configure the Console objects
# it uses - revisit this if/when typer exposes control of the
# console object.
from typer import rich_utils
from typer._click.globals import get_current_context

console_getter = rich_utils._get_rich_console

def get_console(stderr: bool = False) -> Console:
    """
    Tweak the internals of the Console created by typer to match
    our context or command.

    Of all the patching this is the sketchiest.
    """
    console = console_getter(stderr=stderr)
    ctx = get_current_context(silent=True)
    cmd = get_current_command()
    console.no_color = (
        ctx.params.get("no_color", "NO_COLOR" in os.environ)
        if ctx
        else (cmd.no_color if cmd else "NO_COLOR" in os.environ)
    )
    console._file = (
        (cmd.stderr if stderr else cmd.stdout) if cmd else console._file
    )
    if console.no_color:
        # also remove highlights so there are
        # no ansi control characters in the text
        console._color_system = None
    elif cmd and cmd.force_color:
        console._force_terminal = True  # set this before detect color!
        console._color_system = console._detect_color_system()
    return console

rich_utils._get_rich_console = get_console

Description

django-typer invokes typer apps as subcommands of the django-admin. Some of the parent command's options tweak console settings (like color). I currently have to monkey patch typer to get access to the command console object.

Aside from my django-commons/django-typer#170 above, I think it would be generally useful to expose the Console object that Typer commands use to print their helps/exceptions. It could be a building block for supporting themes #1797

A per-app hook would also eliminate all of the synchronization problems when tweaking per-command console behavior outside of standalone mode (the main reason for my monkey patch).

The change could be quite simple, with only 2 components:

Add a per-app hook:

1. Typer(rich_console_factory=...)
2. Make the default builder public: typer.rich_utils.get_rich_console(stderr=False, **console_kwargs)

Thoughts? Happy to submit a PR

Operating System

macOS

Operating System Details

No response

Project Version

0.27.2

Python Version

3.14

Additional Context

No response

[svlandeg]

Hi @bckohan! Thanks for the report. We've actually been thinking about this more and we do want to provide functionality that will allow users to more easily tweak how things are displayed, leaning on Rich, and ideally also supporting themes.

AFAIK noone is working on this right now though. I'll briefly talk to Tiangolo to see what he thinks of the "quick fix" you propose here, but considering that there's a way for you to work around this for now, I think I'd be leaning towards waiting until we can deal with this properly rather than implementing some small ad-hoc things now (sorry, I know that's not a satisfying answer, but probably a realistic one...).

[bckohan]

Thanks @svlandeg

I'll just add that I also have to use this same monkey patch to get access to the console object to make sphinxcontrib-typer work. There are reasons you might need access to the Rich console object beyond tweaking its construction parameters.