chore: improves python typing hints

Author: becelot

hostingde/__init__.py

@@ -0,0 +1,4 @@
+from .client import HostingDeClient
+from .paginator import HostingDePaginator
+
+__all__ = ['HostingDeClient', 'HostingDePaginator']

hostingde/account/account.py

@@ -16,7 +16,7 @@ def __init__(self, parent: HostingDeCore):
         """
         super().__init__(parent)
 
-    def build_uri(self, method: str):
+    def build_uri(self, method: str) -> str:
         """
         Utility method to easily construct URLs for this service.
 
@@ -30,8 +30,8 @@ def list_subaccounts_names(
         limit: Optional[int] = None,
         filter: Optional[FilterElement] = None,
         sort: Optional[SortConfiguration] = None,
-        *args,
-        **kwargs
+        *args: list,
+        **kwargs: dict
     ) -> HostingDePaginator[Account]:
         """
         List subaccounts for the current context.

hostingde/api.py

@@ -2,7 +2,7 @@
 from hostingde.exceptions import ClientException
 
 
-def login(base_url: str, token: str):
+def login(base_url: str, token: str) -> HostingDeClient:
     """
     Entry point for the client. Builds and logs the user in.
 

hostingde/dns/dns.py

@@ -24,7 +24,7 @@ def __init__(self, parent: HostingDeCore):
         """
         super().__init__(parent)
 
-    def build_uri(self, method: str):
+    def build_uri(self, method: str) -> str:
         """
         Utility method to easily construct URLs for this service.
 
@@ -38,8 +38,8 @@ def list_zones(
         limit: Optional[int] = None,
         filter: Optional[FilterElement] = None,
         sort: Optional[SortConfiguration] = None,
-        *args,
-        **kwargs
+        *args: list,
+        **kwargs: dict
     ) -> HostingDePaginator[Zone]:
         """
         Retrieves a list of Zone objects from the generic filtering and sorting API.
@@ -113,9 +113,9 @@ def list_zone_configs(
         limit: Optional[int] = None,
         filter: Optional[FilterElement] = None,
         sort: Optional[SortConfiguration] = None,
-        *args,
-        **kwargs
-    ) -> HostingDePaginator[Zone]:
+        *args: list,
+        **kwargs: dict
+    ) -> HostingDePaginator[ZoneConfig]:
         """
         Retrieves a list of ZoneConfig objects from the generic filtering and sorting API.
 
@@ -174,8 +174,8 @@ def list_records(
         limit: Optional[int] = None,
         filter: Optional[FilterElement] = None,
         sort: Optional[SortConfiguration] = None,
-        *args,
-        **kwargs
+        *args: list,
+        **kwargs: dict
     ) -> HostingDePaginator[Record]:
         """
         Retrieves a list of Record objects from the generic filtering and sorting API.
@@ -245,8 +245,8 @@ def jobs_find(
         limit: Optional[int] = None,
         filter: Optional[FilterElement] = None,
         sort: Optional[SortConfiguration] = None,
-        *args,
-        **kwargs
+        *args: list,
+        **kwargs: dict
     ) -> HostingDePaginator[Job]:
         """
         Retrieves a list of Job objects from the generic filtering and sorting API.
@@ -297,10 +297,12 @@ def update_zone(
             ),
         )
 
-        if not asynchronous:
-            JobWaiter(self, zone_config.id).wait()
+        zone = self._instance(Zone, response.json().get('response', {}))
+
+        if not asynchronous and zone.zone_config.id is not None:
+            JobWaiter(self, zone.zone_config.id).wait()
 
