Initial fixes

Author: iMicknl

pyproject.toml

@@ -50,9 +50,35 @@ only-packages = true
 line-length = 140
 target-version = "py39"
 
+
 [tool.ruff.lint]
-select = ["E", "F", "UP", "B", "SIM", "I", "N"]
-ignore = ["E501"]
+select = [
+    # pydocstyle
+    "D",
+    # flake8-async
+    "ASYNC",
+    # pycodestyle
+    "E",
+    # Pyflakes
+    "F",
+    # pyupgrade
+    "UP",
+    # flake8-bugbear
+    "B",
+    # flake8-simplify
+    "SIM",
+    # isort
+    "I",
+    # ruff
+    "RUF",
+    # flake8-bandit (security)
+    "S",
+    # flake8-print
+    "T",
+    # flake8-comprehensions
+    "C4",
+]
+ignore = ["E501"] # Line too long
 
 [tool.pytest.ini_options]
 asyncio_mode = "auto"
@@ -69,3 +95,15 @@ markers = [
     "asyncio: mark test as an asyncio test",
     "integration: mark test as an integration test (requires router access)",
 ]
+
+[tool.mypy]
+exclude = ["tests/"]
+ignore_missing_imports = true
+
+[tool.ty.src]
+exclude = ["tests/"]
+
+[tool.ty.rules]
+# This project uses both mypy and ty; mypy's `type: ignore` comments
+# should not be flagged as unused by ty.
+unused-type-ignore-comment = "ignore"

sagemcom_api/client.py

@@ -79,8 +79,7 @@ def __init__(
         ssl: bool | None = False,
         verify_ssl: bool | None = True,
     ):
-        """
-        Create a SagemCom client.
+        """Create a SagemCom client.
 
         :param host: the host of your Sagemcom router
         :param username: the username for your Sagemcom router
@@ -203,7 +202,8 @@ def __get_response_value(self, response, index=0):
             value = None
 
         # Rewrite result to snake_case
-        value = humps.decamelize(value)
+        if value is not None:
+            value = humps.decamelize(value)
 
         return value
 
@@ -231,9 +231,7 @@ async def __post(self, url, data):
             error = self.__get_response_error(result)
 
             # No errors
-            if (
-                error["description"] == XMO_REQUEST_NO_ERR or error["description"] == "Ok"  # NOQA: W503
-            ):
+            if error["description"] == XMO_REQUEST_NO_ERR or error["description"] == "Ok":
                 return result
 
             if error["description"] == XMO_INVALID_SESSION_ERR:
@@ -308,7 +306,6 @@ async def __api_request_async(self, actions, priority=False):
 
     async def login(self):
         """Login to the SagemCom F@st router using a username and password."""
-
         actions = {
             "id": 0,
             "method": "logIn",
@@ -361,7 +358,7 @@ async def logout(self):
 
     async def get_encryption_method(self):
         """Determine which encryption method to use for authentication and set it directly."""
-        for encryption_method in EncryptionMethod:
+        for encryption_method in EncryptionMethod:  # ty: ignore[not-iterable]
             try:
                 self.authentication_method = encryption_method
                 self._password_hash = self.__generate_hash(self.password, encryption_method)
@@ -394,8 +391,7 @@ async def get_encryption_method(self):
         on_backoff=retry_login,
     )
     async def get_value_by_xpath(self, xpath: str, options: dict | None = None) -> dict:
-        """
-        Retrieve raw value from router using XPath.
+        """Retrieve raw value from router using XPath.
 
         :param xpath: path expression
         :param options: optional options
@@ -424,8 +420,7 @@ async def get_value_by_xpath(self, xpath: str, options: dict | None = None) -> d
         on_backoff=retry_login,
     )
     async def get_values_by_xpaths(self, xpaths, options: dict | None = None) -> dict:
-        """
-        Retrieve raw values from router using XPath.
+        """Retrieve raw values from router using XPath.
 
         :param xpaths: Dict of key to xpath expression
         :param options: optional options
