Capture output with pytest

[ConstantinoSchillebeeckx]

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 tutorial 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

import typer
from rich import print
from typing_extensions import Annotated

app = typer.Typer(add_completion=False, no_args_is_help=True, rich_markup_mode="rich")


@app.command()
def hello(name: str):
    print(f"Hello {name}")


if __name__ == "__main__":
    typer.run(hello)

Description

How do I capture the output of the CLI execution when executing with pytest?

For example, the following unit test fails:

from typer.testing import CliRunner

from foo import app

runner = CliRunner()

def test_app():
    result = runner.invoke(app)
    assert result.exit_code == 1

The output looks like:

I would have expected some sort of captured output like

Missing argument 'NAME'.

This issue seems to suggest it should just work?

Operating System

macOS

Operating System Details

No response

Typer Version

0.9.0

Python Version

3.11.6

Additional Context

No response

[The-Compiler]

The runner does its own output capturing: https://typer.tiangolo.com/tutorial/testing/#check-the-result - unfortunately there seems to be no way to turn it off, so you'd need to print(result.stdout) at some point (possibly via a helper function or fixture).

Also see (the CliRunner is just a thin wrapper over Click):

• Enable CliRunner to echo output to stdout/stderr pallets/click#737