-        return self._instance(Zone, response.json().get('response', {}))
+        return zone
 
     def create_zone(
         self,
@@ -342,7 +344,7 @@ def create_zone(
 
         zone: Zone = self._instance(Zone, response.json().get('response', {}))
 
-        if not asynchronous:
+        if not asynchronous and zone.zone_config.id is not None:
             JobWaiter(self, zone.zone_config.id).wait()
 
         return zone

hostingde/exceptions.py

@@ -3,11 +3,11 @@ class ApiException(Exception):
     The client throws an API exception, whenever the error was unknown. Details are included in the exception.
     """
 
-    def __init__(self, details: dict, *args, **kwargs):
+    def __init__(self, details: dict, *args: list, **kwargs: dict) -> None:
         super().__init__(args, kwargs)
         self.details = details
 
-    def __str__(self):
+    def __str__(self) -> str:
         return "\n".join([f"{error.get('text')}" for error in self.details.get('errors', [])])
 
 

hostingde/hostingde.py

@@ -1,15 +1,18 @@
 import json.decoder
 from contextlib import contextmanager
-from typing import Optional, Type
+from typing import Generator, Optional, Type, TypeVar
 
 from requests import Response
 
+import hostingde
 from hostingde.exceptions import ApiException, ClientException
 from hostingde.model import Model
 from hostingde.model.filter import FilterElement
 from hostingde.model.sort import SortConfiguration
 from hostingde.session import HostingDeSession
 
+T = TypeVar('T', bound='Model')
+
 
 class HostingDeCore:
     def __init__(self, parent: 'HostingDeCore' = None):
@@ -31,7 +34,7 @@ def _post(self, *args, **kwargs):
         """
         return self.session.post(*args, **kwargs)
 
-    def _request(self, url, model: Optional[Model] = None, **kwargs):
+    def _request(self, url: str, model: Optional[Model] = None, **kwargs: dict) -> Response:
         """
         Execute a new request, given an URL and a model. To generate a URL, you can use the _build_url() utility
         method.
@@ -56,17 +59,17 @@ def _request(self, url, model: Optional[Model] = None, **kwargs):
 
         return response
 
-    def _instance(self, instance_type: Type[Model], data: dict):
+    def _instance(self, instance_type: Type[T], data: dict) -> T:
         """
         Reconstructs a model from the passed in result.
 
         :param instance_type: The instance type to be reconstructed.
         :param data: The data used to reconstruct the model
         :return: The parsed model
         """
-        return instance_type.from_json(data)
+        return instance_type.from_json(data, self)  # type: ignore
 
-    def _bool(self, response: Response):
+    def _bool(self, response: Response) -> bool:
         """
         Converts a response to a boolean. True, if the request succeeded, otherwise False. Note that a status of
         'pending' also returns False. You may want to use the _async method to wait for the job to complete.
@@ -89,11 +92,11 @@ def _build_uri(self, service: str, method: str) -> str:
     def _iter(
         self,
         url: str,
-        instance_class: Type[Model],
+        instance_class: Type[T],
         filter: Optional[FilterElement] = None,
         limit: Optional[int] = None,
         sort: Optional[SortConfiguration] = None,
-    ):
+    ) -> 'hostingde.HostingDePaginator[T]':
         """
         Use the generic filtering and sorting API to paginate over results.
 
@@ -104,9 +107,8 @@ def _iter(
         :param sort: The sorting of the resulting list
         :return: The iterator for the resultset
         """
-        from hostingde.paginator import HostingDePaginator
 
-        return HostingDePaginator(self, instance_class, url, filter=filter, limit=limit, sort=sort)
+        return hostingde.HostingDePaginator(self, instance_class, url, filter=filter, limit=limit, sort=sort)
 
     def login(self, url: str, token: str) -> None:
         """
@@ -118,7 +120,7 @@ def login(self, url: str, token: str) -> None:
         self.session.base_uri = url
         self.session.token_auth(token)
 
-    def set_account_context(self, account_id: str):
+    def set_account_context(self, account_id: Optional[str]) -> None:
         """
         Sets the account context for this client.
 
@@ -128,15 +130,15 @@ def set_account_context(self, account_id: str):
         self.session.set_account_context(account_id)
 
     @contextmanager
-    def switch_account_context(self, account_id: str):
+    def switch_account_context(self, account_id: str) -> Generator[None, None, None]:
         """
         Temporarily switch the account context for this client. After the context guard closes, the context is reset to
         the account that was used prior to the guard.
 
         :param account_id: The account id to switch to
         :return:
         """
-        old_id: str = self.session.get_account_context()
+        old_id: Optional[str] = self.session.get_account_context()
 
         self.session.set_account_context(account_id)
 
@@ -145,7 +147,7 @@ def switch_account_context(self, account_id: str):
         self.session.set_account_context(old_id)
 
     @staticmethod
-    def new_session():
+    def new_session() -> HostingDeSession:
         """
         Generates a new, unauthenticated session
 

hostingde/job_waiter.py

@@ -15,8 +15,8 @@ def jobs_find(
         limit: Optional[int] = None,
         filter: Optional[FilterElement] = None,
         sort: Optional[SortConfiguration] = None,
-        *args,
-        **kwargs
+        *args: list,
+        **kwargs: dict
     ) -> HostingDePaginator[Job]:
         """
         Retrieves a list of Job objects from the generic filtering and sorting API.
@@ -34,7 +34,7 @@ def __init__(self, service: AsynchronousClient, id: str):
         self.service = service
         self.id = id
 
-    def wait(self):
+    def wait(self) -> None:
         while True:
             jobs = self.service.jobs_find(
                 filter=FilterCondition('jobObjectId').eq(self.id)

hostingde/model/__init__.py

@@ -1,8 +1,13 @@
+from typing import Any, Optional, Type, TypeVar
+
 import marshmallow_dataclass
 from marshmallow import post_dump, Schema
+from marshmallow.fields import Field
+
+import hostingde
 
 
-def camelcase(s):
+def camelcase(s: str) -> str:
     parts = iter(s.split("_"))
     return next(parts) + "".join(i.title() for i in parts)
 
@@ -14,15 +19,15 @@ class CamelCaseSchema(Schema):
 
     SKIP_VALUES = {None}
 
-    def __init__(self, **kwargs):
+    def __init__(self, **kwargs: Any):
         super().__init__(unknown='EXCLUDE', **kwargs)
 
-    def on_bind_field(self, field_name, field_obj):
+    def on_bind_field(self, field_name: str, field_obj: Field) -> None:
         """Use lower-camel-casing as external representation"""
         field_obj.data_key = camelcase(field_obj.data_key or field_name)
 
     @post_dump
-    def remove_skip_values(self, data, **kwargs):
+    def remove_skip_values(self, data: dict, **kwargs: dict) -> dict:
         """
         Remove None values from the serialization result
         :param data: The input data (dict). Already serialized, but may contain None values
@@ -36,28 +41,55 @@ def remove_skip_values(self, data, **kwargs):
         }
 
 
+T = TypeVar('T', bound='Model')
+
+
 class Model:
     """Represents a basic API Resource model"""
 
     @classmethod
-    def get_class_instance(cls):
+    def get_class_instance(cls: Type[T]) -> Type[T]:
         return cls
 
-    def to_json(self):
+    def to_json(self) -> dict:
         return marshmallow_dataclass.class_schema(self.get_class_instance(), base_schema=CamelCaseSchema)().dump(self)
 
-    def __init__(self, **kwargs):
+    def __init__(self, **kwargs: dict):
         """
         Default constructor that sets all kwargs as internal properties
+
+        All models allow for the context to be set.
+
         :param kwargs: dictionary of parameters that this class must support
         """
         self.__dict__ = kwargs
+        self.client: Optional[hostingde.HostingDeClient] = None
+
+        # Context might be provided as a kwarg
+        if "context" in kwargs and isinstance(kwargs["context"], hostingde.HostingDeClient):
+            self.client = kwargs["context"]
+
+    def get_client(self) -> 'hostingde.HostingDeClient':
+        """
+        Get the client used to create this object.
+
+        Throws an attribute error if no client is set.
+        :return: an initialized client
+        """
+        if not self.client:
+            raise AttributeError("Context not set")
+
+        return self.client
 
     @classmethod
-    def from_json(cls, data: dict) -> 'Model':
+    def from_json(cls: Type[T], data: dict, client: 'hostingde.HostingDeClient' = None) -> T:
         """
         Create a new object from a given JSON.
         :param data: The json data
+        :param client: The client to use for this object
         :return: New instance of the class
         """
-        return marshmallow_dataclass.class_schema(cls, base_schema=CamelCaseSchema)().load(data)
+        inst = marshmallow_dataclass.class_schema(cls, base_schema=CamelCaseSchema)().load(data)
+        inst.client = client
+
+        return inst