Generate Pretty Value Errors similar to option/argument validation

[ryanmerolle]

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

currently I raise the following:


    if private_key and password:
        print(
            "Contradicting options by setting both --password and --private-key. ."
        )
        raise typer.Exit(code=1)

Description

Is there a way to generate your own errors similar to the option/argument validation?

Example for if a file does not exist:

uv run netcollector collect -i tests/inventory.yamll
Usage: netcollector collect [OPTIONS]
Try 'netcollector collect --help' for help.
╭─ Error ──────────────────────────────────────────────────────────────────────────────────╮
│ Invalid value for '--inventory-file' / '-i': File 'tests/inventory.yamll' does not exist.│
╰──────────────────────────────────────────────────────────────────────────────────────────╯

I'd love to generate something like this:

NETCOLLECTOR_USER=uv run netcollector collect --private-key test.key --password test
Usage: netcollector collect [OPTIONS]
Try 'netcollector collect --help' for help.
╭─ Error ──────────────────────────────────────────────────────────────────────────────────╮
│ Contradicting options by setting both --password and --private-key.                      │
╰──────────────────────────────────────────────────────────────────────────────────────────╯

Operating System

Linux, Windows, macOS

Operating System Details

No response

Typer Version

0.15.4

Python Version

Python 3.12.10

Additional Context

Thanks!

[ryanmerolle]

I used rich_utils.rich_format_error.

import click
from typer import rich_utils


class ContradictingOptionsError(click.ClickException):

    def __init__(self, message: str) -> None:
        super().__init__(message)
        self.exit_code = 1


rich_utils.rich_format_error(
    ContradictingOptionsError(
        "Contradicting options by setting both '--password' / '-p' and '--private-key' / '-pk'."
    )
)