Switch to inbuilt types (#10)

* switch to using inbuilt types
* add poetry to container
* add conditional imports for typing

Author: jdkandersson

.devcontainer/devcontainer.json

@@ -5,6 +5,7 @@
         "ghcr.io/devcontainers/features/python:1": {},
         "ghcr.io/devcontainers-contrib/features/black:1": {},
         "ghcr.io/devcontainers-contrib/features/tox:1": {},
-        "ghcr.io/devcontainers-contrib/features/isort:1": {}
+        "ghcr.io/devcontainers-contrib/features/isort:1": {},
+        "ghcr.io/devcontainers-contrib/features/poetry:1": {}
     }
 }

CHANGELOG.md

@@ -2,6 +2,12 @@
 
 ## [Unreleased]
 
+## [v1.0.6] - 2022-12-28
+
+### Fixed
+
+- Switch to using inbuilt types rather than from `typing`
+
 ## [v1.0.5] - 2022-12-23
 
 ### Fixed
@@ -23,3 +29,4 @@
 [//]: # "Release links"
 [v1.0.0]: https://github.com/jdkandersson/flake8-test-docs/releases/v1.0.0
 [v1.0.5]: https://github.com/jdkandersson/flake8-test-docs/releases/v1.0.5
+[v1.0.6]: https://github.com/jdkandersson/flake8-test-docs/releases/v1.0.6

flake8_test_docs.py

@@ -1,11 +1,20 @@
 """A linter that checks test docstrings for the arrange/act/assert structure."""
 
+from __future__ import annotations
+
 import argparse
 import ast
 import re
+import sys
 from functools import wraps
 from pathlib import Path
-from typing import Callable, Iterable, List, NamedTuple, Optional, Tuple, Type
+from typing import Callable, Iterator, NamedTuple
+
+# Can't cover both paths of a conditional import
+if sys.version_info < (3, 10):
+    from typing_extensions import ParamSpec  # pragma: nocover
+else:
+    from typing import ParamSpec  # pragma: nocover
 
 from flake8.options.manager import OptionManager
 
@@ -71,12 +80,15 @@ class Section(NamedTuple):
     index_: int
     name: str
     description: str
-    next_section_name: Optional[str]
+    next_section_name: str | None
+
+
+AIMPPParamSpec = ParamSpec("AIMPPParamSpec")
 
 
 def _append_invalid_msg_prefix_postfix(
-    func: Callable[..., Optional[str]]
-) -> Callable[..., Optional[str]]:
+    func: Callable[AIMPPParamSpec, str | None]
+) -> Callable[AIMPPParamSpec, str | None]:
     """Add the code prefix and invalid message postfix to the return value.
 
     Args:
@@ -87,7 +99,7 @@ def _append_invalid_msg_prefix_postfix(
     """
 
     @wraps(func)
-    def wrapper(*args, **kwargs):
+    def wrapper(*args: AIMPPParamSpec.args, **kwargs: AIMPPParamSpec.kwargs) -> str | None:
         """Wrap the function."""
         if (return_value := func(*args, **kwargs)) is None:
             return None
@@ -98,7 +110,7 @@ def wrapper(*args, **kwargs):
 
 def _section_start_problem_message(
     line: str, section: Section, col_offset: int, section_prefix: str
-) -> Optional[str]:
+) -> str | None:
     """Check the first line of a section.
 
     Args:
@@ -136,7 +148,7 @@ def _section_start_problem_message(
     return None
 
 
-def _next_section_start(line: str, next_section_name: Optional[str], section_prefix: str) -> bool:
+def _next_section_start(line: str, next_section_name: str | None, section_prefix: str) -> bool:
     """Detect whether the line is the start of the next section.
 
     The next section is defined to be either that the line starts with the next section name after
@@ -165,11 +177,11 @@ def _next_section_start(line: str, next_section_name: Optional[str], section_pre
 
 def _remaining_description_problem_message(
     section: Section,
-    docstring_lines: List[str],
+    docstring_lines: list[str],
     section_prefix: str,
     description_prefix: str,
     indent_size: int,
-) -> Tuple[Optional[str], int]:
+) -> tuple[str | None, int]:
     """Check the remaining description of a section after the first line.
 
     Args:
@@ -213,7 +225,7 @@ def _remaining_description_problem_message(
 @_append_invalid_msg_prefix_postfix
 def _docstring_problem_message(
     docstring: str, col_offset: int, docs_pattern: DocsPattern, indent_size: int
-) -> Optional[str]:
+) -> str | None:
     """Get the problem message for a docstring.
 
     Args:
@@ -296,7 +308,7 @@ class Visitor(ast.NodeVisitor):
         problems: All the problems that were encountered.
     """
 
-    problems: List[Problem]
+    problems: list[Problem]
     _test_docs_pattern: DocsPattern
     _test_function_pattern: str
     _indent_size: int
@@ -456,7 +468,7 @@ def parse_options(cls, options: argparse.Namespace) -> None:  # pragma: nocover
             getattr(options, _cli_arg_name_to_attr(INDENT_SIZE_ARN_NAME), None) or cls._indent_size
         )
 
-    def run(self) -> Iterable[Tuple[int, int, str, Type["Plugin"]]]:
+    def run(self) -> Iterator[tuple[int, int, str, type["Plugin"]]]:
         """Lint a file.
 
         Yields:

poetry.lock

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "flake8-test-docs"
-version = "1.0.5"
+version = "1.0.6"
 description = "A linter that checks test docstrings for the arrange/act/assert structure"
 authors = ["David Andersson <[email protected]>"]
 license = "Apache 2.0"
@@ -22,6 +22,7 @@ classifiers = [
 [tool.poetry.dependencies]
 python = "^3.8.1"
 flake8 = "^6"
+typing_extensions = { version = "^4", python = "<3.10" }
 
 [tool.poetry.group.dev.dependencies]
 pytest = "^7"
@@ -65,3 +66,14 @@ show_missing = true
 
 [tool.mypy]
 ignore_missing_imports = true
+check_untyped_defs = true
+disallow_untyped_defs = true
+
+[[tool.mypy.overrides]]
+module = "tests.*"
+disallow_untyped_defs = false
+
+[tool.pylint.messages_control]
+disable = [
+    "wrong-import-position"
+]

pyproject.toml

@@ -1,7 +1,8 @@
 """Unit tests for plugin."""
 
+from __future__ import annotations
+
 import ast
-from typing import Tuple
 
 import hypothesis
 import pytest
@@ -18,7 +19,7 @@
 )
 
 
-def _result(code: str, filename: str = "test_.py") -> Tuple[str, ...]:
+def _result(code: str, filename: str = "test_.py") -> tuple[str, ...]:
     """Generate linting results.
 
     Args:
@@ -796,7 +797,7 @@ def function_1():
         ),
     ],
 )
-def test_plugin_invalid(code: str, expected_result: Tuple[str, ...]):
+def test_plugin_invalid(code: str, expected_result: tuple[str, ...]):
     """
     given: code
     when: linting is run on the code
@@ -812,7 +813,7 @@ def test_plugin_invalid(code: str, expected_result: Tuple[str, ...]):
         pytest.param("file.py", (), id="not test file"),
     ],
 )
-def test_plugin_filename(filename: str, expected_result: Tuple[str, ...]):
+def test_plugin_filename(filename: str, expected_result: tuple[str, ...]):
     """
     given: code and filename
     when: linting is run on the code