Add future annotations (#276)

Author: cidrblock

pyproject.toml

@@ -349,6 +349,7 @@ parametrize-values-type = "tuple"
 known-first-party = ["ansible_creator"]
 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_creator/__main__.py

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

src/ansible_creator/compat.py

@@ -5,6 +5,8 @@
 here.
 """
 
+from __future__ import annotations
+
 import sys
 
 

src/ansible_creator/constants.py

@@ -1,5 +1,8 @@
 """Definition of constants for this package."""
 
+from __future__ import annotations
+
+
 GLOBAL_TEMPLATE_VARS = {
     "DEV_CONTAINER_IMAGE": "ghcr.io/ansible/community-ansible-dev-tools:latest",
     "DEV_FILE_IMAGE": "ghcr.io/ansible/ansible-workspace-env-reference:latest",

src/ansible_creator/types.py

@@ -1,11 +1,17 @@
 """A home for shared types."""
 
-from collections.abc import Sequence
+from __future__ import annotations
+
 from dataclasses import dataclass, field
+from typing import TYPE_CHECKING
 
 from ansible_creator.constants import GLOBAL_TEMPLATE_VARS
 
 
+if TYPE_CHECKING:
+    from collections.abc import Sequence
+
+
 @dataclass
 class TemplateData:
     """Dataclass representing the template data.

tests/defaults.py

@@ -1,5 +1,7 @@
 """Constants with default values used throughout the tests."""
 
+from __future__ import annotations
+
 from pathlib import Path
 
 

tests/units/test_compat.py

@@ -1,5 +1,7 @@
 """Tests for compat module."""
 
+from __future__ import annotations
+
 from ansible_creator.compat import Traversable
 
 

tests/units/test_templar.py

@@ -1,5 +1,7 @@
 """Tests for templar."""
 
+from __future__ import annotations
+
 from ansible_creator.templar import Templar
 from ansible_creator.types import TemplateData
 

tests/units/test_utils.py

@@ -1,14 +1,20 @@
 """Test the utils module."""
 
-from pathlib import Path
+from __future__ import annotations
 
-import pytest
+from pathlib import Path
+from typing import TYPE_CHECKING
 
-from ansible_creator.output import Output
 from ansible_creator.types import TemplateData
 from ansible_creator.utils import Copier, expand_path
 
 
+if TYPE_CHECKING:
+    import pytest
+
+    from ansible_creator.output import Output
+
+
 def test_expand_path() -> None:
     """Test expand_path utils."""
     home = Path.home().resolve()