Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

`rich-click` doesn't support `click.Choice`

See original GitHub issue

I’m writing a command which has a --composition parameter that uses click.Choice:

@click.option(
    "--composition",
    type=click.Choice(["auto", "metagenome"], case_sensitive=False),
)

In vanilla click, the possible choices appear as expected:

Options:
  --version                       Show the version and exit.
  --composition [auto|metagenome]
  -v, --verbose / -q, --quiet     Display the execution log.  [default:
                                  verbose]
  -h, --help                      Show this message and exit.

rich-click omits the options:

╭─ Basic options ──────────────────────────────────────────────────────────────────────────────────╮
│  --composition                                                                                   │
│  --verbose/--quiet  -v/-q  Display the execution log. [default: verbose]                         │
╰──────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Other ──────────────────────────────────────────────────────────────────────────────────────────╮
│  --help     -h  Show this message and exit.                                                      │
│  --version      Show the version and exit.                                                       │
╰──────────────────────────────────────────────────────────────────────────────────────────────────╯

Issue Analytics

State:
Created a year ago
Comments:5 (5 by maintainers)

Top GitHub Comments

1reaction

apcamargocommented, May 16, 2022

To be honest, I’m 100% sure this was not a problem with the documentation. I had read all the customization options before and simply forgot about them. But maybe you could add a TOC in the beginning of the README? This way users wouldn’t need to scroll all the way down to see that there are tons of customization options available.

0reactions

ewelscommented, May 16, 2022

Yup, not a bad idea. I’ve gone off manual ToCs a bit since GitHub added their markdown dropdown header menu, as they’re a pain to keep up to date. But I agree that it would be nice to aid visibility here.

Looking at the readme I should probably add more mention of Typer to the intro as well…

Top Results From Across the Web

ewels/rich-click: Format click help output nicely with rich.

The intention of rich-click is to provide attractive help output from click, formatted with rich, with minimal customisation required. Features. Rich command ...

Options — Click Documentation (8.1.x)

The most basic option is a value option. These options accept one argument which is a value. If no type is provided, the...

Option parsing issue with python click

The CLI can be specified with a rich grammar which supports complex CLI options and combinations. The CLI can be run as an...

rich-click

The intention of rich-click is to provide attractive help output from click, formatted with rich, with minimal customisation required. Screenshots. Native click ......

Building Delightful Command-Line Interfaces with Click

Click makes it easy to create rich and informative help documentation. Click automatically adds a --help option to all commands (which can be ......