Fix typing for Python 3.9 for Typer

Author: dgarros

infrahub_sdk/ctl/check.py

@@ -5,7 +5,7 @@
 from asyncio import run as aiorun
 from dataclasses import dataclass
 from pathlib import Path
-from typing import TYPE_CHECKING
+from typing import TYPE_CHECKING, Optional
 
 import typer
 from rich.console import Console
@@ -50,8 +50,8 @@ def run(
     format_json: bool,
     list_available: bool,
     variables: dict[str, str],
-    name: str | None = None,
-    branch: str | None = None,
+    name: Optional[str] = None,
+    branch: Optional[str] = None,
 ) -> None:
     """Locate and execute all checks under the defined path."""
 
@@ -88,7 +88,7 @@ async def run_check(
     format_json: bool,
     path: str,
     repository_config: InfrahubRepositoryConfig,
-    branch: str | None = None,
+    branch: Optional[str] = None,
     params: dict | None = None,
 ) -> bool:
     module_name = check_module.name
@@ -135,7 +135,7 @@ async def run_targeted_check(
     path: str,
     repository_config: InfrahubRepositoryConfig,
     variables: dict[str, str],
-    branch: str | None = None,
+    branch: Optional[str] = None,
 ) -> bool:
     filters = {}
     param_value = list(check_module.definition.parameters.values())
@@ -187,7 +187,7 @@ async def run_checks(
     path: str,
     variables: dict[str, str],
     repository_config: InfrahubRepositoryConfig,
-    branch: str | None = None,
+    branch: Optional[str] = None,
 ) -> None:
     log = logging.getLogger("infrahub")
 

infrahub_sdk/ctl/cli_commands.py

@@ -7,7 +7,7 @@
 import platform
 import sys
 from pathlib import Path
-from typing import TYPE_CHECKING, Any, Callable
+from typing import TYPE_CHECKING, Any, Callable, Optional
 
 import jinja2
 import typer