@@ -458,8 +453,7 @@ async def get_values_by_xpaths(self, xpaths, options: dict | None = None) -> dic
         on_backoff=retry_login,
     )
     async def set_value_by_xpath(self, xpath: str, value: str, options: dict | None = None) -> dict:
-        """
-        Retrieve raw value from router using XPath.
+        """Retrieve raw value from router using XPath.
 
         :param xpath: path expression
         :param value: value

sagemcom_api/enums.py

@@ -8,7 +8,7 @@
 if sys.version_info >= (3, 11):
     from enum import StrEnum
 else:
-    from backports.strenum import StrEnum
+    from backports.strenum import StrEnum  # ty: ignore[unresolved-import]
 
 
 @unique

sagemcom_api/models.py

@@ -2,7 +2,7 @@
 
 import dataclasses
 from dataclasses import dataclass
-from typing import Any, List, Optional
+from typing import Any, Optional
 
 
 # pylint: disable=too-many-instance-attributes
@@ -40,12 +40,12 @@ class Device:
     unblock_hours_count: Optional[int] = None
     blacklist_status: Optional[bool] = None
     blacklisted_according_to_schedule: Optional[bool] = None
-    blacklisted_schedule: Optional[List] = None
+    blacklisted_schedule: Optional[list] = None
     hidden: Optional[bool] = None
-    options: Optional[List] = None
+    options: Optional[list] = None
     vendor_class_idv6: Optional[Any] = None
-    ipv4_addresses: Optional[List] = None
-    ipv6_addresses: Optional[List] = None
+    ipv4_addresses: Optional[list] = None
+    ipv6_addresses: Optional[list] = None
     device_type_association: Optional[Any] = None
 
     # pylint:disable=fixme
@@ -60,7 +60,7 @@ def __init__(self, **kwargs):
     @property
     def id(self):
         """Return unique ID for device."""
-        return self.phys_address.upper()
+        return self.phys_address.upper() if self.phys_address else None
 
     @property
     def name(self):

tests/conftest.py

@@ -4,7 +4,7 @@
 
 import json
 from pathlib import Path
-from typing import Any, Dict, List
+from typing import Any
 from unittest.mock import AsyncMock, MagicMock
 
 import pytest
@@ -17,9 +17,8 @@
 FIXTURES_DIR = Path(__file__).parent / "fixtures"
 
 
-def load_fixture(filename: str) -> Dict[str, Any]:
-    """
-    Load a JSON fixture file.
+def load_fixture(filename: str) -> dict[str, Any]:
+    """Load a JSON fixture file.
 
     :param filename: Name of the fixture file (e.g., 'login_success.json')
     :return: Parsed JSON data as dict
@@ -30,45 +29,44 @@ def load_fixture(filename: str) -> Dict[str, Any]:
 
 
 @pytest.fixture
-def login_success_response() -> Dict[str, Any]:
+def login_success_response() -> dict[str, Any]:
     """Mock response for successful login."""
     return load_fixture("login_success.json")
 
 
 @pytest.fixture
-def login_auth_error_response() -> Dict[str, Any]:
+def login_auth_error_response() -> dict[str, Any]:
     """Mock response for authentication error."""
     return load_fixture("login_auth_error.json")
 
 
 @pytest.fixture
-def login_invalid_session_response() -> Dict[str, Any]:
+def login_invalid_session_response() -> dict[str, Any]:
     """Mock response for invalid session error."""
     return load_fixture("login_invalid_session.json")
 
 
 @pytest.fixture
-def device_info_response() -> Dict[str, Any]:
+def device_info_response() -> dict[str, Any]:
     """Mock response for device info query."""
     return load_fixture("device_info.json")
 
 
 @pytest.fixture
-def hosts_response() -> Dict[str, Any]:
+def hosts_response() -> dict[str, Any]:
     """Mock response for hosts query."""
     return load_fixture("hosts.json")
 
 
 @pytest.fixture
