support unassigning unsupported jobs, introduce custom exception for unsupported jobs, fix misc little bugs

Author: tykling

src/bma_client_lib/bma_client.py

@@ -17,7 +17,14 @@
 import magic
 from PIL import Image, ImageOps
 
-from .datastructures import ImageConversionJob, ImageExifExtractionJob, Job, ThumbnailJob, ThumbnailSourceJob
+from .datastructures import (
+    ImageConversionJob,
+    ImageExifExtractionJob,
+    Job,
+    JobNotSupportedError,
+    ThumbnailJob,
+    ThumbnailSourceJob,
+)
 
 logger = logging.getLogger("bma_client")
 
@@ -98,7 +105,7 @@ def get_server_settings(self) -> dict[str, dict[str, dict[str, list[str]]]]:
         self.settings = r.json()["bma_response"]
         return r.json()
 
-    def get_jobs(self, job_filter: str = "?limit=0") -> list[dict[str, str]]:
+    def get_jobs(self, job_filter: str = "?limit=0") -> list[Job]:
         """Get a filtered list of the jobs this user has access to."""
         r = self.client.get(self.base_url + f"/api/v1/json/jobs/{job_filter}").raise_for_status()
         response = r.json()["bma_response"]
@@ -125,14 +132,14 @@ def download_job_source(self, job: Job) -> Path:
             path=self.path / job.source_filename,
         )
 
-    def get_job_assignment(self, file_uuid: uuid.UUID | None = None) -> list[Job]:
+    def get_job_assignment(self, job_filter: str = "") -> list[Job]:
         """Ask for new job(s) from the API."""
         url = self.base_url + "/api/v1/json/jobs/assign/"
-        if file_uuid:
-            url += f"?file_uuid={file_uuid}"
+        if job_filter:
+            url += job_filter
         data = {
             "client_uuid": self.uuid,
-            "client_version": "bma-client-lib {__version__}",
+            "client_version": f"bma-client-lib {__version__}",
         }
         try:
             r = self.client.post(url, json=data).raise_for_status()
@@ -145,6 +152,14 @@ def get_job_assignment(self, file_uuid: uuid.UUID | None = None) -> list[Job]:
         logger.debug(f"Returning {len(response)} assigned jobs")
         return response
 
+    def unassign_job(self, job: Job) -> bool:
+        """Unassign a job."""
+        logger.debug(f"Unassigning job {job.job_uuid}")
+        self.client.post(
+            self.base_url + f"/api/v1/json/jobs/{job.job_uuid}/unassign/",
+        ).raise_for_status()
+        return True
+
     def upload_file(self, path: Path, attribution: str, file_license: str) -> dict[str, dict[str, str]]:
         """Upload a file."""
         # get mimetype
@@ -169,7 +184,7 @@ def upload_file(self, path: Path, attribution: str, file_license: str) -> dict[s
                 if rotated is None:
                     raise ValueError("Rotation")
                 logger.debug(
-                    f"Image has exif rotation info, using post-rotate size {rotated.size}"
+                    f"Image has exif rotation info, using post-rotate size {rotated.size} "
                     f"instead of raw size {image.size}"
                 )
                 width, height = rotated.size
@@ -217,7 +232,7 @@ def handle_job(self, job: Job) -> None:
             filename = job.source_filename
 
         else:
-            raise TypeError(type(job))
+            raise JobNotSupportedError(job=job)
 
         self.write_and_upload_result(job=job, result=result, filename=filename)
 
@@ -252,7 +267,7 @@ def write_and_upload_result(self, job: Job, result: "JobResult", filename: str)
 
             else:
                 logger.error("Unsupported job type")
-                raise TypeError(job.job_type)
+                raise JobNotSupportedError(job=job)
 
             self.upload_job_result(job=job, buf=buf, filename=filename, metadata=metadata)
 
@@ -391,4 +406,4 @@ def create_thumbnail_source(self, job: ThumbnailSourceJob) -> "ThumbnailSourceJo
                 orig=path,
             )
         # unsupported filetype
-        raise ValueError(info["filetype"])
+        raise JobNotSupportedError(job=job)

src/bma_client_lib/datastructures.py

@@ -58,3 +58,11 @@ class ThumbnailJob(ImageConversionJob):
 ThumbnailSourceJobResult: TypeAlias = ImageConversionJobResult
 ExifExtractionJobResult: TypeAlias = dict[str, dict[str, str]]
 JobResult: TypeAlias = ImageConversionJobResult | ExifExtractionJobResult | ThumbnailSourceJobResult
+
+
+class JobNotSupportedError(Exception):
+    """Exception raised when a job is not supported by bma_client_lib for some reason."""
+
+    def __init__(self, job: Job) -> None:
+        """Exception raised when a job is not supported by bma_client_lib for some reason."""
+        super().__init__(f"{job.job_type} {job.job_uuid} for file {job.basefile_uuid} not supported by this client.")