Run mypy for full repo & fix all mypy issues

README.md

@@ -34,6 +34,7 @@ Wakepy has two main modes:
 - Permissive MIT licence
 - Low amount of python dependencies
   - For using the D-Bus methods on Linux: [jeepney](https://jeepney.readthedocs.io/)
+  - On Python 3.7: [typing-extensions](https://pypi.org/project/typing-extensions/).
   - Otherwise: None
 
 

docs/source/conf.py

@@ -69,7 +69,7 @@
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This pattern also affects html_static_path and html_extra_path.
-exclude_patterns = []
+exclude_patterns: list[str] = []
 
 html_static_path = ["_static"]
 

docs/source/index.md

@@ -16,6 +16,8 @@ pip install wakepy
 
 ```{note}
 On Linux will install also **[`jeepney`](https://jeepney.readthedocs.io/)** for DBus communication (if not installed). On other systems there are no python requirements.
+
+On Python 3.7 installs [typing-extensions](https://pypi.org/project/typing-extensions/).
 ```
 
 ## Basic Usage

pyproject.toml

@@ -7,7 +7,10 @@ authors = [
 ]
 dependencies = [
     # For using the D-Bus based methods
-    "jeepney >= 0.7.1;sys_platform=='linux'"
+    "jeepney >= 0.7.1;sys_platform=='linux'",
+    # The typing.Literal was introduced in Python 3.8. Need to install
+    # typing-extensions for Python 3.7 support.
+    'typing-extensions; python_version < "3.8.0"',
 ]
 
 # Python 3.7 introduces from __future__ import annotations
@@ -38,7 +41,8 @@ dev = [
     "IPython",
     "invoke==2.2.0",
     # Colorama is used with the tasks.py (invoke commands)
-    "colorama==0.4.6"
+    "colorama==0.4.6",
+
 ]
 # For building documentation
 doc = [
@@ -67,10 +71,16 @@ test =[
 ]
 # For linters, code analysis and formatting tools
 check = [
+    "invoke==2.2.0",
     "black==24.2.0",
     "mypy==1.9.0",
     "isort==5.13.2",
     "ruff==0.3.2",
+    # some version of pytest required for checking types. Perhaps any recent
+    # version of pytest will do.
+    "pytest",
+    "types-colorama", # for mypy
+    "time-machine==2.14.0" # for mypy
 ]
 
 
@@ -87,6 +97,7 @@ requires = ["flit_core >=3.2,<4"]
 build-backend = "flit_core.buildapi"
 
 [tool.mypy]
+exclude = ['venv', '.venv']
 check_untyped_defs = true
 disallow_any_generics = true
 no_implicit_optional = true
@@ -119,6 +130,7 @@ exclude_lines = [
     "pragma: no cover",
     "if typing.TYPE_CHECKING:",
     "@(abc\\.)?abstractmethod",
+    "@(typing\\.)?overload",
 ]
 
 [tool.coverage.coverage_conditional_plugin.omit]
@@ -127,6 +139,8 @@ exclude_lines = [
 
 [tool.coverage.coverage_conditional_plugin.rules]
 no-cover-if-no-dbus = "platform_system != 'Linux'"
+no-cover-if-py-gte-38 = "sys_version_info >= (3, 8)"
+no-cover-if-py-lt-38 = "sys_version_info < (3, 8)"
 
 [tool.isort]
 profile = "black"

tasks.py

@@ -25,7 +25,7 @@
 import typing
 
 from colorama import Fore
-from invoke import task
+from invoke import task  # type: ignore
 
 if typing.TYPE_CHECKING:
     from invoke.runners import Result
@@ -34,30 +34,31 @@
 def get_run_with_print(c):
     def run_with_print(cmd: str, ignore_errors: bool = False) -> Result:
         print("Running:", Fore.YELLOW, cmd, Fore.RESET)
-        return c.run(cmd, pty=platform.system() == "Linux", warn=ignore_errors)
+        res: Result = c.run(cmd, pty=platform.system() == "Linux", warn=ignore_errors)
+        return res
 
     return run_with_print
 
 
 @task
-def format(c):
+def format(c) -> None:
     run = get_run_with_print(c)
     run("python -m isort .")
     run("python -m black .")
     run("python -m ruff check --fix .")
 
 
 @task
-def check(c) -> int:
+def check(c) -> None:
     run = get_run_with_print(c)
     run("python -m isort --check .")
     run("python -m black --check .")
     run("python -m ruff check --no-fix .")
-    run("python -m mypy ./wakepy")
+    run("python -m .")
 
 
 @task
-def docs(c):
+def docs(c) -> None:
     """Starts sphinx build with live-reload on browser."""
 
     run = get_run_with_print(c)
@@ -68,7 +69,7 @@ def docs(c):
 
 
 @task
-def test(c, pdb: bool = False):
+def test(c, pdb: bool = False) -> None:
     run = get_run_with_print(c)
     pdb_flag = " --pdb " if pdb else ""
     res = run(

tests/conftest.py

@@ -0,0 +1,51 @@
+import sys
+from typing import Optional
+
+import pytest
+
+from wakepy.core.strenum import StrEnum
+
+if sys.version_info < (3, 8):  # pragma: no-cover-if-py-gte-38
+    import typing_extensions as typing
+else:  # pragma: no-cover-if-py-lt-38
+    import typing
+
+
+@pytest.fixture
+def do_assert():
+    """Function to be used instead of assert statement."""
+
+    # Fixes issue with mypy: https://github.com/python/mypy/issues/11969
+    # In short, when testing and needing to assert that a variable has certain
+    # value, and then mutating the value and asserting the value again (
+    # against new assumed value), mypy does not handle that case but you'll get
+    # [unreachable] errors. Using `do_assert(...)` instead of `assert ...` in
+    # tests fixes this.
+
+    def _do_assert(
+        expression: bool,
+        message: Optional[str] = None,
+    ) -> None:
+        """Original idea: Nikita Sobolev (safe-assert)[1]. Fixed the return
+        type to make this usable[2]
+
+        [1] https://github.com/wemake-services/safe-assert/blob/e3ebfe72a910915e227a9f5447a0f7f56d5219e6/safe_assert/__init__.py
+        [2] https://github.com/wemake-services/safe-assert/pull/131
+        """
+        if not expression:
+            if message:
+                raise AssertionError(message)
+            raise AssertionError
+
+    return _do_assert
+
+
+@pytest.fixture
+def assert_strenum_values():
+
+    def _assert_strenum_values(strenum_cls: typing.Type[StrEnum], values: typing.Any):
+        """Note: `values` is a typing.Literal. Could not find a type annotation
+        for that"""
+        assert set(typing.get_args(values)) == {member.value for member in strenum_cls}
+
+    return _assert_strenum_values

tests/integration/conftest.py

@@ -10,10 +10,13 @@
 import pytest
 
 if sys.platform.lower().startswith("linux"):
-    from dbus_service import DBusService, start_dbus_service
+    from tests.integration.dbus_service import DBusService, start_dbus_service
 else:
-    DBusService = None
-    start_dbus_service = None
+
+    class DBusService: ...  # type: ignore
+
+    def start_dbus_service(): ...  # type: ignore
+
 
 from wakepy.core import DBusAddress, DBusMethod
 
@@ -56,6 +59,9 @@ def private_bus():
         env={"DBUS_VERBOSE": "1"},
     )
 
+    if p.stdout is None:
+        raise RuntimeError("Error when starting private bus")
+
     bus_address = p.stdout.readline().decode("utf-8").strip()
 
     logger.info("Initiated private bus: %s", bus_address)

tests/integration/dbus_service.py

@@ -4,7 +4,7 @@
 import queue
 import threading
 import time
-from typing import Callable, Optional, Tuple, Type
+from typing import Any, Callable, Optional, Tuple, Type
 
 from jeepney import HeaderFields, MessageType, new_error, new_method_return
 from jeepney.bus_messages import message_bus
@@ -41,7 +41,9 @@ class DBusService:
 
     addr: DBusAddress
 
-    def __init__(self, bus_address: str, queue_: queue.Queue, stop: Callable):
+    def __init__(
+        self, bus_address: str, queue_: queue.Queue[str], stop: Callable[[], bool]
+    ):
         """
         Parameters
         ----------
@@ -139,7 +141,9 @@ def _get_error_message(self, msg, method=".Error.NoMethod"):
         """Create an error message for replying to a message"""
         return new_error(msg, self.bus_name + method)
 
-    def handle_method(self, method: str, args: Tuple) -> Optional[Tuple[str, Tuple]]:
+    def handle_method(
+        self, method: str, args: Tuple[Any, ...]
+    ) -> Optional[Tuple[str, Tuple[Any, ...]]]:
         """Should return either None (when method does not exist), or tuple of
         output signature (like "ii" or "sus", etc.), and output values which
         are of the type defined by the output signature
@@ -158,15 +162,17 @@ def start_dbus_service(
         --print-address. If not given, uses the service_cls.addr.bus.
     """
 
-    queue_ = queue.Queue()
+    queue_: queue.Queue[str] = queue.Queue()
     should_stop = False
 
     def start_service(
-        service: Type[DBusService], queue_: queue.Queue, should_stop: Callable
+        service: Type[DBusService],
+        queue_: queue.Queue[str],
+        should_stop: Callable[[], bool],
     ):
         logger.info(f"Launching dbus service: {service.addr.service}")
-
-        service_ = service(bus_address or service.addr.bus, queue_, stop=should_stop)
+        addr = bus_address or service.addr.bus or "SESSION"
+        service_ = service(addr, queue_, stop=should_stop)
         service_.start(
             server_name=service.addr.service,
             object_path=service.addr.path,

tests/unit/test_core/conftest.py

@@ -1,6 +1,6 @@
 import pytest
 
-from wakepy.core.method import Method, PlatformName
+from wakepy.core import DBusAddress, DBusMethod, Method, PlatformName
 
 # B, D, E
 FIRST_MODE = "first_mode"
@@ -76,3 +76,15 @@ class MethodE(TestMethod):
     class MethodF(TestMethod):
         name = "F"
         mode = SECOND_MODE
+
+
+@pytest.fixture
+def service():
+    return DBusAddress(path="/foo", service="wakepy.foo", interface="/foo")
+
+
+@pytest.fixture
+def dbus_method(service: DBusAddress):
+    return DBusMethod(
+        name="test-method", signature="isi", params=("first", "second", "third")
+    ).of(service)

tests/unit/test_core/test_activation/test_activation.py

@@ -11,18 +11,25 @@
 
 import pytest
 import time_machine
-from testmethods import (
+
+from tests.unit.test_core.testmethods import (
     FAILURE_REASON,
     METHOD_MISSING,
     METHOD_OPTIONS,
     WakepyMethodTestError,
     get_test_method_class,
     iterate_test_methods,
 )
-
-from wakepy.core import DBusAdapter, MethodActivationResult, get_methods
+from wakepy.core import (
+    DBusAdapter,
+    Method,
+    MethodActivationResult,
+    PlatformName,
+    get_methods,
+)
 from wakepy.core.activation import (
     StageName,
+    StageNameValue,
     WakepyFakeSuccess,
     activate_method,
     activate_mode,
@@ -32,7 +39,7 @@
     try_enter_and_heartbeat,
 )
 from wakepy.core.heartbeat import Heartbeat
-from wakepy.core.method import Method, MethodError, PlatformName
+from wakepy.core.method import MethodError
 
 
 def test_activate_without_methods(monkeypatch):
@@ -592,10 +599,11 @@ def test_deactivate_fail_heartbeat_not_stopping():
         deactivate_method(method, heartbeat)
 
 
-def test_stagename():
+def test_stagename(assert_strenum_values):
     assert StageName.PLATFORM_SUPPORT == "PLATFORM_SUPPORT"
     assert StageName.ACTIVATION == "ACTIVATION"
     assert StageName.REQUIREMENTS == "REQUIREMENTS"
+    assert_strenum_values(StageName, StageNameValue)
 
 
 # These are the only "falsy" values for WAKEPY_FAKE_SUCCESS

tests/unit/test_core/test_activation/test_prioritization.py

@@ -2,13 +2,13 @@
 
 import pytest
 
+from wakepy.core import PlatformName
 from wakepy.core.activation import (
     check_methods_priority,
     get_prioritized_methods,
     get_prioritized_methods_groups,
     sort_methods_by_priority,
 )
-from wakepy.core.method import PlatformName
 from wakepy.core.registry import get_methods
 
 
@@ -70,7 +70,10 @@ def test_check_methods_priority():
         TypeError,
         match=re.escape("methods_priority must be a list[str | set[str]]!"),
     ):
-        check_methods_priority(methods_priority=[MethodA], methods=methods)
+        check_methods_priority(
+            methods_priority=[MethodA],  # type: ignore
+            methods=methods,
+        )
 
 
 @pytest.mark.usefixtures("provide_methods_a_f")