fix decorator annotation so mypy can detect proper types

Author: bandophahita

screenpy_selenium/common.py

@@ -13,7 +13,7 @@
     T = TypeVar("T")
 
 
-def pos_args_deprecated(*keywords: str) -> Callable:
+def pos_args_deprecated(*keywords: str) -> Callable[[Callable], Callable]:
     """Warn users which positional arguments should be called via keyword."""
 
     def deprecated(func: Callable) -> Callable:

tests/test_actions.py

@@ -4,7 +4,7 @@
 import warnings
 from contextlib import contextmanager
 from pathlib import Path
-from typing import TYPE_CHECKING, cast
+from typing import TYPE_CHECKING, assert_type, cast
 from unittest import mock
 
 import pytest
@@ -354,6 +354,14 @@ def test_can_be_instantiated(self) -> None:
         assert isinstance(e6, Enter)
         assert isinstance(e7, Enter)
         assert isinstance(e8, Enter)
+        assert_type(e1, Enter)
+        assert_type(e2, Enter)
+        assert_type(e3, Enter)
+        assert_type(e4, Enter)
+        assert_type(e5, Enter)
+        assert_type(e6, Enter)
+        assert_type(e7, Enter)
+        assert_type(e8, Enter)
 
     def test_implements_protocol(self) -> None:
         e = Enter("")
@@ -617,6 +625,10 @@ def test_can_be_instantiated(self) -> None:
         assert isinstance(hd2, HoldDown)
         assert isinstance(hd3, HoldDown)
         assert isinstance(hd4, HoldDown)
+        assert_type(hd1, HoldDown)
+        assert_type(hd2, HoldDown)
+        assert_type(hd3, HoldDown)
+        assert_type(hd4, HoldDown)
 
     def test_implements_protocol(self) -> None:
         h = HoldDown.left_mouse_button()
@@ -916,6 +928,9 @@ def test_can_be_instantiated(self) -> None:
         assert isinstance(r1, Release)
         assert isinstance(r2, Release)
         assert isinstance(r3, Release)
+        assert_type(r1, Release)
+        assert_type(r2, Release)
+        assert_type(r3, Release)
 
     def test_implements_protocol(self) -> None:
         r = Release.left_mouse_button()

tests/test_questions.py

@@ -9,6 +9,7 @@
 from selenium.common.exceptions import WebDriverException
 from selenium.webdriver.common.alert import Alert as SeleniumAlert
 from selenium.webdriver.remote.webelement import WebElement
+from typing_extensions import assert_type
 
 from screenpy_selenium import (
     Attribute,
@@ -274,6 +275,10 @@ def test_can_be_instantiated(self) -> None:
         assert isinstance(s2, Selected)
         assert isinstance(s3, Selected)
         assert isinstance(s4, Selected)
+        assert_type(s1, Selected)
+        assert_type(s2, Selected)
+        assert_type(s3, Selected)
+        assert_type(s4, Selected)
 
     def test_implements_protocol(self) -> None:
         s = Selected(TARGET)
@@ -342,6 +347,8 @@ def test_can_be_instantiated(self) -> None:
 
         assert isinstance(t1, Text)
         assert isinstance(t2, Text)
+        assert_type(t1, Text)
+        assert_type(t2, Text)
 
     def test_implements_protocol(self) -> None:
         t = Text(TARGET)
@@ -382,6 +389,13 @@ def test_ask_for_all_text(self, Tester: Actor) -> None:
     def test_describe(self) -> None:
         assert Text(TARGET).describe() == f"The text from the {TARGET}."
 
+    def test_positional_arg_warns(self) -> None:
+        with pytest.warns(
+            DeprecationWarning,
+            match=r".*?Please use keyword arguments instead.$",
+        ):
+            Text(TARGET, True)
+
 
 class TestTextOfTheAlert:
     def test_can_be_instantiated(self) -> None: