chore: Update pyproject.toml (#243)

* Allow ruff to add future annotations

* chore: auto fixes from pre-commit.com hooks

* Move TYPE_CHECKING

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

Author: cidrblock

pyproject.toml

@@ -340,6 +340,7 @@ parametrize-values-type = "tuple"
 known-first-party = ["ansible_dev_environment"]
 lines-after-imports = 2 # Ensures consistency for cases when there's variable vs function/class definitions after imports
 lines-between-types = 1 # Separate import/from with 1 line
+required-imports = ["from __future__ import annotations"]
 
 [tool.ruff.lint.per-file-ignores]
 "_version.py" = ["SIM108"]

src/ansible_dev_environment/__main__.py

@@ -4,6 +4,8 @@
 via :command:`python -m ansible_dev_environment`.
 """
 
+from __future__ import annotations
+
 from ansible_dev_environment.cli import main
 
 

src/ansible_dev_environment/subcommands/__init__.py

@@ -1,6 +1,7 @@
 """The subcommands module contains all the subcommands for ansible-dev-environment."""
 
 # ruff: noqa: F401
+from __future__ import annotations
 
 from .checker import Checker as Check
 from .inspector import Inspector as Inspect

tests/conftest.py

@@ -16,15 +16,17 @@
 Tracing '/**/src/<package>/__init__.py'
 """
 
+from __future__ import annotations
+
 import json
 import os
 import shutil
 import tarfile
 import tempfile
 import warnings
 
-from collections.abc import Generator
 from pathlib import Path
+from typing import TYPE_CHECKING
 from urllib.request import HTTPError, urlopen
 
 import pytest
@@ -33,7 +35,12 @@
 import ansible_dev_environment  # noqa: F401
 
 from ansible_dev_environment.cli import Cli
-from ansible_dev_environment.config import Config
+
+
+if TYPE_CHECKING:
+    from collections.abc import Generator
+
+    from ansible_dev_environment.config import Config
 
 
 GALAXY_CACHE = Path(__file__).parent.parent / ".cache" / ".galaxy_cache"

tests/integration/test_basic.py

@@ -1,5 +1,7 @@
 """Basic smoke tests."""
 
+from __future__ import annotations
+
 import json
 
 from pathlib import Path

tests/test_argparser.py

@@ -1,5 +1,7 @@
 """Tests for the arg_parser module."""
 
+from __future__ import annotations
+
 import pytest
 
 from ansible_dev_environment.arg_parser import (

tests/unit/test_cli.py

@@ -1,13 +1,19 @@
 """Test cli functionality."""
 
-from collections.abc import Generator
+from __future__ import annotations
+
 from pathlib import Path
+from typing import TYPE_CHECKING
 
 import pytest
 
 from ansible_dev_environment.cli import Cli
 
 
+if TYPE_CHECKING:
+    from collections.abc import Generator
+
+
 def main(cli: Cli) -> None:
     """Stub main function for testing.
 

tests/unit/test_inspector.py

@@ -1,17 +1,24 @@
 """Tests for the inspector module."""
 
+from __future__ import annotations
+
 import copy
 import importlib
 import json
 import re
 import sys
 
-import pytest
+from typing import TYPE_CHECKING
 
-from ansible_dev_environment.config import Config
 from ansible_dev_environment.subcommands import inspector
 
 
+if TYPE_CHECKING:
+    import pytest
+
+    from ansible_dev_environment.config import Config
+
+
 def test_output_no_color(session_venv: Config, capsys: pytest.CaptureFixture[str]) -> None:
     """Test the inspector output.
 

tests/unit/test_installer.py

@@ -1,26 +1,30 @@
 # pylint: disable=C0302
 """Tests for the installer."""
+from __future__ import annotations
 
 import os
 import shutil
 import subprocess
 
 from argparse import Namespace
 from pathlib import Path
-from typing import Any
+from typing import TYPE_CHECKING, Any
 
 import pytest
 import yaml
 
 from ansible_dev_environment.arg_parser import parse
 from ansible_dev_environment.cli import Cli
-from ansible_dev_environment.collection import Collection
 from ansible_dev_environment.config import Config
-from ansible_dev_environment.output import Output
 from ansible_dev_environment.subcommands.installer import Installer
 from ansible_dev_environment.utils import subprocess_run
 
 
+if TYPE_CHECKING:
+    from ansible_dev_environment.collection import Collection
+    from ansible_dev_environment.output import Output
+
+
 NAMESPACE = Namespace()
 NAMESPACE.verbose = 0
 

tests/unit/test_lister.py

@@ -1,21 +1,29 @@
 """Test the lister module."""
 
+from __future__ import annotations
+
 import copy
 import tarfile
 
-from pathlib import Path
+from typing import TYPE_CHECKING
 
-import pytest
 import yaml
 
 from ansible_dev_environment.arg_parser import parse
 from ansible_dev_environment.config import Config
-from ansible_dev_environment.output import Output
 from ansible_dev_environment.subcommands.installer import Installer
 from ansible_dev_environment.subcommands.lister import Lister
 from ansible_dev_environment.utils import JSONVal, collect_manifests
 
 
+if TYPE_CHECKING:
+    from pathlib import Path
+
+    import pytest
+
+    from ansible_dev_environment.output import Output
+
+
 def test_success(session_venv: Config, capsys: pytest.CaptureFixture[str]) -> None:
     """Test the lister.
 

tests/unit/test_main.py

@@ -1,5 +1,7 @@
 """Test the main file."""
 
+from __future__ import annotations
+
 import runpy
 
 import pytest

tests/unit/test_treemaker.py

@@ -1,15 +1,22 @@
 """Test the treemaker module."""
 
+from __future__ import annotations
+
 from argparse import Namespace
-from pathlib import Path
+from typing import TYPE_CHECKING
 from venv import EnvBuilder
 
 import pytest
 
 from ansible_dev_environment.config import Config
-from ansible_dev_environment.output import Output
 from ansible_dev_environment.subcommands.treemaker import TreeMaker, TreeWithReqs, add_python_reqs
-from ansible_dev_environment.utils import JSONVal
+
+
+if TYPE_CHECKING:
+    from pathlib import Path
+
+    from ansible_dev_environment.output import Output
+    from ansible_dev_environment.utils import JSONVal
 
 
 def test_tree_empty(

tests/unit/test_uninstaller.py

@@ -1,18 +1,25 @@
 """Test the uninstaller module."""
 
+from __future__ import annotations
+
 import copy
 
-from pathlib import Path
+from typing import TYPE_CHECKING
 
 import pytest
 
 from ansible_dev_environment.arg_parser import parse
 from ansible_dev_environment.config import Config
-from ansible_dev_environment.output import Output
 from ansible_dev_environment.subcommands.installer import Installer
 from ansible_dev_environment.subcommands.uninstaller import UnInstaller
 
 
+if TYPE_CHECKING:
+    from pathlib import Path
+
+    from ansible_dev_environment.output import Output
+
+
 def test_many(session_venv: Config, capsys: pytest.CaptureFixture[str]) -> None:
     """Test the uninstaller with many collections.