✨ Add option to use Enum names instead of values on the commandline

[sirex]

Fixes: #151

Added names parameter, in order to user Enum names instead of values. Also for IntEnum, names are used by default, even if names is False.

[Aerilius]

Thanks! This feature is so much missing when using enums with values of other types than strings.

However I got an error with this code:

    transform: SymmetryTransformation = typer.Option(SymmetryTransformation.TRANSPOSE, names=True),

Error: Invalid value for '--transform': invalid choice: SymmetryTransformation.TRANSPOSE. (choose from IDENTITY, ROT90, ROT180, ROT270, FLIP_X, FLIP_Y, TRANSPOSE, ANTITRANSPOSE)

I had to change the default to the value that should be provided on the CLI, not as received in the application:

    transform: SymmetryTransformation = typer.Option("TRANSPOSE", names=True),

[mattchan-tencent]

Is there some update on whether this can be merged? This would make the Choices feature much more pythonic.

[abondrnco]

Bumping this for interest, surprised this isn't the default behavior but understandable if all of the exploration done around this feature was with string enums

[ryangalamb]

This is a super useful feature, but I noticed some issues while reviewing this:

• The default values are broken. Should add a test case to cover that too. (Also pointed out by @Aerilius)
• The name names should be changed to indicate that it's specific to enums.
• The implicit behavior with IntEnum will likely cause confusion. I'd prefer consistency.

I'd also like to see a test case covering Argument. (I see that this is implemented for Argument, but a test case would help guard against accidentally breaking it.)

I know this has been open for a while, so no worries if you don't have the time/interest to keep working on this. Either way, thank you for getting this started!

[svlandeg]

Hi, thanks for the PR and apologies for the delay in reviewing this!

I'll put this in draft and I'll update with the latest master, and then I'll review in more detail.

[github-actions]

📝 Docs preview

Last commit d516837 at: https://ae333746.typertiangolo.pages.dev

Modified Pages

• https://ae333746.typertiangolo.pages.dev/tutorial/parameter-types/enum/ - (before)

[svlandeg]

Note: throughout this file, the numbering of the tutorials is now pretty disorganized, because of the addition of new ones in between existing ones. I suggest to keep this as-is in this PR to not complicate the git history, but if we're annoyed by the out-of-sequence usage of tutorials here (001-002-007-005-003-006-004), we could fix it afterwards.

[svlandeg]

A quick note that this tutorial file isn't actually referenced from anywhere within the tutorial markdown files.

[svlandeg]

A quick note that this tutorial file isn't actually referenced from anywhere within the tutorial markdown files.

[svlandeg]

A quick note that this tutorial file isn't actually referenced from anywhere within the tutorial markdown files.