Upgrade typer to support union types (#533)

docs/docs/user/references/cli-commands.md

@@ -43,7 +43,7 @@ $ kpops clean [OPTIONS] PIPELINE_PATHS...
 * `--dotenv FILE`: Path to dotenv file. Multiple files can be provided. The files will be loaded in order, with each file overriding the previous one.  [env var: KPOPS_DOTENV_PATH]
 * `--config DIRECTORY`: Path to the dir containing config.yaml files  [env var: KPOPS_CONFIG_PATH; default: .]
 * `--steps TEXT`: Comma separated list of steps to apply the command on  [env var: KPOPS_PIPELINE_STEPS]
-* `--filter-type [include|exclude]`: Whether the --steps option should include/exclude the steps  [default: FilterType.INCLUDE]
+* `--filter-type [include|exclude]`: Whether the --steps option should include/exclude the steps  [default: include]
 * `--environment TEXT`: The environment you want to generate and deploy the pipeline to. Suffix your environment files with this value (e.g. defaults_development.yaml for environment=development).   [env var: KPOPS_ENVIRONMENT]
 * `--dry-run / --execute`: Whether to dry run the command or execute it  [default: dry-run]
 * `--verbose / --no-verbose`: Enable verbose printing  [default: no-verbose]
@@ -69,7 +69,7 @@ $ kpops deploy [OPTIONS] PIPELINE_PATHS...
 * `--dotenv FILE`: Path to dotenv file. Multiple files can be provided. The files will be loaded in order, with each file overriding the previous one.  [env var: KPOPS_DOTENV_PATH]
 * `--config DIRECTORY`: Path to the dir containing config.yaml files  [env var: KPOPS_CONFIG_PATH; default: .]
 * `--steps TEXT`: Comma separated list of steps to apply the command on  [env var: KPOPS_PIPELINE_STEPS]
-* `--filter-type [include|exclude]`: Whether the --steps option should include/exclude the steps  [default: FilterType.INCLUDE]
+* `--filter-type [include|exclude]`: Whether the --steps option should include/exclude the steps  [default: include]
 * `--environment TEXT`: The environment you want to generate and deploy the pipeline to. Suffix your environment files with this value (e.g. defaults_development.yaml for environment=development).   [env var: KPOPS_ENVIRONMENT]
 * `--dry-run / --execute`: Whether to dry run the command or execute it  [default: dry-run]
 * `--verbose / --no-verbose`: Enable verbose printing  [default: no-verbose]
@@ -95,7 +95,7 @@ $ kpops destroy [OPTIONS] PIPELINE_PATHS...
 * `--dotenv FILE`: Path to dotenv file. Multiple files can be provided. The files will be loaded in order, with each file overriding the previous one.  [env var: KPOPS_DOTENV_PATH]
 * `--config DIRECTORY`: Path to the dir containing config.yaml files  [env var: KPOPS_CONFIG_PATH; default: .]
 * `--steps TEXT`: Comma separated list of steps to apply the command on  [env var: KPOPS_PIPELINE_STEPS]
-* `--filter-type [include|exclude]`: Whether the --steps option should include/exclude the steps  [default: FilterType.INCLUDE]
+* `--filter-type [include|exclude]`: Whether the --steps option should include/exclude the steps  [default: include]
 * `--environment TEXT`: The environment you want to generate and deploy the pipeline to. Suffix your environment files with this value (e.g. defaults_development.yaml for environment=development).   [env var: KPOPS_ENVIRONMENT]
 * `--dry-run / --execute`: Whether to dry run the command or execute it  [default: dry-run]
 * `--verbose / --no-verbose`: Enable verbose printing  [default: no-verbose]
@@ -121,7 +121,7 @@ $ kpops generate [OPTIONS] PIPELINE_PATHS...
 * `--dotenv FILE`: Path to dotenv file. Multiple files can be provided. The files will be loaded in order, with each file overriding the previous one.  [env var: KPOPS_DOTENV_PATH]
 * `--config DIRECTORY`: Path to the dir containing config.yaml files  [env var: KPOPS_CONFIG_PATH; default: .]
 * `--steps TEXT`: Comma separated list of steps to apply the command on  [env var: KPOPS_PIPELINE_STEPS]
-* `--filter-type [include|exclude]`: Whether the --steps option should include/exclude the steps  [default: FilterType.INCLUDE]
+* `--filter-type [include|exclude]`: Whether the --steps option should include/exclude the steps  [default: include]
 * `--environment TEXT`: The environment you want to generate and deploy the pipeline to. Suffix your environment files with this value (e.g. defaults_development.yaml for environment=development).   [env var: KPOPS_ENVIRONMENT]
 * `--verbose / --no-verbose`: Enable verbose printing  [default: no-verbose]
 * `--help`: Show this message and exit.
@@ -164,7 +164,7 @@ $ kpops manifest [OPTIONS] PIPELINE_PATHS...
 * `--dotenv FILE`: Path to dotenv file. Multiple files can be provided. The files will be loaded in order, with each file overriding the previous one.  [env var: KPOPS_DOTENV_PATH]
 * `--config DIRECTORY`: Path to the dir containing config.yaml files  [env var: KPOPS_CONFIG_PATH; default: .]
 * `--steps TEXT`: Comma separated list of steps to apply the command on  [env var: KPOPS_PIPELINE_STEPS]
-* `--filter-type [include|exclude]`: Whether the --steps option should include/exclude the steps  [default: FilterType.INCLUDE]
+* `--filter-type [include|exclude]`: Whether the --steps option should include/exclude the steps  [default: include]
 * `--environment TEXT`: The environment you want to generate and deploy the pipeline to. Suffix your environment files with this value (e.g. defaults_development.yaml for environment=development).   [env var: KPOPS_ENVIRONMENT]
 * `--verbose / --no-verbose`: Enable verbose printing  [default: no-verbose]
 * `--help`: Show this message and exit.
@@ -188,7 +188,7 @@ $ kpops reset [OPTIONS] PIPELINE_PATHS...
 * `--dotenv FILE`: Path to dotenv file. Multiple files can be provided. The files will be loaded in order, with each file overriding the previous one.  [env var: KPOPS_DOTENV_PATH]
 * `--config DIRECTORY`: Path to the dir containing config.yaml files  [env var: KPOPS_CONFIG_PATH; default: .]
 * `--steps TEXT`: Comma separated list of steps to apply the command on  [env var: KPOPS_PIPELINE_STEPS]
-* `--filter-type [include|exclude]`: Whether the --steps option should include/exclude the steps  [default: FilterType.INCLUDE]
+* `--filter-type [include|exclude]`: Whether the --steps option should include/exclude the steps  [default: include]
 * `--environment TEXT`: The environment you want to generate and deploy the pipeline to. Suffix your environment files with this value (e.g. defaults_development.yaml for environment=development).   [env var: KPOPS_ENVIRONMENT]
 * `--dry-run / --execute`: Whether to dry run the command or execute it  [default: dry-run]
 * `--verbose / --no-verbose`: Enable verbose printing  [default: no-verbose]

kpops/cli/main.py

@@ -1,7 +1,6 @@
 from __future__ import annotations
 
 from pathlib import Path
-from typing import Optional
 
 import typer
 
@@ -27,7 +26,7 @@
 
 app = typer.Typer(pretty_exceptions_enable=False)
 
-DOTENV_PATH_OPTION: Optional[list[Path]] = typer.Option(
+DOTENV_PATH_OPTION: list[Path] | None = typer.Option(
     default=None,
     exists=True,
     dir_okay=False,
@@ -74,7 +73,7 @@
     help="Whether to include non-required settings in the generated 'config.yaml'",
 )
 
-PIPELINE_STEPS: Optional[str] = typer.Option(
+PIPELINE_STEPS: str | None = typer.Option(
     default=None,
     envvar=f"{ENV_PREFIX}PIPELINE_STEPS",
     help="Comma separated list of steps to apply the command on",
@@ -100,8 +99,8 @@
     help="Whether the --steps option should include/exclude the steps",
 )
 
-OUTPUT_OPTION = typer.Option(True, help="Enable output printing")
-VERBOSE_OPTION = typer.Option(False, help="Enable verbose printing")
+OUTPUT_OPTION: bool = typer.Option(True, help="Enable output printing")
+VERBOSE_OPTION: bool = typer.Option(False, help="Enable verbose printing")
 
 ENVIRONMENT: str | None = typer.Option(
     default=None,
@@ -161,11 +160,11 @@ def schema(
 )
 def generate(
     pipeline_paths: list[Path] = PIPELINE_PATHS_ARG,
-    dotenv: Optional[list[Path]] = DOTENV_PATH_OPTION,
+    dotenv: list[Path] | None = DOTENV_PATH_OPTION,
     config: Path = CONFIG_PATH_OPTION,
-    steps: Optional[str] = PIPELINE_STEPS,
+    steps: str | None = PIPELINE_STEPS,
     filter_type: FilterType = FILTER_TYPE,
-    environment: Optional[str] = ENVIRONMENT,
+    environment: str | None = ENVIRONMENT,
     verbose: bool = VERBOSE_OPTION,
 ):
     for pipeline_file_path in collect_pipeline_paths(pipeline_paths):
@@ -187,11 +186,11 @@ def generate(
 )
 def manifest(
     pipeline_paths: list[Path] = PIPELINE_PATHS_ARG,
-    dotenv: Optional[list[Path]] = DOTENV_PATH_OPTION,
+    dotenv: list[Path] | None = DOTENV_PATH_OPTION,
     config: Path = CONFIG_PATH_OPTION,
-    steps: Optional[str] = PIPELINE_STEPS,
+    steps: str | None = PIPELINE_STEPS,
     filter_type: FilterType = FILTER_TYPE,
-    environment: Optional[str] = ENVIRONMENT,
+    environment: str | None = ENVIRONMENT,
     verbose: bool = VERBOSE_OPTION,
 ):
     for pipeline_file_path in collect_pipeline_paths(pipeline_paths):
@@ -212,11 +211,11 @@ def manifest(
 @app.command(help="Deploy pipeline steps")
 def deploy(
     pipeline_paths: list[Path] = PIPELINE_PATHS_ARG,
-    dotenv: Optional[list[Path]] = DOTENV_PATH_OPTION,
+    dotenv: list[Path] | None = DOTENV_PATH_OPTION,
     config: Path = CONFIG_PATH_OPTION,
-    steps: Optional[str] = PIPELINE_STEPS,
+    steps: str | None = PIPELINE_STEPS,
     filter_type: FilterType = FILTER_TYPE,
-    environment: Optional[str] = ENVIRONMENT,
+    environment: str | None = ENVIRONMENT,
     dry_run: bool = DRY_RUN,
     verbose: bool = VERBOSE_OPTION,
     parallel: bool = PARALLEL,
@@ -238,11 +237,11 @@ def deploy(
 @app.command(help="Destroy pipeline steps")
 def destroy(
     pipeline_paths: list[Path] = PIPELINE_PATHS_ARG,
-    dotenv: Optional[list[Path]] = DOTENV_PATH_OPTION,
+    dotenv: list[Path] | None = DOTENV_PATH_OPTION,
     config: Path = CONFIG_PATH_OPTION,
-    steps: Optional[str] = PIPELINE_STEPS,
+    steps: str | None = PIPELINE_STEPS,
     filter_type: FilterType = FILTER_TYPE,
-    environment: Optional[str] = ENVIRONMENT,
+    environment: str | None = ENVIRONMENT,
     dry_run: bool = DRY_RUN,
     verbose: bool = VERBOSE_OPTION,
     parallel: bool = PARALLEL,
@@ -264,11 +263,11 @@ def destroy(
 @app.command(help="Reset pipeline steps")
 def reset(
     pipeline_paths: list[Path] = PIPELINE_PATHS_ARG,
-    dotenv: Optional[list[Path]] = DOTENV_PATH_OPTION,
+    dotenv: list[Path] | None = DOTENV_PATH_OPTION,
     config: Path = CONFIG_PATH_OPTION,
-    steps: Optional[str] = PIPELINE_STEPS,
+    steps: str | None = PIPELINE_STEPS,
     filter_type: FilterType = FILTER_TYPE,
-    environment: Optional[str] = ENVIRONMENT,
+    environment: str | None = ENVIRONMENT,
     dry_run: bool = DRY_RUN,
     verbose: bool = VERBOSE_OPTION,
     parallel: bool = PARALLEL,
@@ -290,11 +289,11 @@ def reset(
 @app.command(help="Clean pipeline steps")
 def clean(
     pipeline_paths: list[Path] = PIPELINE_PATHS_ARG,
-    dotenv: Optional[list[Path]] = DOTENV_PATH_OPTION,
+    dotenv: list[Path] | None = DOTENV_PATH_OPTION,
     config: Path = CONFIG_PATH_OPTION,
-    steps: Optional[str] = PIPELINE_STEPS,
+    steps: str | None = PIPELINE_STEPS,
     filter_type: FilterType = FILTER_TYPE,
-    environment: Optional[str] = ENVIRONMENT,
+    environment: str | None = ENVIRONMENT,
     dry_run: bool = DRY_RUN,
     verbose: bool = VERBOSE_OPTION,
     parallel: bool = PARALLEL,