Formalize more choice options to enums. (#321)

Author: tobiasraabe

docs/source/changes.md

@@ -5,7 +5,13 @@ chronological order. Releases follow [semantic versioning](https://semver.org/)
 releases are available on [PyPI](https://pypi.org/project/pytask) and
 [Anaconda.org](https://anaconda.org/conda-forge/pytask).
 
-## 0.2.6 - 2022-xx-xx
+## 0.2.7 - 2022-xx-xx
+
+- {pull}`308` replaces pydot with pygraphviz.
+- {pull}`318` Clarifies an example on nested dependencies and products.
+- {pull}`321` converts more choice options to enums.
+
+## 0.2.6 - 2022-10-27
 
 - {pull}`297` moves non-hook functions from `warnings.py` to `warnings_utils.py` and
   publishes them so that pytask-parallel can import them.

src/_pytask/capture.py

@@ -55,7 +55,7 @@ def final(f):
         return f
 
 
-class _CaptureMethod(Enum):
+class _CaptureMethod(str, Enum):
     FD = "fd"
     NO = "no"
     SYS = "sys"
@@ -68,7 +68,7 @@ def pytask_extend_command_line_interface(cli: click.Group) -> None:
     additional_parameters = [
         click.Option(
             ["--capture"],
-            type=click.Choice([x.value for x in _CaptureMethod]),
+            type=click.Choice(_CaptureMethod),  # type: ignore[arg-type]
             help="Per task capturing method. [dim]\\[default: fd][/]",
         ),
         click.Option(
@@ -78,7 +78,7 @@ def pytask_extend_command_line_interface(cli: click.Group) -> None:
         ),
         click.Option(
             ["--show-capture"],
-            type=click.Choice([x.value for x in ShowCapture]),
+            type=click.Choice(ShowCapture),  # type: ignore[arg-type]
             help=(
                 "Choose which captured output should be shown for failed tasks. "
                 "[dim]\\[default: all][/]"

src/_pytask/clean.py

@@ -4,6 +4,7 @@
 import itertools
 import shutil
 import sys
+from enum import Enum
 from pathlib import Path
 from types import TracebackType
 from typing import Any
@@ -39,6 +40,12 @@
     from typing import NoReturn
 
 
+class _CleanMode(str, Enum):
+    DRY_RUN = "dry-run"
+    FORCE = "force"
+    INTERACTIVE = "interactive"
+
+
 _DEFAULT_EXCLUDE: list[str] = [".git/*", ".hg/*", ".svn/*"]
 
 
@@ -68,7 +75,7 @@ def pytask_parse_config(
     config["exclude"] = (
         to_list(cli_excludes or []) + to_list(file_excludes or []) + _DEFAULT_EXCLUDE
     )
-    config["mode"] = config_from_cli.get("mode", "dry-run")
+    config["mode"] = config_from_cli.get("mode", _CleanMode.DRY_RUN)
     config["quiet"] = get_first_non_none_value(
         config_from_cli, key="quiet", default=False
     )
@@ -92,8 +99,8 @@ def pytask_parse_config(
 )
 @click.option(
     "--mode",
-    default="dry-run",
-    type=click.Choice(["dry-run", "interactive", "force"]),
+    default=_CleanMode.DRY_RUN,
+    type=click.Choice(_CleanMode),  # type: ignore[arg-type]
     help=_HELP_TEXT_MODE,
 )
 @click.option(
@@ -147,12 +154,12 @@ def clean(**config_from_cli: Any) -> NoReturn:
                 console.print(f"\n{targets} which can be removed:\n")
                 for path in unknown_paths:
                     short_path = relative_to(path, common_ancestor)
-                    if session.config["mode"] == "dry-run":
+                    if session.config["mode"] == _CleanMode.DRY_RUN:
                         console.print(f"Would remove {short_path}")
                     else:
                         should_be_deleted = session.config[
                             "mode"
-                        ] == "force" or click.confirm(
+                        ] == _CleanMode.FORCE or click.confirm(
                             f"Would you like to remove {short_path}?"
                         )
                         if should_be_deleted:

src/_pytask/config_utils.py

@@ -29,7 +29,7 @@ def _parse(x: Enum | str | None) -> Enum | None:
     return _parse
 
 
-class ShowCapture(Enum):
+class ShowCapture(str, Enum):
     NO = "no"
     STDOUT = "stdout"
     STDERR = "stderr"

src/_pytask/database.py

@@ -15,7 +15,7 @@
 from pony import orm
 
 
-class _DatabaseProviders(Enum):
+class _DatabaseProviders(str, Enum):
     SQLITE = "sqlite"
     POSTGRES = "postgres"
     MYSQL = "mysql"
@@ -71,7 +71,7 @@ def pytask_extend_command_line_interface(cli: click.Group) -> None:
     additional_parameters = [
         click.Option(
             ["--database-provider"],
-            type=click.Choice([x.value for x in _DatabaseProviders]),
+            type=click.Choice(_DatabaseProviders),  # type: ignore[arg-type]
             help=(
                 "Database provider. All providers except sqlite are considered "
                 "experimental. [dim]\\[default: sqlite][/]"

src/_pytask/graph.py

@@ -32,7 +32,7 @@
     from typing import NoReturn
 
 
-class _RankDirection(Enum):
+class _RankDirection(str, Enum):
     TB = "TB"
     LR = "LR"
     BT = "BT"
@@ -99,7 +99,7 @@ def pytask_parse_config(
 @click.option(
     "-r",
     "--rank-direction",
-    type=click.Choice([x.value for x in _RankDirection]),
+    type=click.Choice(_RankDirection),  # type: ignore[arg-type]
     help=_HELP_TEXT_RANK_DIRECTION,
 )
 def dag(**config_from_cli: Any) -> NoReturn:

src/_pytask/profile.py

@@ -39,7 +39,7 @@
     from typing import NoReturn
 
 
-class _ExportFormats(Enum):
+class _ExportFormats(str, Enum):
     NO = "no"
     JSON = "json"
     CSV = "csv"
@@ -113,7 +113,7 @@ def _create_or_update_runtime(task_name: str, start: float, end: float) -> None:
 @click.command(cls=ColoredCommand)
 @click.option(
     "--export",
-    type=click.Choice([x.value for x in _ExportFormats]),
+    type=click.Choice(_ExportFormats),  # type: ignore[arg-type]
     default=None,
     help="Export the profile in the specified format. [dim]\\[default: no][/]",
 )