-def xpath_value_response() -> Dict[str, Any]:
+def xpath_value_response() -> dict[str, Any]:
     """Mock response for generic XPath getValue."""
     return load_fixture("xpath_value.json")
 
 
 @pytest.fixture
 def mock_session_factory():
-    """
-    Factory fixture for creating mock aiohttp ClientSession.
+    """Factory fixture for creating mock aiohttp ClientSession.
 
     Returns a factory function that creates a mock session with configurable responses.
     Mock responses are consumed in sequence (first call gets first response, etc.).
@@ -80,9 +78,8 @@ def mock_session_factory():
     :return: Factory function that takes list of response dicts
     """
 
-    def _create_mock_session(responses: List[Dict[str, Any]]) -> ClientSession:
-        """
-        Create a mock ClientSession with specified responses.
+    def _create_mock_session(responses: list[dict[str, Any]]) -> ClientSession:
+        """Create a mock ClientSession with specified responses.
 
         :param responses: List of response dictionaries to return in sequence
         :return: Mock ClientSession
@@ -120,8 +117,7 @@ def _create_mock_session(responses: List[Dict[str, Any]]) -> ClientSession:
 
 @pytest.fixture
 def mock_client_md5(mock_session_factory, login_success_response):
-    """
-    Create a SagemcomClient with MD5 encryption and mocked session.
+    """Create a SagemcomClient with MD5 encryption and mocked session.
 
     Pre-configured with successful login response.
 
@@ -139,8 +135,7 @@ def mock_client_md5(mock_session_factory, login_success_response):
 
 @pytest.fixture
 def mock_client_sha512(mock_session_factory, login_success_response):
-    """
-    Create a SagemcomClient with SHA512 encryption and mocked session.
+    """Create a SagemcomClient with SHA512 encryption and mocked session.
 
     Pre-configured with successful login response.
 
@@ -158,8 +153,7 @@ def mock_client_sha512(mock_session_factory, login_success_response):
 
 @pytest.fixture
 def mock_client_md5_nonce(mock_session_factory, login_success_response):
-    """
-    Create a SagemcomClient with MD5_NONCE encryption and mocked session.
+    """Create a SagemcomClient with MD5_NONCE encryption and mocked session.
 
     Pre-configured with successful login response.
 

tests/unit/test_client_basic.py

@@ -11,8 +11,7 @@
 
 @pytest.mark.asyncio
 async def test_login_success(mock_session_factory, login_success_response):
-    """
-    Test successful login with mocked session.
+    """Test successful login with mocked session.
 
     Demonstrates:
     - Mocking aiohttp session at session.post level
@@ -41,8 +40,7 @@ async def test_login_success(mock_session_factory, login_success_response):
 
 @pytest.mark.asyncio
 async def test_login_authentication_error(mock_session_factory, login_auth_error_response):
-    """
-    Test login raises AuthenticationException on XMO_AUTHENTICATION_ERR.
+    """Test login raises AuthenticationException on XMO_AUTHENTICATION_ERR.
 
     Demonstrates:
     - Mocking error responses from the API
@@ -69,8 +67,7 @@ async def test_login_authentication_error(mock_session_factory, login_auth_error
 
 @pytest.mark.asyncio
 async def test_get_value_by_xpath_url_encoding(mock_session_factory, login_success_response, xpath_value_response):
-    """
-    Test XPath values are URL-encoded with safe characters preserved.
+    """Test XPath values are URL-encoded with safe characters preserved.
 
     Demonstrates:
     - XPath URL encoding behavior
@@ -108,8 +105,7 @@ async def test_get_value_by_xpath_url_encoding(mock_session_factory, login_succe
 
 @pytest.mark.asyncio
 async def test_login_with_preconfigured_fixture(mock_client_sha512):
-    """
-    Test login using pre-configured client fixture.
+    """Test login using pre-configured client fixture.
 
     Demonstrates:
     - Using pre-configured client fixtures for concise tests