Resolve "Timeout for clients can't be modified unless self.TIMEOUT is set" (#457)

Fix the timeout evaluation and testing it using a helper function.

Closes #456

Author: btschwertfeger

src/kraken/base_api/__init__.py

@@ -47,6 +47,15 @@ def defined(value: Any) -> bool:  # noqa: ANN401
     return value is not None
 
 
+def _resolve_timeout(timeout: int, default: int, class_timeout: int) -> int:
+    """
+    Resolves the timeout to use for a request: the explicitly passed
+    ``timeout`` if it deviates from the ``request`` method's ``default``,
+    otherwise the client's ``TIMEOUT`` class attribute.
+    """
+    return class_timeout if timeout == default else timeout
+
+
 def ensure_string(parameter_name: str) -> Callable:
     """
     This function is intended to be used as decorator
@@ -376,7 +385,7 @@ def request(  # noqa: PLR0913 # pylint: disable=too-many-arguments
             extra_params=extra_params,
         )
 
-        timeout: int = self.TIMEOUT if timeout != 10 else timeout  # type: ignore[no-redef]
+        timeout = _resolve_timeout(timeout, 10, self.TIMEOUT)
         self.__check_renew_session()
 
         if method in {"GET", "DELETE"}:
@@ -605,7 +614,7 @@ async def request(  # type: ignore[override] # pylint: disable=invalid-overridde
             query_str=query_str,
             extra_params=extra_params,
         )
-        timeout: int = self.TIMEOUT if timeout != 10 else timeout  # type: ignore[no-redef]
+        timeout = _resolve_timeout(timeout, 10, self.TIMEOUT)
         await self.__check_renew_session()
 
         if method in {"GET", "DELETE"}:
@@ -884,7 +893,7 @@ def request(  # pylint: disable=too-many-arguments
             auth=auth,
             extra_params=extra_params,
         )
-        timeout: int = self.TIMEOUT if timeout == 10 else timeout  # type: ignore[no-redef]
+        timeout = _resolve_timeout(timeout, 10, self.TIMEOUT)
         self.__check_renew_session()
 
         if method in {"GET", "DELETE"}:
@@ -1083,7 +1092,7 @@ async def request(  # type: ignore[override] # pylint: disable=arguments-differ,
             auth=auth,
         )
 
-        timeout = self.TIMEOUT if timeout != 10 else timeout
+        timeout = _resolve_timeout(timeout, 10, self.TIMEOUT)
         await self.__check_renew_session()
 
         if method in {"GET", "DELETE"}:

tests/spot/test_spot_base_api_unit.py

@@ -18,6 +18,7 @@
 
 import pytest
 
+from kraken import base_api
 from kraken.base_api import ErrorHandler, SpotClient, defined, ensure_string
 from kraken.exceptions import KrakenInsufficientFundsError
 
@@ -38,6 +39,14 @@ def test_defined(self: Self) -> None:
         assert defined([]) is True
         assert defined(None) is False
 
+    def test_resolve_timeout_falls_back_to_class_timeout(self: Self) -> None:
+        """Leaving ``timeout`` at the ``request`` default uses ``class_timeout``."""
+        assert base_api._resolve_timeout(timeout=10, default=10, class_timeout=42) == 42
+
+    def test_resolve_timeout_uses_explicit_value(self: Self) -> None:
+        """A ``timeout`` deviating from the default is used as-is."""
+        assert base_api._resolve_timeout(timeout=5, default=10, class_timeout=42) == 5
+
     def test_ensure_string_joins_list(self: Self) -> None:
         """A list argument is collapsed into a comma-joined string."""