chore(types): fix type errors add version information

Author: deveaud-m

fossology/__init__.py

@@ -130,14 +130,16 @@ def __init__(self, url, token, version="v1"):
         self.token = token
         self.users = list()
         self.folders = list()
+        self.version = version
         self.api = f"{self.host}/api/{version}"
         self.session = requests.Session()
         self.session.headers.update({"Authorization": f"Bearer {self.token}"})
         self.info = self.get_info()
         self.health = self.get_health()
-        self.user = self.get_self()
+        self.user: User = self.get_self()
         self.name = self.user.name
-        self.rootFolder = self.detail_folder(self.user.rootFolderId)
+        if self.user.rootFolderId is not None:
+            self.rootFolder = self.detail_folder(self.user.rootFolderId)
         self.folders = self.list_folders()
 
         logger.info(
@@ -186,7 +188,7 @@ def get_info(self) -> ApiInfo:
             description = "Error while getting API info"
             raise FossologyApiError(description, response)
 
-    def get_health(self) -> ApiInfo:
+    def get_health(self) -> HealthInfo:
         """Get health from the server
 
         API endpoint: GET /health

fossology/items.py

@@ -38,8 +38,8 @@ def item_info(
         :rtype: FileInfo
         :raises FossologyApiError: if the REST call failed
         """
-        response = self.session.get(
-            f"{self.api}/uploads/{upload.id}/item/{item_id}/info"
+        response = self.session.get(  # type: ignore
+            f"{self.api}/uploads/{upload.id}/item/{item_id}/info"  # type: ignore
         )
 
         if response.status_code == 200:
@@ -71,8 +71,8 @@ def item_copyrights(
         :rtype: int
         :raises FossologyApiError: if the REST call failed
         """
-        response = self.session.get(
-            f"{self.api}/uploads/{upload.id}/item/{item_id}/totalcopyrights?status={status.value}"
+        response = self.session.get(  # type: ignore
+            f"{self.api}/uploads/{upload.id}/item/{item_id}/totalcopyrights?status={status.value}"  # type: ignore
         )
 
         if response.status_code == 200:
@@ -103,8 +103,8 @@ def get_clearing_history(
         :raises FossologyApiError: if the REST call failed
         :raises AuthorizationError: if the REST call is not authorized
         """
-        response = self.session.get(
-            f"{self.api}/uploads/{upload.id}/item/{item_id}/clearing-history"
+        response = self.session.get(  # type: ignore
+            f"{self.api}/uploads/{upload.id}/item/{item_id}/clearing-history"  # type: ignore
         )
 
         if response.status_code == 200:
@@ -142,8 +142,9 @@ def get_prev_next(
         if selection:
             params["selection"] = selection
 
-        response = self.session.get(
-            f"{self.api}/uploads/{upload.id}/item/{item_id}/prev-next", params=params
+        response = self.session.get(  # type: ignore
+            f"{self.api}/uploads/{upload.id}/item/{item_id}/prev-next", # type: ignore
+            params=params,  # type: ignore
         )
 
         if response.status_code == 200:
@@ -174,8 +175,8 @@ def get_bulk_history(
         :raises FossologyApiError: if the REST call failed
         :raises AuthorizationError: if the REST call is not authorized
         """
-        response = self.session.get(
-            f"{self.api}/uploads/{upload.id}/item/{item_id}/bulk-history"
+        response = self.session.get(  # type: ignore
+            f"{self.api}/uploads/{upload.id}/item/{item_id}/bulk-history"  # type: ignore
         )
 
         if response.status_code == 200:
@@ -231,8 +232,8 @@ def schedule_bulk_scan(
         :raises AuthorizationError: if the REST call is not authorized
         """
         headers = {"Content-Type": "application/json"}
-        response = self.session.post(
-            f"{self.api}/uploads/{upload.id}/item/{item_id}/bulk-scan",
+        response = self.session.post(  # type: ignore
+            f"{self.api}/uploads/{upload.id}/item/{item_id}/bulk-scan",  # type: ignore
             headers=headers,
             data=json.dumps(spec),
         )

fossology/obj.py

@@ -131,7 +131,7 @@ def __init__(
         rootFolderId: int | None = None,
         emailNotification: str | None = None,
         default_group: str | None = None,
-        agents: dict | None = None,
+        agents: Agents | None = None,
         **kwargs: dict,
     ):
         self.id = id
@@ -252,9 +252,10 @@ def __init__(
         self.additional_info = kwargs
 
     def __str__(self):
+        len_copyright = len(self.copyright) if self.copyright else 0
         return (
             f"Licenses found by scanners: {self.scanner}, concluded licenses: {self.conclusion}, "
-            f"{len(self.copyright)} copyrights"
+            f"{len_copyright} copyrights"
         )
 
     @classmethod
@@ -699,7 +700,11 @@ def __init__(
         self.additional_info = kwargs
 
     def __str__(self):
-        return f"File {self.filepath} has {len(self.findings.conclusion)} license and {len(self.findings.copyright)}matches"
+        len_conclusion = (
+            len(self.findings.conclusion) if self.findings.conclusion else 0
+        )
+        len_copyright = len(self.findings.copyright) if self.findings.copyright else 0
+        return f"File {self.filepath} has {len_conclusion} license and {len_copyright} copyrights found."
 
     @classmethod
     def from_json(cls, json_dict):

fossology/search.py

@@ -116,7 +116,7 @@ def search(
             x_total_pages = page
         while page <= x_total_pages:
             headers["page"] = str(page)
-            response = self.session.get(f"{self.api}/search", headers=headers)
+            response = self.session.get(f"{self.api}/search", headers=headers) # type: ignore
 
             if response.status_code == 200:
                 for result in response.json():
@@ -161,8 +161,8 @@ def filesearch(
         if group:
             headers["groupName"] = group
 
-        response = self.session.post(
-            f"{self.api}/filesearch", headers=headers, json=filelist
+        response = self.session.post( # type: ignore
+            f"{self.api}/filesearch", headers=headers, json=filelist # type: ignore
         )
 
         if response.status_code == 200:

fossology/uploads.py

@@ -107,7 +107,7 @@ def detail_upload(
         headers = {}
         if group:
             headers["groupName"] = group
-        response = self.session.get(f"{self.api}/uploads/{upload_id}", headers=headers)
+        response = self.session.get(f"{self.api}/uploads/{upload_id}", headers=headers)  # type: ignore
 
         if response.status_code == 200:
             logger.debug(f"Got details for upload {upload_id}")
@@ -119,7 +119,7 @@ def detail_upload(
 
         elif response.status_code == 503:
             if not wait_time:
-                wait_time = response.headers["Retry-After"]
+                wait_time = int(response.headers["Retry-After"])
             logger.debug(
                 f"Retry GET upload {upload_id} after {wait_time} seconds: {response.json()['message']}"
             )
@@ -249,23 +249,23 @@ def upload_file(
         }
 
         headers = {}
-        if "v1" in self.api:
+        if "v1" in self.api:  # type: ignore
             headers = {
                 k: str(v).lower() if isinstance(v, bool) else v for k, v in data.items()
             }  # Needed for API v1.x
             headers["groupName"] = group
-            endpoint = f"{self.api}/uploads"
+            endpoint = f"{self.api}/uploads"  # type: ignore
         else:
             if group:
-                endpoint = f"{self.api}/uploads?groupName={group}"
+                endpoint = f"{self.api}/uploads?groupName={group}"  # type: ignore
             else:
-                endpoint = f"{self.api}/uploads"
+                endpoint = f"{self.api}/uploads"  # type: ignore
 
         if file:
             data["uploadType"] = headers["uploadType"] = "file"
             with open(file, "rb") as fp:
                 files = {"fileInput": fp}
-                response = self.session.post(
+                response = self.session.post(  # type: ignore
                     endpoint, files=files, headers=headers, data=data
                 )
         elif vcs or url or server:
@@ -279,7 +279,7 @@ def upload_file(
                 data["location"] = server  # type: ignore
                 data["uploadType"] = headers["uploadType"] = "server"
             headers["Content-Type"] = "application/json"
-            response = self.session.post(
+            response = self.session.post(  # type: ignore
                 endpoint,
                 data=json.dumps(data),
                 headers=headers,
@@ -301,7 +301,7 @@ def upload_file(
 
         if response.status_code == 201:
             try:
-                upload = self.detail_upload(
+                upload = self.detail_upload(  # type: ignore
                     response.json()["message"], group, wait_time
                 )
                 logger.info(
@@ -339,8 +339,9 @@ def upload_summary(self, upload: Upload, group=None):
         headers = {}
         if group:
             headers["groupName"] = group
-        response = self.session.get(
-            f"{self.api}/uploads/{upload.id}/summary", headers=headers
+        response = self.session.get(  # type: ignore
+            f"{self.api}/uploads/{upload.id}/summary",  # type: ignore
+            headers=headers,  # type: ignore
         )
 
         if response.status_code == 200:
@@ -406,8 +407,10 @@ def upload_licenses(
             headers["groupName"] = group
             params["groupName"] = group  # type: ignore
 
-        response = self.session.get(
-            f"{self.api}/uploads/{upload.id}/licenses", params=params, headers=headers
+        response = self.session.get(  # type: ignore
+            f"{self.api}/uploads/{upload.id}/licenses",  # type: ignore
+            params=params,
+            headers=headers,  # type: ignore
         )
 
         if response.status_code == 200:
@@ -451,7 +454,7 @@ def upload_copyrights(
         :raises FossologyApiError: if the REST call failed
         :raises AuthorizationError: if the REST call is not authorized
         """
-        response = self.session.get(f"{self.api}/uploads/{upload.id}/copyrights")
+        response = self.session.get(f"{self.api}/uploads/{upload.id}/copyrights")  # type: ignore
 
         if response.status_code == 200:
             all_copyrights = []
@@ -491,8 +494,10 @@ def delete_upload(self, upload, group=None):
         headers = {}
         if group:
             headers["groupName"] = group
-        response = self.session.delete(
-            f"{self.api}/uploads/{upload.id}", headers=headers, timeout=5
+        response = self.session.delete(  # type: ignore
+            f"{self.api}/uploads/{upload.id}",  # type: ignore
+            headers=headers,
+            timeout=5,  # type: ignore
         )
 
         if response.status_code == 202:
@@ -560,7 +565,7 @@ def list_uploads(
             assignee=assignee,
             since=since,
             group=group,
-            limit=page_size,
+            limit=str(page_size),
         )
         uploads_list = list()
         if all_pages:
@@ -571,8 +576,10 @@ def list_uploads(
         while page <= x_total_pages:
             headers["page"] = str(page)
             params["page"] = str(page)
-            response = self.session.get(
-                f"{self.api}/uploads", headers=headers, params=params
+            response = self.session.get(  # type: ignore
+                f"{self.api}/uploads",  # type: ignore
+                headers=headers,
+                params=params,  # type: ignore
             )
             if response.status_code == 200:
                 for upload in response.json():
@@ -628,8 +635,8 @@ def update_upload(
             params["assignee"] = assignee.id  # type: ignore
         if group:
             headers["groupName"] = group
-        response = self.session.patch(
-            f"{self.api}/uploads/{upload.id}",
+        response = self.session.patch(  # type: ignore
+            f"{self.api}/uploads/{upload.id}",  # type: ignore
             headers=headers,
             params=params,
             data=comment,
@@ -661,8 +668,10 @@ def move_upload(self, upload: Upload, folder: Folder, action: str):
         :raises AuthorizationError: if the REST call is not authorized
         """
         params = {"folderId": str(folder.id), "action": action}
-        response = self.session.put(
-            f"{self.api}/uploads/{upload.id}", headers=params, params=params
+        response = self.session.put(  # type: ignore
+            f"{self.api}/uploads/{upload.id}",  # type: ignore
+            headers=params,
+            params=params,  # type: ignore
         )
 
         if response.status_code == 202:
@@ -680,7 +689,7 @@ def move_upload(self, upload: Upload, folder: Folder, action: str):
             )
             raise FossologyApiError(description, response)
 
-    def download_upload(self, upload: Upload) -> Tuple[str, str]:
+    def download_upload(self, upload: Upload) -> Tuple[bytes, str]:
         """Download an upload by its id
 
         API Endpoint: GET /uploads/{id}/download
@@ -692,7 +701,7 @@ def download_upload(self, upload: Upload) -> Tuple[str, str]:
         :raises FossologyApiError: if the REST call failed
         :raises AuthorizationError: if the REST call is not authorized
         """
-        response = self.session.get(f"{self.api}/uploads/{upload.id}/download")
+        response = self.session.get(f"{self.api}/uploads/{upload.id}/download")  # type: ignore
 
         if response.status_code == 200:
             content = response.headers["Content-Disposition"]
@@ -743,8 +752,9 @@ def change_upload_permissions(
             if public_permission
             else "none",
         }
-        response: requests.Response = self.session.put(
-            f"{self.api}/uploads/{upload.id}/permissions", json=data
+        response: requests.Response = self.session.put(  # type: ignore
+            f"{self.api}/uploads/{upload.id}/permissions",  # type: ignore
+            json=data,  # type: ignore
         )
 
         if response.status_code == 202:
@@ -789,7 +799,7 @@ def upload_permissions(
         :raises FossologyApiError: if the REST call failed
         :raises AuthorizationError: if the REST call is not authorized
         """
-        response = self.session.get(f"{self.api}/uploads/{upload.id}/perm-groups")
+        response = self.session.get(f"{self.api}/uploads/{upload.id}/perm-groups")  # type: ignore
         if response.status_code == 200:
             return UploadPermGroups.from_json(response.json())