Require future annotations import for tests (I002)

kieran-ryan · kieran-ryan · commit 06bc96e8abd1 · 2024-12-31T19:23:00.000Z
- Applied through ruff `--fix`
- Subsequently simplified optional in `tests/feature/test_report.py`
diff --git a/docs/conf.py b/docs/conf.py
@@ -5,6 +5,7 @@
 
 # -- Project information -----------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+from __future__ import annotations
 
 from importlib import metadata as _metadata
 
diff --git a/pyproject.toml b/pyproject.toml
@@ -73,10 +73,6 @@ lint.isort.required-imports = [
     "from __future__ import annotations",
 ]
 
-[tool.ruff.lint.per-file-ignores]
-# Lint `I002` (required imports) for `from __future__ import annotations` in `src/`
-"!src/**.py" = ["I002"]
-
 [tool.coverage.report]
 exclude_lines = [
     "if TYPE_CHECKING:",
diff --git a/tests/args/cfparse/test_args.py b/tests/args/cfparse/test_args.py
@@ -1,5 +1,7 @@
 """Step arguments tests."""
 
+from __future__ import annotations
+
 import textwrap
 
 
diff --git a/tests/args/parse/test_args.py b/tests/args/parse/test_args.py
@@ -1,5 +1,7 @@
 """Step arguments tests."""
 
+from __future__ import annotations
+
 import textwrap
 
 
diff --git a/tests/args/regex/test_args.py b/tests/args/regex/test_args.py
@@ -1,5 +1,7 @@
 """Step arguments tests."""
 
+from __future__ import annotations
+
 import textwrap
 
 
diff --git a/tests/args/test_common.py b/tests/args/test_common.py
@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import textwrap
 
 from pytest_bdd.utils import collect_dumped_objects
diff --git a/tests/conftest.py b/tests/conftest.py
@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import pytest
 
 pytest_plugins = "pytester"
diff --git a/tests/datatable/test_datatable.py b/tests/datatable/test_datatable.py
@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import textwrap
 
 from src.pytest_bdd.utils import collect_dumped_objects
diff --git a/tests/feature/test_alias.py b/tests/feature/test_alias.py
@@ -1,5 +1,7 @@
 """Test step alias when decorated multiple times."""
 
+from __future__ import annotations
+
 import textwrap
 
 
diff --git a/tests/feature/test_background.py b/tests/feature/test_background.py
@@ -1,5 +1,7 @@
 """Test feature background."""
 
+from __future__ import annotations
+
 import textwrap
 
 FEATURE = '''\
diff --git a/tests/feature/test_description.py b/tests/feature/test_description.py
@@ -1,5 +1,7 @@
 """Test descriptions."""
 
+from __future__ import annotations
+
 import textwrap
 
 
diff --git a/tests/feature/test_feature_base_dir.py b/tests/feature/test_feature_base_dir.py
@@ -1,5 +1,7 @@
 """Test feature base dir."""
 
+from __future__ import annotations
+
 import os
 
 import pytest
diff --git a/tests/feature/test_gherkin_terminal_reporter.py b/tests/feature/test_gherkin_terminal_reporter.py
@@ -200,9 +200,7 @@ def test_step_parameters_should_be_replaced_by_their_values(pytester):
             Examples:
             | start | eat | left |
             |{start}|{eat}|{left}|
-        """.format(
-                **example
-            )
+        """.format(**example)
         ),
     )
     pytester.makepyfile(
diff --git a/tests/feature/test_no_scenario.py b/tests/feature/test_no_scenario.py
@@ -1,5 +1,7 @@
 """Test no scenarios defined in the feature file."""
 
+from __future__ import annotations
+
 import textwrap
 
 
diff --git a/tests/feature/test_outline.py b/tests/feature/test_outline.py
@@ -1,5 +1,7 @@
 """Scenario Outline tests."""
 
+from __future__ import annotations
+
 import textwrap
 
 from pytest_bdd.utils import collect_dumped_objects
diff --git a/tests/feature/test_outline_empty_values.py b/tests/feature/test_outline_empty_values.py
@@ -1,5 +1,7 @@
 """Scenario Outline with empty example values tests."""
 
+from __future__ import annotations
+
 import textwrap
 
 from pytest_bdd.utils import collect_dumped_objects
diff --git a/tests/feature/test_report.py b/tests/feature/test_report.py
@@ -1,7 +1,8 @@
 """Test scenario reporting."""
 
+from __future__ import annotations
+
 import textwrap
-from typing import Optional
 
 import pytest
 
@@ -11,7 +12,7 @@
 class OfType:
     """Helper object comparison to which is always 'equal'."""
 
-    def __init__(self, type: Optional[type] = None) -> None:
+    def __init__(self, type: type | None = None) -> None:
         self.type = type
 
     def __eq__(self, other: object) -> bool:
diff --git a/tests/feature/test_rule_example_format.py b/tests/feature/test_rule_example_format.py
@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import textwrap
 
 
diff --git a/tests/feature/test_same_function_name.py b/tests/feature/test_same_function_name.py
@@ -1,5 +1,7 @@
 """Function name same as step name."""
 
+from __future__ import annotations
+
 import textwrap
 
 
diff --git a/tests/feature/test_scenario.py b/tests/feature/test_scenario.py
@@ -1,5 +1,7 @@
 """Test scenario decorator."""
 
+from __future__ import annotations
+
 import textwrap
 
 from pytest_bdd.utils import collect_dumped_objects
diff --git a/tests/feature/test_scenarios.py b/tests/feature/test_scenarios.py
@@ -1,5 +1,7 @@
 """Test scenarios shortcut."""
 
+from __future__ import annotations
+
 import textwrap
 
 
diff --git a/tests/feature/test_steps.py b/tests/feature/test_steps.py
@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import textwrap
 
 
diff --git a/tests/feature/test_tags.py b/tests/feature/test_tags.py
@@ -1,5 +1,7 @@
 """Test tags."""
 
+from __future__ import annotations
+
 import textwrap
 
 
diff --git a/tests/feature/test_wrong.py b/tests/feature/test_wrong.py
@@ -1,5 +1,7 @@
 """Test wrong feature syntax."""
 
+from __future__ import annotations
+
 import textwrap
 
 
diff --git a/tests/generation/test_generate_missing.py b/tests/generation/test_generate_missing.py
@@ -1,5 +1,7 @@
 """Code generation and assertion tests."""
 
+from __future__ import annotations
+
 import itertools
 import textwrap
 
diff --git a/tests/library/test_parent.py b/tests/library/test_parent.py
@@ -3,6 +3,8 @@
 Check the parent givens are collected and overridden in the local conftest.
 """
 
+from __future__ import annotations
+
 import textwrap
 
 from pytest_bdd.utils import collect_dumped_objects
diff --git a/tests/parser/test_errors.py b/tests/parser/test_errors.py
@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import textwrap
 
 
diff --git a/tests/parser/test_parser.py b/tests/parser/test_parser.py
@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from pathlib import Path
 
 from src.pytest_bdd.gherkin_parser import (
diff --git a/tests/scripts/test_generate.py b/tests/scripts/test_generate.py
@@ -1,5 +1,7 @@
 """Test code generation command."""
 
+from __future__ import annotations
+
 import os
 import sys
 import textwrap
diff --git a/tests/scripts/test_main.py b/tests/scripts/test_main.py
@@ -1,5 +1,7 @@
 """Main command."""
 
+from __future__ import annotations
+
 import os
 import sys
 import textwrap
diff --git a/tests/scripts/test_migrate.py b/tests/scripts/test_migrate.py
@@ -1,5 +1,7 @@
 """Test code generation command."""
 
+from __future__ import annotations
+
 import os
 import sys
 import textwrap
@@ -31,11 +33,7 @@ def test_migrate(monkeypatch, capsys, pytester):
     expected = textwrap.dedent(
         """
     migrated: {0}/test_foo.py
-    skipped: {0}/__init__.py""".format(
-            str(tests)
-        )[
-            1:
-        ]
+    skipped: {0}/__init__.py""".format(str(tests))[1:]
     )
     assert out == expected
     assert tests.joinpath("test_foo.py").read_text() == textwrap.dedent(
diff --git a/tests/steps/test_common.py b/tests/steps/test_common.py
@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import textwrap
 from typing import Any, Callable
 from unittest import mock
diff --git a/tests/steps/test_docstring.py b/tests/steps/test_docstring.py
@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import textwrap
 
 from src.pytest_bdd.utils import collect_dumped_objects
diff --git a/tests/steps/test_given.py b/tests/steps/test_given.py
@@ -1,5 +1,7 @@
 """Given tests."""
 
+from __future__ import annotations
+
 import textwrap
 
 
diff --git a/tests/steps/test_keyword.py b/tests/steps/test_keyword.py
@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import textwrap
 
 
diff --git a/tests/steps/test_unicode.py b/tests/steps/test_unicode.py
@@ -1,5 +1,7 @@
 """Tests for testing cases when we have unicode in feature file."""
 
+from __future__ import annotations
+
 import textwrap
 
 
diff --git a/tests/test_hooks.py b/tests/test_hooks.py
@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import textwrap
 
 from pytest_bdd.utils import collect_dumped_objects

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+from __future__ import annotations`
	`2`	`+`
`1`	`3`	`import textwrap`
`2`	`4`
`3`	`5`	`from pytest_bdd.utils import collect_dumped_objects`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+from __future__ import annotations`
	`2`	`+`
`1`	`3`	`import pytest`
`2`	`4`
`3`	`5`	`pytest_plugins = "pytester"`