Chore: Updated code for typing with mypy strict

Author: Seluj78

.pre-commit-config.yaml

@@ -21,3 +21,14 @@ repos:
       hooks:
         -   id: reorder-python-imports
             args: [--py3-plus]
+  -   repo: https://github.com/pre-commit/mirrors-mypy
+      rev: v1.8.0
+      hooks:
+      -   id: mypy
+          additional_dependencies: ['types-requests']
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.5.0
+    hooks:
+      - id: check-merge-conflict
+      - id: debug-statements
+      - id: check-case-conflict

requirements-dev.txt

@@ -1,6 +1,8 @@
 black
 reorder-python-imports
 flake8
+mypy
+types-requests
 pre-commit
 -r requirements.txt
 

shellhub/models/base.py

@@ -1,3 +1,5 @@
+from typing import Any
+from typing import Dict
 from typing import List
 from typing import Optional
 
@@ -13,21 +15,21 @@ class ShellHub:
     _endpoint: str
     _access_token: Optional[str]
 
-    def __init__(self, username: str, password: str, endpoint: str):
+    def __init__(self, username: str, password: str, endpoint: str) -> None:
         self._username: str = username
         self._password: str = password
         self._endpoint: str = endpoint
         self._access_token: Optional[str] = None
 
         self._login()
 
-    def __repr__(self):
+    def __repr__(self) -> str:
         return f"<ShellHub username={self._username} endpoint={self._endpoint}>"
 
-    def __str__(self):
+    def __str__(self) -> str:
         return self._endpoint
 
-    def _login(self):
+    def _login(self) -> None:
         try:
             response = requests.post(
                 f"{self._endpoint}/api/login",
@@ -46,16 +48,20 @@ def _login(self):
         self._access_token = response.json()["token"]
 
     def make_request(
-        self, endpoint: str, method: str, query_params: Optional[dict] = None, json: Optional[dict] = None
-    ):
+        self,
+        endpoint: str,
+        method: str,
+        query_params: Optional[Dict[Any, Any]] = None,
+        json: Optional[Dict[Any, Any]] = None,
+    ) -> requests.Response:
         params = ""
         if query_params:
             params = "?"
             for key, value in query_params.items():
                 params += f"{key}={value}&"
             params = params[:-1]
 
-        response = getattr(requests, method.lower())(
+        response: requests.Response = getattr(requests, method.lower())(
             f"{self._endpoint}{endpoint}{params if params else ''}",
             headers={
                 "Authorization": f"Bearer {self._access_token}",
@@ -64,7 +70,9 @@ def make_request(
         )
         return response
 
-    def _get_devices(self, query_params: Optional[dict] = None) -> "List[shellhub.models.device.ShellHubDevice]":
+    def _get_devices(
+        self, query_params: Optional[Dict[Any, Any]] = None
+    ) -> "List[shellhub.models.device.ShellHubDevice]":
         response = self.make_request(endpoint="/api/devices", method="GET", query_params=query_params)
 
         response.raise_for_status()
@@ -75,7 +83,7 @@ def _get_devices(self, query_params: Optional[dict] = None) -> "List[shellhub.mo
         return devices
 
     def get_all_devices(
-        self, status: Optional[str] = None, query_params: Optional[dict] = None
+        self, status: Optional[str] = None, query_params: Optional[Dict[Any, Any]] = None
     ) -> "List[shellhub.models.device.ShellHubDevice]":
         """
         Get all devices from ShellHub. Default gets all devices

shellhub/models/device.py

@@ -1,3 +1,4 @@
+from typing import Dict
 from typing import List
 from typing import Optional
 
@@ -12,21 +13,21 @@ class ShellHubDeviceInfo:
     arch: str
     platform: str
 
-    def __init__(self, device_info_json: dict):
+    def __init__(self, device_info_json: Dict[str, str]):
         self.id = device_info_json["id"]
         self.pretty_name = device_info_json["pretty_name"]
         self.version = device_info_json["version"]
         self.arch = device_info_json["arch"]
         self.platform = device_info_json["platform"]
 
-    def __repr__(self):
+    def __repr__(self) -> str:
         return (
             f"ShellHubDeviceInfo(id={self.id}, pretty_name={self.pretty_name}, "
             f"version={self.version}, arch={self.arch}, platform={self.platform})"
         )
 
-    def __str__(self):
-        return self.__repr__()
+    def __str__(self) -> str:
+        return self.pretty_name
 
 
 class ShellHubDevice:
@@ -46,7 +47,7 @@ class ShellHubDevice:
     tags: List[str]
     acceptable: bool
 
-    def __init__(self, api_object: shellhub.models.base.ShellHub, device_json: dict):
+    def __init__(self, api_object: shellhub.models.base.ShellHub, device_json):  # type: ignore
         self._api = api_object
 
         self.uid = device_json["uid"]
@@ -68,16 +69,17 @@ def __init__(self, api_object: shellhub.models.base.ShellHub, device_json: dict)
         self.tags = device_json["tags"]
         self.acceptable = device_json["acceptable"]
 
-    def delete(self):
+    def delete(self) -> bool:
         response = self._api.make_request(endpoint=f"/api/devices/{self.uid}", method="DELETE")
         if response.status_code == 200:
             return True
         elif response.status_code == 404:
             raise ShellHubApiError(f"Device {self.uid} not found.")
         else:
             response.raise_for_status()
+            return False
 
-    def rename(self, name: Optional[str] = None):
+    def rename(self, name: Optional[str] = None) -> bool:
         """
         Set a new name for the device. If no name is provided, the name will be the mac address of the device
         """
@@ -93,8 +95,9 @@ def rename(self, name: Optional[str] = None):
             raise ShellHubApiError(f"Device with name {name} already exists.")
         else:
             response.raise_for_status()
+            return False
 
-    def accept(self):
+    def accept(self) -> bool:
         if not self.acceptable:
             raise ShellHubApiError(f"Device {self.uid} is not acceptable.")
 
@@ -106,19 +109,20 @@ def accept(self):
             raise ShellHubApiError(f"Device {self.uid} not found.")
         else:
             response.raise_for_status()
+            return False
 
-    def refresh(self):
+    def refresh(self) -> None:
         response = self._api.make_request(endpoint=f"/api/devices/{self.uid}", method="GET")
         if response.status_code == 404:
             raise ShellHubApiError(f"Device {self.uid} not found.")
         elif response.status_code != 200:
             response.raise_for_status()
-        self.__init__(self._api, response.json())
+        self.__init__(self._api, response.json())  # type: ignore
 
-    def __repr__(self):
+    def __repr__(self) -> str:
         return (
             f"ShellHubDevice(name={self.name}, online={self.online}, namespace={self.namespace}, status={self.status})"
         )
 
-    def __str__(self):
+    def __str__(self) -> str:
         return self.uid