Merge pull request #19 from George-Ogden/builtin-iter

Ignore Standard Library `[iterable-sequence]` warnings

Author: George-Ogden

mypy_pytest_plugin/iterable_sequence_checker.py

@@ -1,5 +1,6 @@
 from collections.abc import Collection, Sequence
 from dataclasses import dataclass
+import sys
 
 from mypy.argmap import map_formals_to_actuals
 from mypy.checker import TypeChecker
@@ -16,16 +17,33 @@ class IterableSequenceChecker:
     checker: TypeChecker
 
     def check_iterable_sequence_call(self, call: CallExpr) -> None:
+        if not self.is_builtin_function(call.callee):
+            self.check_iterable_sequence_arguments(call)
+
+    def is_builtin_function(self, expression: Expression) -> bool:
+        expression_type = self.checker.lookup_type(expression)
+        if (
+            isinstance(expression_type, CallableType)
+            and (def_ := expression_type.definition) is not None
+        ):
+            [module, *_] = def_.fullname.split(".", maxsplit=1) if def_ else [""]
+            return module in sys.stdlib_module_names
+        return False
+
+    def check_iterable_sequence_arguments(self, call: CallExpr) -> None:
         for argument, expected_type in self.actuals_formals_mapping_bijective_subset(call):
-            argument_type = self.checker.lookup_type(argument)
-            if self.is_sequence(argument_type) and self.is_iterable(expected_type):
-                self._display_error_message(expected_type, argument_type, argument)
+            self.check_iterable_sequence_argument(argument, expected_type)
+
+    def check_iterable_sequence_argument(self, argument: Expression, expected_type: Type) -> None:
+        argument_type = self.checker.lookup_type(argument)
+        if self.is_sequence(argument_type) and self.is_iterable(expected_type):
+            self._display_error_message(expected_type, argument_type, argument)
 
     def _display_error_message(
         self, expected_type: Type, argument_type: Type, context: Context
     ) -> None:
         self.checker.fail(
-            f"Expected {format_type(expected_type, self.checker.options)}, got {format_type(argument_type, self.checker.options)}.",
+            f"Argument has type {format_type(argument_type, self.checker.options)}; expected {format_type(expected_type, self.checker.options)}.",
             context,
             code=ITERABLE_SEQUENCE,
         )

mypy_pytest_plugin/iterable_sequence_checker_test.py

@@ -169,3 +169,21 @@ def foo(cls, it: Iterable) -> int:
         """,
         errors=["iterable-sequence"],
     )
+
+
+def test_check_iterable_sequence_builtin() -> None:
+    _check_iterable_sequence_call_test_body(
+        """
+        call = tuple([1, 2, 3])
+        """
+    )
+
+
+def test_check_iterable_sequence_stdlib() -> None:
+    _check_iterable_sequence_call_test_body(
+        """
+        import itertools
+
+        call = itertools.pairwise([1, 2, 3])
+        """
+    )

mypy_pytest_plugin/plugin.py

@@ -31,6 +31,7 @@ def __init__(self, options: Options) -> None:
             options.per_module_options.setdefault(module_pattern, {})["ignore_missing_imports"] = (
                 True
             )
+        options.preserve_asts = True
         super().__init__(options)
 
     def get_additional_deps(self, file: MypyFile) -> list[tuple[int, str, int]]:

mypy_pytest_plugin/test_info_test.py

@@ -841,6 +841,7 @@ def test_info(bool_fixture: Literal[True]) -> None:
     )
 
 
+@pytest.mark.local_only
 def test_test_info_check_invalid_argument_subtypes() -> None:
     _test_info_check_test_body(
         """

pyproject.toml

@@ -1,7 +1,7 @@
 [project]
 name = "mypy-pytest-plugin"
 requires-python = ">=3.12,<3.15"
-version = "0.3.0"
+version = "0.4.0"
 dynamic = ["dependencies"]
 
 [tool.setuptools]

test_samples/valid_test.py

@@ -27,3 +27,8 @@ def test_call_edge_cases() -> None:
     f_string = f"x{3}"
     list_addition = [1, 2, 3]
     list_addition += [4, 5, 6]
+
+
+def test_iterable_sequence_builtin() -> None:
+    l = [1, 2, 3, 4]
+    t = tuple(l)

tests/snapshots/mypy_test/test_check_files/invalid_test/invalid_test.out

@@ -7,9 +7,9 @@ test_samples/invalid_test.py:23: error: Argument 2 has incompatible type "tuple[
 test_samples/invalid_test.py:30: error: Incompatible return value type (got "list[T]", expected "tuple[T, T]")  [return-value]
 test_samples/invalid_test.py:34: error: Argument 1 to "specific_test_case" has incompatible type "str"; expected "int"  [arg-type]
 test_samples/invalid_test.py:34: error: Argument 1 to "specific_test_case" has incompatible type "float"; expected "int"  [arg-type]
-test_samples/invalid_test.py:47: error: Expected "Iterable[Any]", got "list[Any]".  [iterable-sequence]
+test_samples/invalid_test.py:47: error: Argument has type "list[Any]"; expected "Iterable[Any]".  [iterable-sequence]
 test_samples/invalid_test.py:47: note: This still type checks, but could be made more robust by using `iter()`
-test_samples/invalid_test.py:48: error: Expected "Iterable[int]", got "list[int]".  [iterable-sequence]
+test_samples/invalid_test.py:48: error: Argument has type "list[int]"; expected "Iterable[int]".  [iterable-sequence]
 test_samples/invalid_test.py:48: note: This still type checks, but could be made more robust by using `iter()`
 test_samples/invalid_test.py:61: error: Function is missing a type annotation  [no-untyped-def]
 Found 12 errors in 1 file (checked 1 source file)