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

docs/tutorial/parameter-types/enum.md

@@ -96,6 +96,77 @@ Training neural network of type: lstm
 
 </div>
 
+### Using Enum names instead of values
+
+Sometimes you want to accept `Enum` names from the command line and convert
+that into `Enum` values in the command handler. You can enable this by setting
+`enum_by_name=True`:
+
+//// tab | Python 3.7+
+
+```Python hl_lines="14"
+{!> ../docs_src/parameter_types/enum/tutorial004_an.py!}
+```
+
+////
+
+//// tab | Python 3.7+ non-Annotated
+
+/// tip
+
+Prefer to use the `Annotated` version if possible.
+
+///
+
+```Python hl_lines="13"
+{!> ../docs_src/parameter_types/enum/tutorial004.py!}
+```
+
+////
+
+And then the names of the `Enum` will be used instead of values:
+
+<div class="termy">
+
+```console
+$ python main.py --log-level debug
+
+Log level set to DEBUG
+```
+
+</div>
+
+This can be particularly useful if the enum values are not strings:
+
+//// tab | Python 3.7+
+
+```Python hl_lines="8-11 14"
+{!> ../docs_src/parameter_types/enum/tutorial005_an.py!}
+```
+
+////
+
+//// tab | Python 3.7+ non-Annotated
+
+/// tip
+
+Prefer to use the `Annotated` version if possible.
+
+///
+
+```Python hl_lines="7-10 13"
+{!../docs_src/parameter_types/enum/tutorial005.py!}
+```
+
+////
+
+```console
+$ python main.py --access protected
+
+Access level: protected (2)
+```
+
+
 ### List of Enum values
 
 A *CLI parameter* can also take a list of `Enum` values:
@@ -153,3 +224,45 @@ Buying groceries: Eggs, Bacon
 ```
 
 </div>
+
+You can also combine `enum_by_name=True` with a list of enums:
+
+//// tab | Python 3.7+
+
+```Python hl_lines="15"
+{!> ../docs_src/parameter_types/enum/tutorial006_an.py!}
+```
+
+////
+
+//// tab | Python 3.7+ non-Annotated
+
+/// tip
+
+Prefer to use the `Annotated` version if possible.
+
+///
+
+```Python hl_lines="13"
+{!> ../docs_src/parameter_types/enum/tutorial006.py!}
+```
+
+////
+
+This works exactly the same, but you're using the enum names instead of values:
+
+<div class="termy">
+
+```console
+// Try it with a single value
+$ python main.py --groceries "f1"
+
+Buying groceries: Eggs
+
+// Try it with multiple values
+$ python main.py --groceries "f1" --groceries "f2"
+
+Buying groceries: Eggs, Bacon
+```
+
+</div>

docs_src/multiple_values/arguments_with_multiple_values/tutorial003.py

@@ -0,0 +1,29 @@
+from enum import Enum
+from typing import Tuple
+
+import typer
+
+
+class SuperHero(str, Enum):
+    hero1 = "Superman"
+    hero2 = "Spiderman"
+    hero3 = "Wonder woman"
+
+
+def main(
+    names: Tuple[str, str, str, SuperHero] = typer.Argument(
+        ("Harry", "Hermione", "Ron", "hero3"),
+        enum_by_name=True,
+        case_sensitive=False,
+        help="Select 4 characters to play with",
+    ),
+):
+    for name in names:
+        if isinstance(name, Enum):
+            print(f"Hello {name.value}")
+        else:
+            print(f"Hello {name}")
+
+
+if __name__ == "__main__":
+    typer.run(main)

docs_src/multiple_values/arguments_with_multiple_values/tutorial003_an.py

@@ -0,0 +1,32 @@
+from enum import Enum
+from typing import Tuple
+
+import typer
+from typing_extensions import Annotated
+
+
+class SuperHero(str, Enum):
+    hero1 = "Superman"
+    hero2 = "Spiderman"
+    hero3 = "Wonder woman"
+
+
+def main(
+    names: Annotated[
+        Tuple[str, str, str, SuperHero],
+        typer.Argument(
+            enum_by_name=True,
+            help="Select 4 characters to play with",
+            case_sensitive=False,
+        ),
+    ] = ("Harry", "Hermione", "Ron", "hero3"),
+):
+    for name in names:
+        if isinstance(name, Enum):
+            print(f"Hello {name.value}")
+        else:
+            print(f"Hello {name}")
+
+
+if __name__ == "__main__":
+    typer.run(main)

docs_src/multiple_values/options_with_multiple_values/tutorial002.py

@@ -0,0 +1,25 @@
+from enum import Enum
+from typing import Tuple
+
+import typer
+
+
+class Food(str, Enum):
+    f1 = "Eggs"
+    f2 = "Bacon"
+    f3 = "Cheese"
+
+
+def main(user: Tuple[str, int, bool, Food] = typer.Option((None, None, None, Food.f1))):
+    username, coins, is_wizard, food = user
+    if not username:
+        print("No user provided")
+        raise typer.Abort()
+    print(f"The username {username} has {coins} coins")
+    if is_wizard:
+        print("And this user is a wizard!")
+    print(f"And they love eating {food.value}")
+
+
+if __name__ == "__main__":
+    typer.run(main)

docs_src/multiple_values/options_with_multiple_values/tutorial002_an.py

@@ -0,0 +1,33 @@
+from enum import Enum
+from typing import Tuple
+
+import typer
+from typing_extensions import Annotated
+
+
+class Food(str, Enum):
+    f1 = "Eggs"
+    f2 = "Bacon"
+    f3 = "Cheese"
+
+
+def main(
+    user: Annotated[Tuple[str, int, bool, Food], typer.Option()] = (
+        None,
+        None,
+        None,
+        Food.f1,
+    ),
+):
+    username, coins, is_wizard, food = user
+    if not username:
+        print("No user provided")
+        raise typer.Abort()
+    print(f"The username {username} has {coins} coins")
+    if is_wizard:
+        print("And this user is a wizard!")
+    print(f"And they love eating {food.value}")
+
+
+if __name__ == "__main__":
+    typer.run(main)

docs_src/multiple_values/options_with_multiple_values/tutorial003.py

@@ -0,0 +1,29 @@
+from enum import Enum
+from typing import Tuple
+
+import typer
+
+
+class Food(str, Enum):
+    f1 = "Eggs"
+    f2 = "Bacon"
+    f3 = "Cheese"
+
+
+def main(
+    user: Tuple[str, int, bool, Food] = typer.Option(
+        (None, None, None, "f1"), enum_by_name=True
+    ),
+):
+    username, coins, is_wizard, food = user
+    if not username:
+        print("No user provided")
+        raise typer.Abort()
+    print(f"The username {username} has {coins} coins")
+    if is_wizard:
+        print("And this user is a wizard!")
+    print(f"And they love eating {food.value}")
+
+
+if __name__ == "__main__":
+    typer.run(main)

docs_src/multiple_values/options_with_multiple_values/tutorial003_an.py

@@ -0,0 +1,33 @@
+from enum import Enum
+from typing import Tuple
+
+import typer
+from typing_extensions import Annotated
+
+
+class Food(str, Enum):
+    f1 = "Eggs"
+    f2 = "Bacon"
+    f3 = "Cheese"
+
+
+def main(
+    user: Annotated[Tuple[str, int, bool, Food], typer.Option(enum_by_name=True)] = (
+        None,
+        None,
+        None,
+        "f1",
+    ),
+):
+    username, coins, is_wizard, food = user
+    if not username:
+        print("No user provided")
+        raise typer.Abort()
+    print(f"The username {username} has {coins} coins")
+    if is_wizard:
+        print("And this user is a wizard!")
+    print(f"And they love eating {food.value}")
+
+
+if __name__ == "__main__":
+    typer.run(main)

docs_src/parameter_types/enum/tutorial004.py

@@ -0,0 +1,18 @@
+import enum
+import logging
+
+import typer
+
+
+class LogLevel(enum.Enum):
+    debug = logging.DEBUG
+    info = logging.INFO
+    warning = logging.WARNING
+
+
+def main(log_level: LogLevel = typer.Option("warning", enum_by_name=True)):
+    typer.echo(f"Log level set to: {logging.getLevelName(log_level.value)}")
+
+
+if __name__ == "__main__":
+    typer.run(main)

docs_src/parameter_types/enum/tutorial004_an.py

@@ -0,0 +1,19 @@
+import enum
+import logging
+
+import typer
+from typing_extensions import Annotated
+
+
+class LogLevel(enum.Enum):
+    debug = logging.DEBUG
+    info = logging.INFO
+    warning = logging.WARNING
+
+
+def main(log_level: Annotated[LogLevel, typer.Option(enum_by_name=True)] = "warning"):
+    typer.echo(f"Log level set to: {logging.getLevelName(log_level.value)}")
+
+
+if __name__ == "__main__":
+    typer.run(main)

docs_src/parameter_types/enum/tutorial005.py

@@ -0,0 +1,18 @@
+import enum
+
+import typer
+
+
+class Access(enum.IntEnum):
+    private = 1
+    protected = 2
+    public = 3
+    open = 4
+
+
+def main(access: Access = typer.Option("private", enum_by_name=True)):
+    typer.echo(f"Access level: {access.name} ({access.value})")
+
+
+if __name__ == "__main__":
+    typer.run(main)

docs_src/parameter_types/enum/tutorial005_an.py

@@ -0,0 +1,19 @@
+import enum
+
+import typer
+from typing_extensions import Annotated
+
+
+class Access(enum.IntEnum):
+    private = 1
+    protected = 2
+    public = 3
+    open = 4
+
+
+def main(access: Annotated[Access, typer.Option(enum_by_name=True)] = "private"):
+    typer.echo(f"Access level: {access.name} ({access.value})")
+
+
+if __name__ == "__main__":
+    typer.run(main)