refactor: improve type hints (#273)

* refactor: add type hints

* refactor: create to_payload for load_balancer domains

* chore: enable mypy disallow_untyped_defs

Author: jooola

hcloud/_client.py

@@ -1,6 +1,7 @@
 from __future__ import annotations
 
 import time
+from typing import NoReturn
 
 import requests
 
@@ -167,21 +168,21 @@ def _get_headers(self) -> dict:
         }
         return headers
 
-    def _raise_exception_from_response(self, response: requests.Response):
+    def _raise_exception_from_response(self, response: requests.Response) -> NoReturn:
         raise APIException(
             code=response.status_code,
             message=response.reason,
             details={"content": response.content},
         )
 
-    def _raise_exception_from_content(self, content: dict):
+    def _raise_exception_from_content(self, content: dict) -> NoReturn:
         raise APIException(
             code=content["error"]["code"],
             message=content["error"]["message"],
             details=content["error"]["details"],
         )
 
-    def request(
+    def request(  # type: ignore[no-untyped-def]
         self,
         method: str,
         url: str,

hcloud/core/client.py

@@ -19,7 +19,7 @@ def __init__(self, client: Client):
         """
         self._client = client
 
-    def _get_all(
+    def _get_all(  # type: ignore[no-untyped-def]
         self,
         list_function: Callable,
         *args,
@@ -49,11 +49,11 @@ def _get_all(
 
         return results
 
-    def get_all(self, *args, **kwargs) -> list:
+    def get_all(self, *args, **kwargs) -> list:  # type: ignore[no-untyped-def]
         assert hasattr(self, "get_list")
         return self._get_all(self.get_list, *args, **kwargs)
 
-    def get_actions(self, *args, **kwargs) -> list[BoundAction]:
+    def get_actions(self, *args, **kwargs) -> list[BoundAction]:  # type: ignore[no-untyped-def]
         if not hasattr(self, "get_actions_list"):
             raise ValueError("this endpoint does not support get_actions method")
 
@@ -65,7 +65,7 @@ class GetEntityByNameMixin:
     Use as a mixin for ClientEntityBase classes
     """
 
-    def get_by_name(self, name: str):
+    def get_by_name(self, name: str):  # type: ignore[no-untyped-def]
         assert hasattr(self, "get_list")
         entities, _ = self.get_list(name=name)
         return entities[0] if entities else None
@@ -94,7 +94,7 @@ def __init__(
         self.complete = complete
         self.data_model = self.model.from_dict(data)
 
-    def __getattr__(self, name: str):
+    def __getattr__(self, name: str):  # type: ignore[no-untyped-def]
         """Allow magical access to the properties of the model
         :param name: str
         :return:
@@ -105,8 +105,9 @@ def __getattr__(self, name: str):
             value = getattr(self.data_model, name)
         return value
 
-    def reload(self):
+    def reload(self) -> None:
         """Reloads the model and tries to get all data from the APIx"""
+        assert hasattr(self._client, "get_by_id")
         bound_model = self._client.get_by_id(self.data_model.id)
         self.data_model = bound_model.data_model
         self.complete = True

hcloud/core/domain.py

@@ -5,7 +5,7 @@ class BaseDomain:
     __slots__ = ()
 
     @classmethod
-    def from_dict(cls, data: dict):
+    def from_dict(cls, data: dict):  # type: ignore[no-untyped-def]
         supported_data = {k: v for k, v in data.items() if k in cls.__slots__}
         return cls(**supported_data)
 

hcloud/firewalls/domain.py

@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-from typing import TYPE_CHECKING
+from typing import TYPE_CHECKING, Any
 
 from dateutil.parser import isoparse
 
@@ -33,12 +33,12 @@ class Firewall(BaseDomain):
 
     def __init__(
         self,
-        id=None,
-        name=None,
-        labels=None,
-        rules=None,
-        applied_to=None,
-        created=None,
+        id: int | None = None,
+        name: str | None = None,
+        labels: dict[str, str] | None = None,
+        rules: list[FirewallRule] | None = None,
+        applied_to: list[FirewallResource] | None = None,
+        created: str | None = None,
     ):
         self.id = id
         self.name = name
@@ -107,18 +107,18 @@ def __init__(
         self.destination_ips = destination_ips or []
         self.description = description
 
-    def to_payload(self):
-        payload = {
+    def to_payload(self) -> dict[str, Any]:
+        payload: dict[str, Any] = {
             "direction": self.direction,
             "protocol": self.protocol,
             "source_ips": self.source_ips,
         }
         if len(self.destination_ips) > 0:
-            payload.update({"destination_ips": self.destination_ips})
+            payload["destination_ips"] = self.destination_ips
         if self.port is not None:
-            payload.update({"port": self.port})
+            payload["port"] = self.port
         if self.description is not None:
-            payload.update({"description": self.description})
+            payload["description"] = self.description
         return payload
 
 
@@ -150,15 +150,13 @@ def __init__(
         self.server = server
         self.label_selector = label_selector
 
-    def to_payload(self):
-        payload = {"type": self.type}
+    def to_payload(self) -> dict[str, Any]:
+        payload: dict[str, Any] = {"type": self.type}
         if self.server is not None:
-            payload.update({"server": {"id": self.server.id}})
+            payload["server"] = {"id": self.server.id}
 
         if self.label_selector is not None:
-            payload.update(
-                {"label_selector": {"selector": self.label_selector.selector}}
-            )
+            payload["label_selector"] = {"selector": self.label_selector.selector}
         return payload
 
 
@@ -168,7 +166,7 @@ class FirewallResourceLabelSelector(BaseDomain):
     :param selector: str Target label selector
     """
 
-    def __init__(self, selector=None):
+    def __init__(self, selector: str | None = None):
         self.selector = selector
 
 

hcloud/floating_ips/domain.py

@@ -8,6 +8,8 @@
 
 if TYPE_CHECKING:
     from ..actions import BoundAction
+    from ..locations import BoundLocation
+    from ..servers import BoundServer
     from .client import BoundFloatingIP
 
 
@@ -57,18 +59,18 @@ class FloatingIP(BaseDomain):
 
     def __init__(
         self,
-        id=None,
-        type=None,
-        description=None,
-        ip=None,
-        server=None,
-        dns_ptr=None,
-        home_location=None,
-        blocked=None,
-        protection=None,
-        labels=None,
-        created=None,
-        name=None,
+        id: int | None = None,
+        type: str | None = None,
+        description: str | None = None,
+        ip: str | None = None,
+        server: BoundServer | None = None,
+        dns_ptr: list[dict] | None = None,
+        home_location: BoundLocation | None = None,
+        blocked: bool | None = None,
+        protection: dict | None = None,
+        labels: dict[str, str] | None = None,
+        created: str | None = None,
+        name: str | None = None,
     ):
         self.id = id
         self.type = type

hcloud/isos/domain.py

@@ -26,12 +26,12 @@ class Iso(BaseDomain, DomainIdentityMixin):
 
     def __init__(
         self,
-        id=None,
-        name=None,
-        type=None,
-        architecture=None,
-        description=None,
-        deprecated=None,
+        id: int | None = None,
+        name: str | None = None,
+        type: str | None = None,
+        architecture: str | None = None,
+        description: str | None = None,
+        deprecated: str | None = None,
     ):
         self.id = id
         self.name = name

hcloud/load_balancer_types/domain.py

@@ -38,14 +38,14 @@ class LoadBalancerType(BaseDomain, DomainIdentityMixin):
 
     def __init__(
         self,
-        id=None,
-        name=None,
-        description=None,
-        max_connections=None,
-        max_services=None,
-        max_targets=None,
-        max_assigned_certificates=None,
-        prices=None,
+        id: int | None = None,
+        name: str | None = None,
+        description: str | None = None,
+        max_connections: int | None = None,
+        max_services: int | None = None,
+        max_targets: int | None = None,
+        max_assigned_certificates: int | None = None,
+        prices: dict | None = None,
     ):
         self.id = id
         self.name = name