ruff and mypy clean up (#508)

* clean up mypy complaints

* ruff and mypy clean up

* fix: package versioning

.github/workflows/pythonpackage.yml

@@ -55,6 +55,27 @@ jobs:
         run: |
           ruff check src/pyatmo
 
+  typechecker:
+    runs-on: ubuntu-latest
+    strategy:
+      max-parallel: 1
+      matrix:
+        python-version: [3.11.4]
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/[email protected]
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install mypy types-requests
+      - name: Typecheck with mypy
+        run: |
+          mypy src/pyatmo
+
   build:
     runs-on: ubuntu-latest
     strategy:

pyproject.toml

@@ -1,5 +1,5 @@
 [build-system]
-requires = ["wheel", "setuptools", "attrs>=17.1"]
+requires = ["setuptools>=64", "setuptools_scm>=8"]
 build-backend = "setuptools.build_meta"
 
 [project]
@@ -54,16 +54,6 @@ dev-dependencies = [
 ]
 
 [tool.setuptools_scm]
-local_scheme = "no-local-version"
-tag_regex = "^(?P<prefix>v)?(?P<version>[^\\+]+)(?P<suffix>.*)?$"
-write_to = "src/pyatmo/__version__.py"
-write_to_template = '''"""
-Pyatmo: Simple API to access Netatmo devices and data
-
-DO NO EDIT THIS FILE - VERSION IS MANAGED BY SETUPTOOLS_SCM
-"""
-__version__ = "{version}"
-'''
 
 [tool.pytest.ini_options]
 minversion = "8.0"
@@ -78,66 +68,7 @@ fix = true
 line-length = 88
 
 [tool.ruff.lint]
-select = [
-    "B002",    # Python does not support the unary prefix increment
-    "B007",    # Loop control variable {name} not used within loop body
-    "B014",    # Exception handler with duplicate exception
-    "B023",    # Function definition does not bind loop variable {name}
-    "B026",    # Star-arg unpacking after a keyword argument is strongly discouraged
-    "C",       # complexity
-    "COM818",  # Trailing comma on bare tuple prohibited
-    "D",       # docstrings
-    "DTZ003",  # Use datetime.now(tz=) instead of datetime.utcnow()
-    "DTZ004",  # Use datetime.fromtimestamp(ts, tz=) instead of datetime.utcfromtimestamp(ts)
-    "E",       # pycodestyle
-    "F",       # pyflakes/autoflake
-    "G",       # flake8-logging-format
-    "I",       # isort
-    "ICN001",  # import concentions; {name} should be imported as {asname}
-    "N804",    # First argument of a class method should be named cls
-    "N805",    # First argument of a method should be named self
-    "N815",    # Variable {name} in class scope should not be mixedCase
-    "S307",    # No builtin eval() allowed
-    "PGH004",  # Use specific rule codes when using noqa
-    "PLC0414", # Useless import alias. Import alias does not rename original package.
-    "PL",      # pylint
-    "Q000",    # Double quotes found but single quotes preferred
-    "RUF006",  # Store a reference to the return value of asyncio.create_task
-    "S102",    # Use of exec detected
-    "S103",    # bad-file-permissions
-    "S108",    # hardcoded-temp-file
-    "S306",    # suspicious-mktemp-usage
-    "S307",    # suspicious-eval-usage
-    "S313",    # suspicious-xmlc-element-tree-usage
-    "S314",    # suspicious-xml-element-tree-usage
-    "S315",    # suspicious-xml-expat-reader-usage
-    "S316",    # suspicious-xml-expat-builder-usage
-    "S317",    # suspicious-xml-sax-usage
-    "S318",    # suspicious-xml-mini-dom-usage
-    "S319",    # suspicious-xml-pull-dom-usage
-    "S320",    # suspicious-xmle-tree-usage
-    "S601",    # paramiko-call
-    "S602",    # subprocess-popen-with-shell-equals-true
-    "S604",    # call-with-shell-equals-true
-    "S608",    # hardcoded-sql-expression
-    "S609",    # unix-command-wildcard-injection
-    "SIM105",  # Use contextlib.suppress({exception}) instead of try-except-pass
-    "SIM117",  # Merge with-statements that use the same scope
-    "SIM118",  # Use {key} in {dict} instead of {key} in {dict}.keys()
-    "SIM201",  # Use {left} != {right} instead of not {left} == {right}
-    "SIM208",  # Use {expr} instead of not (not {expr})
-    "SIM212",  # Use {a} if {a} else {b} instead of {b} if not {a} else {a}
-    "SIM300",  # Yoda conditions. Use 'age == 42' instead of '42 == age'.
-    "SIM401",  # Use get from dict with default instead of an if block
-    "T100",    # Trace found: {name} used
-    "T20",     # flake8-print
-    "TID251",  # Banned imports
-    "TRY004",  # Prefer TypeError exception for invalid type
-    "B904",    # Use raise from to specify exception cause
-    "TRY302",  # Remove exception handler; error is immediately re-raised
-    "UP",      # pyupgrade
-    "W",       # pycodestyle
-]
+select = ["ALL"]
 
 ignore = [
     "D202", # No blank lines allowed after function docstring
@@ -147,6 +78,7 @@ ignore = [
     "D407", # Section name underlining
     "E501", # line too long
     "E731", # do not assign a lambda expression, use a def
+    "N818", # Exception should be named with an Error suffix
     # False positives https://github.com/astral-sh/ruff/issues/5386
     "PLC0208", # Use a sequence type instead of a `set` when iterating over values
     "PLR0911", # Too many return statements ({returns} > {max_returns})
@@ -175,9 +107,28 @@ split-on-trailing-comma = false
 [tool.ruff.lint.per-file-ignores]
 # Allow for main entry & scripts to write to stdout
 "src/pyatmo/__main__.py" = ["T201"]
+"src/pyatmo/modules/module.py" = ["PGH003"]
+"src/pyatmo/auth.py" = ["ASYNC109"]
 
 # Exceptions for tests
-"tests/*" = ["D10"]
+"tests/*" = [
+    "D10",
+    "S105",
+    "S101",
+    "ANN201",
+    "ANN001",
+    "N802",
+    "ANN202",
+    "PTH123",
+    "ASYNC230",
+    "PT012",
+    "DTZ001",
+    "ANN003",
+    "ANN002",
+    "A001",
+    "ARG001",
+    "ANN204",
+]
 
 [tool.ruff.lint.mccabe]
 max-complexity = 25

src/pyatmo/account.py

@@ -3,7 +3,7 @@
 from __future__ import annotations
 
 import logging
-from typing import TYPE_CHECKING, Any
+from typing import TYPE_CHECKING, Any, cast
 from uuid import uuid4
 
 from pyatmo import modules
@@ -20,7 +20,7 @@
 )
 from pyatmo.helpers import extract_raw_data
 from pyatmo.home import Home
-from pyatmo.modules.module import MeasureInterval, Module
+from pyatmo.modules.module import Energy, MeasureInterval, Module
 
 if TYPE_CHECKING:
     from pyatmo.auth import AbstractAsyncAuth
@@ -31,7 +31,11 @@
 class AsyncAccount:
     """Async class of a Netatmo account."""
 
-    def __init__(self, auth: AbstractAsyncAuth, favorite_stations: bool = True) -> None:
+    def __init__(
+        self,
+        auth: AbstractAsyncAuth,
+        favorite_stations: bool = True,  # noqa: FBT001, FBT002
+    ) -> None:
         """Initialize the Netatmo account."""
 
         self.auth: AbstractAsyncAuth = auth
@@ -72,7 +76,8 @@ def process_topology(self, disabled_homes_ids: list[str] | None = None) -> None:
                 self.homes[home_id] = Home(self.auth, raw_data=home)
 
     async def async_update_topology(
-        self, disabled_homes_ids: list[str] | None = None
+        self,
+        disabled_homes_ids: list[str] | None = None,
     ) -> None:
         """Retrieve topology data from /homesdata."""
 
@@ -126,12 +131,15 @@ async def async_update_measures(
     ) -> None:
         """Retrieve measures data from /getmeasure."""
 
-        await getattr(self.homes[home_id].modules[module_id], "async_update_measures")(
-            start_time=start_time,
-            end_time=end_time,
-            interval=interval,
-            days=days,
-        )
+        module = self.homes[home_id].modules[module_id]
+        if module.has_feature("historical_data"):
+            module = cast(Energy, module)
+            await module.async_update_measures(
+                start_time=start_time,
+                end_time=end_time,
+                interval=interval,
+                days=days,
+            )
 
     def register_public_weather_area(
         self,
@@ -140,7 +148,7 @@ def register_public_weather_area(
         lat_sw: str,
         lon_sw: str,
         required_data_type: str | None = None,
-        filtering: bool = False,
+        filtering: bool = False,  # noqa: FBT001, FBT002
         *,
         area_id: str = str(uuid4()),
     ) -> str:

src/pyatmo/auth.py

@@ -8,7 +8,13 @@
 import logging
 from typing import Any
 
-from aiohttp import ClientError, ClientResponse, ClientSession, ContentTypeError
+from aiohttp import (
+    ClientError,
+    ClientResponse,
+    ClientSession,
+    ClientTimeout,
+    ContentTypeError,
+)
 
 from pyatmo.const import (
     AUTHORIZATION_HEADER,
@@ -51,27 +57,32 @@ async def async_get_image(
         try:
             access_token = await self.async_get_access_token()
         except ClientError as err:
-            raise ApiError(f"Access token failure: {err}") from err
+            error_type = type(err).__name__
+            msg = f"Access token failure: {error_type} - {err}"
+            raise ApiError(msg) from err
         headers = {AUTHORIZATION_HEADER: f"Bearer {access_token}"}
 
         req_args = {"data": params if params is not None else {}}
 
         url = (base_url or self.base_url) + endpoint
         async with self.websession.get(
             url,
-            **req_args,  # type: ignore
+            **req_args,  # type: ignore  # noqa: PGH003
             headers=headers,
-            timeout=timeout,
+            timeout=ClientTimeout(total=timeout),
         ) as resp:
             resp_content = await resp.read()
 
             if resp.headers.get("content-type") == "image/jpeg":
                 return resp_content
 
-        raise ApiError(
+        msg = (
             f"{resp.status} - "
             f"invalid content-type in response"
-            f"when accessing '{url}'",
+            f"when accessing '{url}'"
+        )
+        raise ApiError(
+            msg,
         )
 
     async def async_post_api_request(
@@ -104,20 +115,21 @@ async def async_post_request(
 
         async with self.websession.post(
             url,
-            **req_args,
+            **req_args,  # type: ignore  # noqa: PGH003
             headers=headers,
-            timeout=timeout,
+            timeout=ClientTimeout(total=timeout),
         ) as resp:
             return await self.process_response(resp, url)
 
-    async def get_access_token(self):
+    async def get_access_token(self) -> str:
         """Get access token."""
         try:
             return await self.async_get_access_token()
         except ClientError as err:
-            raise ApiError(f"Access token failure: {err}") from err
+            msg = f"Access token failure: {err}"
+            raise ApiError(msg) from err
 
-    def prepare_request_arguments(self, params):
+    def prepare_request_arguments(self, params: dict | None) -> dict:
         """Prepare request arguments."""
         req_args = {"data": params if params is not None else {}}
 
@@ -131,7 +143,7 @@ def prepare_request_arguments(self, params):
 
         return req_args
 
-    async def process_response(self, resp, url):
+    async def process_response(self, resp: ClientResponse, url: str) -> ClientResponse:
         """Process response."""
         resp_status = resp.status
         resp_content = await resp.read()
@@ -142,7 +154,12 @@ async def process_response(self, resp, url):
 
         return await self.handle_success_response(resp, resp_content)
 
-    async def handle_error_response(self, resp, resp_status, url):
+    async def handle_error_response(
+        self,
+        resp: ClientResponse,
+        resp_status: int,
+        url: str,
+    ) -> None:
         """Handle error response."""
         try:
             resp_json = await resp.json()
@@ -159,19 +176,25 @@ async def handle_error_response(self, resp, resp_status, url):
                 raise ApiErrorThrottling(
                     message,
                 )
-            else:
-                raise ApiError(
-                    message,
-                )
+            raise ApiError(
+                message,
+            )
 
         except (JSONDecodeError, ContentTypeError) as exc:
-            raise ApiError(
+            msg = (
                 f"{resp_status} - "
                 f"{ERRORS.get(resp_status, '')} - "
-                f"when accessing '{url}'",
+                f"when accessing '{url}'"
+            )
+            raise ApiError(
+                msg,
             ) from exc
 
-    async def handle_success_response(self, resp, resp_content):
+    async def handle_success_response(
+        self,
+        resp: ClientResponse,
+        resp_content: bytes,
+    ) -> ClientResponse:
         """Handle success response."""
         try:
             if "application/json" in resp.headers.get("content-type", []):
@@ -193,7 +216,8 @@ async def async_addwebhook(self, webhook_url: str) -> None:
                 params={"url": webhook_url},
             )
         except asyncio.exceptions.TimeoutError as exc:
-            raise ApiError("Webhook registration timed out") from exc
+            msg = "Webhook registration timed out"
+            raise ApiError(msg) from exc
         else:
             LOG.debug("addwebhook: %s", resp)
 
@@ -205,6 +229,7 @@ async def async_dropwebhook(self) -> None:
                 params={"app_types": "app_security"},
             )
         except asyncio.exceptions.TimeoutError as exc:
-            raise ApiError("Webhook registration timed out") from exc
+            msg = "Webhook registration timed out"
+            raise ApiError(msg) from exc
         else:
             LOG.debug("dropwebhook: %s", resp)

src/pyatmo/const.py

@@ -106,3 +106,6 @@
 MAX_HISTORY_TIME_FRAME = 24 * 2 * 3600
 
 UNKNOWN = "unknown"
+
+ON = True
+OFF = False