More UNTESTED type hints

Author: faretek1

scratchattach/site/_base.py

@@ -1,18 +1,26 @@
 from abc import ABC, abstractmethod
+
 import requests
-from threading import Thread
+# from threading import Thread
 from ..utils import exceptions, commons
 
+
 class BaseSiteComponent(ABC):
+    @abstractmethod
+    def __init__(self):
+        self._session = None
+        self._cookies = None
+        self._headers = None
+        self.update_API = None
 
     def update(self):
         """
         Updates the attributes of the object by performing an API response. Returns True if the update was successful.
         """
         response = self.update_function(
             self.update_API,
-            headers = self._headers,
-            cookies = self._cookies, timeout=10
+            headers=self._headers,
+            cookies=self._cookies, timeout=10
         )
         # Check for 429 error:
         if "429" in str(response):
@@ -44,3 +52,7 @@ def _make_linked_object(self, identificator_id, identificator, Class, NotFoundEx
         """
         return commons._get_object(identificator_id, identificator, Class, NotFoundException, self._session)
 
+    update_function = requests.get
+    """
+    Internal function run on update. Function is a method of the 'requests' module/class
+    """

scratchattach/site/forum.py

@@ -32,8 +32,8 @@ class ForumTopic(BaseSiteComponent):
 
     :.update(): Updates the attributes
     '''
-    def __init__(self, **entries):
 
+    def __init__(self, **entries):
         # Info on how the .update method has to fetch the data:
         self.update_function = requests.get
         self.update_API = f"https://scratch.mit.edu/discuss/feeds/topic/{entries['id']}/"

scratchattach/utils/commons.py

@@ -1,10 +1,14 @@
 """v2 ready: Common functions used by various internal modules"""
 from types import FunctionType
-from typing import Final, Any
+from typing import Final, Any, TYPE_CHECKING
 
 from . import exceptions
 from .requests import Requests as requests
 
+if TYPE_CHECKING:
+    # Having to do this is quite inelegant, but this is commons.py, so this is done to avoid cyclic imports
+    from ..site._base import BaseSiteComponent
+
 headers: Final = {
     "user-agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 "
                   "(KHTML, like Gecko) Chrome/75.0.3770.142 Safari/537.36",
@@ -60,7 +64,7 @@
 }
 
 
-def api_iterative_data(fetch_func: 'FunctionType', limit: int, offset: int, max_req_limit: int = 40,
+def api_iterative_data(fetch_func: FunctionType, limit: int, offset: int, max_req_limit: int = 40,
                        unpack: bool = True):
     """
     Iteratively gets data by calling fetch_func with a moving offset and a limit.
@@ -123,7 +127,7 @@ def fetch(off: int, lim: int):
     return api_data
 
 
-def _get_object(identificator_name, identificator, Class, NotFoundException, session=None):
+def _get_object(identificator_name, identificator, Class, NotFoundException, session=None) -> 'BaseSiteComponent':
     # Internal function: Generalization of the process ran by get_user, get_studio etc.
     # Builds an object of class that is inheriting from BaseSiteComponent
     # # Class must inherit from BaseSiteComponent