Be more strict with Mypy (#293)

* Be more strict with mypy

* Update State definition

* fix one mypy error

* Remove (hopefully) unneccessary Lambda

* Fix mypy issues

* Improve mypy typing

Co-authored-by: Mick Vleeshouwer <mick@imick.nl>

mypy.ini

@@ -1,12 +1,22 @@
 [mypy]
-check_untyped_defs = True
-disallow_untyped_defs = True
-disallow_any_generics = True
-warn_no_return = True
-follow_imports = normal
-ignore_missing_imports = True
-namespace_packages = True
-show_error_codes = True
+python_version = 3.8
+show_error_codes = true
+follow_imports = silent
+ignore_missing_imports = true
+strict_equality = true
+warn_incomplete_stub = true
+warn_redundant_casts = true
+warn_unused_configs = true
+warn_unused_ignores = true
+check_untyped_defs = true
+disallow_incomplete_defs = true
+disallow_subclassing_any = true
+disallow_untyped_calls = true
+#disallow_untyped_decorators = true
+disallow_untyped_defs = true
+no_implicit_optional = true
+warn_return_any = true
+warn_unreachable = true
 
 [mypy-tests.*]
 ignore_errors = True

pyoverkiz/client.py

@@ -5,7 +5,7 @@
 import urllib.parse
 from json import JSONDecodeError
 from types import TracebackType
-from typing import Any, Dict, List, Union
+from typing import Any, Dict, List, Union, cast
 
 import backoff
 import boto3
@@ -68,12 +68,21 @@ async def refresh_listener(invocation: dict[str, Any]) -> None:
 class OverkizClient:
     """Interface class for the Overkiz API"""
 
+    username: str
+    password: str
+    server: OverkizServer
+    setup: Setup | None
+    devices: list[Device]
+    gateways: list[Gateway]
+    event_listener_id: str | None
+    session: ClientSession
+
     def __init__(
         self,
         username: str,
         password: str,
         server: OverkizServer,
-        session: ClientSession = None,
+        session: ClientSession | None = None,
     ) -> None:
         """
         Constructor
@@ -196,13 +205,9 @@ async def nexity_login(self) -> str:
         loop = asyncio.get_event_loop()
 
         # Request access token
-        client = await loop.run_in_executor(
-            None,
-            lambda: boto3.client(
-                "cognito-idp", config=Config(region_name=NEXITY_COGNITO_REGION)
-            ),
+        client = boto3.client(
+            "cognito-idp", config=Config(region_name=NEXITY_COGNITO_REGION)
         )
-
         aws = WarrantLite(
             username=self.username,
             password=self.password,
@@ -229,7 +234,7 @@ async def nexity_login(self) -> str:
             if "token" not in token:
                 raise NexityServiceException("No Nexity SSO token provided.")
 
-            return token["token"]
+            return cast(str, token["token"])
 
     @backoff.on_exception(
         backoff.expo,
@@ -337,7 +342,7 @@ async def get_device_definition(self, deviceurl: str) -> JSON | None:
         """
         Retrieve a particular setup device definition
         """
-        response = await self.__get(
+        response: dict = await self.__get(
             f"setup/devices/{urllib.parse.quote_plus(deviceurl)}"
         )
 
@@ -377,7 +382,7 @@ async def register_event_listener(self) -> str:
         API on a regular basis.
         """
         response = await self.__post("events/register")
-        listener_id = response.get("id")
+        listener_id = cast(str, response.get("id"))
         self.event_listener_id = listener_id
 
         return listener_id
@@ -441,7 +446,10 @@ async def execute_command(
         """Send a command"""
         if isinstance(command, str):
             command = Command(command)
-        return await self.execute_commands(device_url, [command], label)
+
+        response: str = await self.execute_commands(device_url, [command], label)
+
+        return response
 
     @backoff.on_exception(
         backoff.expo, NotAuthenticatedException, max_tries=2, on_backoff=relogin
@@ -464,8 +472,8 @@ async def execute_commands(
             "label": label,
             "actions": [{"deviceURL": device_url, "commands": commands}],
         }
-        response = await self.__post("exec/apply", payload)
-        return response["execId"]
+        response: dict = await self.__post("exec/apply", payload)
+        return cast(str, response["execId"])
 
     @backoff.on_exception(
         backoff.expo,
@@ -496,7 +504,7 @@ async def get_places(self) -> Place:
     async def execute_scenario(self, oid: str) -> str:
         """Execute a scenario"""
         response = await self.__post(f"exec/{oid}")
-        return response["execId"]
+        return cast(str, response["execId"])
 
     async def __get(self, path: str) -> Any:
         """Make a GET request to the OverKiz API"""

pyoverkiz/const.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from pyoverkiz.models import OverkizServer
 
 COZYTOUCH_ATLANTIC_API = "https://api.groupe-atlantic.com"
@@ -10,7 +12,7 @@
 NEXITY_COGNITO_USER_POOL = "eu-west-1_wj277ucoI"
 NEXITY_COGNITO_REGION = "eu-west-1"
 
-SUPPORTED_SERVERS = {
+SUPPORTED_SERVERS: dict[str, OverkizServer] = {
     "atlantic_cozytouch": OverkizServer(
         name="Atlantic Cozytouch",
         endpoint="https://ha110-1.overkiz.com/enduser-mobile-web/enduserAPI/",

pyoverkiz/models.py

@@ -267,9 +267,15 @@ def __len__(self) -> int:
 class State:
     name: str
     type: DataType
-    value: str | None = None
+    value: None | int | float | str | bool
 
-    def __init__(self, name: str, type: int, value: str | None = None, **_: Any):
+    def __init__(
+        self,
+        name: str,
+        type: int,
+        value: None | int | float | str | bool = None,
+        **_: Any,
+    ):
         self.name = name
         self.value = value
         self.type = DataType(type)
@@ -307,7 +313,7 @@ def __len__(self) -> int:
     get = __getitem__
 
 
-class Command(dict):  # type: ignore
+class Command(dict):
     """Represents an OverKiz Command."""
 
     def __init__(self, name: str, parameters: list[str] | None = None, **_: Any):