@@ -74,13 +74,13 @@
 @catch_exception(console=console)
 def check(
     check_name: str = typer.Argument(default="", help="Name of the Python check"),
-    branch: str | None = None,
+    branch: Optional[str] = None,
     path: str = typer.Option(".", help="Root directory"),
     debug: bool = False,
     format_json: bool = False,
     _: str = CONFIG_PARAM,
     list_available: bool = typer.Option(False, "--list", help="Show available Python checks"),
-    variables: list[str] | None = typer.Argument(
+    variables: Optional[list[str]] = typer.Argument(
         None, help="Variables to pass along with the query. Format key=value key=value."
     ),
 ) -> None:
@@ -102,12 +102,12 @@ def check(
 @catch_exception(console=console)
 async def generator(
     generator_name: str = typer.Argument(default="", help="Name of the Generator"),
-    branch: str | None = None,
+    branch: Optional[str] = None,
     path: str = typer.Option(".", help="Root directory"),
     debug: bool = False,
     _: str = CONFIG_PARAM,
     list_available: bool = typer.Option(False, "--list", help="Show available Generators"),
-    variables: list[str] | None = typer.Argument(
+    variables: Optional[list[str]] = typer.Argument(
         None, help="Variables to pass along with the query. Format key=value key=value."
     ),
 ) -> None:
@@ -130,13 +130,13 @@ async def run(
     debug: bool = False,
     _: str = CONFIG_PARAM,
     branch: str = typer.Option("main", help="Branch on which to run the script."),  # TODO: Replace main by None
-    concurrent: int | None = typer.Option(
+    concurrent: Optional[int] = typer.Option(
         None,
         help="Maximum number of requests to execute at the same time.",
         envvar="INFRAHUB_MAX_CONCURRENT_EXECUTION",
     ),
     timeout: int = typer.Option(60, help="Timeout in sec", envvar="INFRAHUB_TIMEOUT"),
-    variables: list[str] | None = typer.Argument(
+    variables: Optional[list[str]] = typer.Argument(
         None, help="Variables to pass along with the query. Format key=value key=value."
     ),
 ) -> None:
@@ -259,7 +259,7 @@ def _run_transform(
 @catch_exception(console=console)
 def render(
     transform_name: str = typer.Argument(default="", help="Name of the Python transformation", show_default=False),
-    variables: list[str] | None = typer.Argument(
+    variables: Optional[list[str]] = typer.Argument(
         None, help="Variables to pass along with the query. Format key=value key=value."
     ),
     branch: str = typer.Option(None, help="Branch on which to render the transform."),
@@ -309,7 +309,7 @@ def render(
 @catch_exception(console=console)
 def transform(
     transform_name: str = typer.Argument(default="", help="Name of the Python transformation", show_default=False),
-    variables: list[str] | None = typer.Argument(
+    variables: Optional[list[str]] = typer.Argument(
         None, help="Variables to pass along with the query. Format key=value key=value."
     ),
     branch: str = typer.Option(None, help="Branch on which to run the transformation"),

infrahub_sdk/ctl/generator.py

@@ -1,7 +1,7 @@
 from __future__ import annotations
 
 from pathlib import Path
-from typing import TYPE_CHECKING
+from typing import TYPE_CHECKING, Optional
 
 import typer
 from rich.console import Console
@@ -23,7 +23,7 @@ async def run(
     debug: bool,  # noqa: ARG001
     list_available: bool,
     branch: str | None = None,
-    variables: list[str] | None = None,
+    variables: Optional[list[str]] = None,
 ) -> None:
     repository_config = get_repository_config(Path(config.INFRAHUB_REPO_CONFIG_FILE))
 

infrahub_sdk/ctl/importer.py

@@ -2,6 +2,7 @@
 
 from asyncio import run as aiorun
 from pathlib import Path
+from typing import Optional
 
 import typer
 from rich.console import Console
@@ -26,7 +27,7 @@ def load(
     quiet: bool = typer.Option(False, help="No console output"),
     _: str = CONFIG_PARAM,
     branch: str = typer.Option("main", help="Branch from which to export"),  # TODO: Replace main by None
-    concurrent: int | None = typer.Option(
+    concurrent: Optional[int] = typer.Option(
         None,
         help="Maximum number of requests to execute at the same time.",
         envvar="INFRAHUB_MAX_CONCURRENT_EXECUTION",

infrahub_sdk/ctl/repository.py

@@ -1,6 +1,7 @@
 from __future__ import annotations
 
 from pathlib import Path
+from typing import Optional
 
 import typer
 import yaml
@@ -68,7 +69,7 @@ async def add(
     name: str,
     location: str,
     description: str = "",
-    username: str | None = None,
+    username: Optional[str] = None,
     password: str = "",
     ref: str = "",
     read_only: bool = False,
@@ -115,7 +116,7 @@ async def add(
 
 @app.command()
 async def list(
-    branch: str | None = None,
+    branch: Optional[str] = None,
     debug: bool = False,
     _: str = CONFIG_PARAM,
 ) -> None:

infrahub_sdk/ctl/utils.py

@@ -6,7 +6,7 @@
 from collections.abc import Coroutine
 from functools import wraps
 from pathlib import Path
-from typing import TYPE_CHECKING, Any, Callable, NoReturn, TypeVar
+from typing import TYPE_CHECKING, Any, Callable, NoReturn, Optional, TypeVar
 
 import pendulum
 import typer
@@ -145,7 +145,7 @@ def print_graphql_errors(console: Console, errors: list) -> None:
             console.print(f"[red]{escape(str(error))}")
 
 
-def parse_cli_vars(variables: list[str] | None) -> dict[str, str]:
+def parse_cli_vars(variables: Optional[list[str]]) -> dict[str, str]:
     if not variables:
         return {}
 

infrahub_sdk/ctl/validate.py

@@ -2,6 +2,7 @@
 
 import sys
 from pathlib import Path
+from typing import Optional
 
 import typer
 import ujson
@@ -57,7 +58,7 @@ async def validate_schema(schema: Path, _: str = CONFIG_PARAM) -> None:
 @catch_exception(console=console)
 def validate_graphql(
     query: str,
-    variables: list[str] | None = typer.Argument(
+    variables: Optional[list[str]] = typer.Argument(
         None, help="Variables to pass along with the query. Format key=value key=value."
     ),
     debug: bool = typer.Option(False, help="Display more troubleshooting information."),

pyproject.toml

@@ -248,6 +248,10 @@ max-complexity = 17
     "ANN401", # Dynamically typed expressions (typing.Any) are disallowed
 ]
 
+"infrahub_sdk/ctl/**/*.py" = [
+    "UP007",  # Use `X | Y` for type annotations
+]
+
 "infrahub_sdk/client.py" = [
     ##################################################################################################
     # Review and change the below later                                                              #

tests/unit/ctl/test_cli.py

@@ -10,7 +10,6 @@
 requires_python_310 = pytest.mark.skipif(sys.version_info < (3, 10), reason="Requires Python 3.10 or higher")
 
 
-@requires_python_310
 def test_main_app():
     result = runner.invoke(app, ["--help"])
     assert result.exit_code == 0
@@ -29,29 +28,25 @@ def test_validate_all_groups_have_names():
         assert group.name
 
 
-@requires_python_310
 def test_version_command():
     result = runner.invoke(app, ["version"])
     assert result.exit_code == 0
     assert "Python SDK: v" in result.stdout
 
 
-@requires_python_310
 def test_info_command_success(mock_query_infrahub_version, mock_query_infrahub_user):
     result = runner.invoke(app, ["info"])
     assert result.exit_code == 0
     for expected in ["Connection Status", "Python Version", "SDK Version", "Infrahub Version"]:
         assert expected in result.stdout, f"'{expected}' not found in info command output"
 
 
-@requires_python_310
 def test_info_command_failure():
     result = runner.invoke(app, ["info"])
     assert result.exit_code == 0
     assert "Connection Error" in result.stdout
 
 
-@requires_python_310
 def test_info_detail_command_success(mock_query_infrahub_version, mock_query_infrahub_user):
     result = runner.invoke(app, ["info", "--detail"])
     assert result.exit_code == 0
@@ -65,7 +60,6 @@ def test_info_detail_command_success(mock_query_infrahub_version, mock_query_inf
         assert expected in result.stdout, f"'{expected}' not found in detailed info command output"
 
 
-@requires_python_310
 def test_info_detail_command_failure():
     result = runner.invoke(app, ["info", "--detail"])
     assert result.exit_code == 0

tests/unit/ctl/test_repository_app.py

@@ -333,6 +333,8 @@ def test_repo_description_commit_branch(self, mock_init_client, mock_client) ->
             tracker="mutation-repository-create",
         )
 
+    @requires_python_310
+    @mock.patch("infrahub_sdk.ctl.repository.initialize_client")
     def test_repo_list(self, mock_repositories_list) -> None:
         result = runner.invoke(app, ["repository", "list", "--branch", "main"])
         assert result.exit_code == 0