refactor: Refactorized the exceptions

Author: Robin-Van-de-Merghel

diracx-core/src/diracx/core/exceptions.py

@@ -15,6 +15,7 @@ class DiracError(RuntimeError):
 
     def __init__(self, detail: str = "Unknown"):
         self.detail = detail
+        super().__init__(detail)
 
 
 class AuthorizationError(DiracError): ...
@@ -53,19 +54,19 @@ class InvalidQueryError(DiracError):
 
 
 class TokenNotFoundError(DiracError):
-    def __init__(self, jti: str, detail: str | None = None):
+    def __init__(self, jti: str, detail: str = ""):
         self.jti: str = jti
         super().__init__(f"Token {jti} not found" + (f" ({detail})" if detail else ""))
 
 
 class JobNotFoundError(DiracError):
-    def __init__(self, job_id: int, detail: str | None = None):
+    def __init__(self, job_id: int, detail: str = ""):
         self.job_id: int = job_id
         super().__init__(f"Job {job_id} not found" + (f" ({detail})" if detail else ""))
 
 
 class SandboxNotFoundError(DiracError):
-    def __init__(self, pfn: str, se_name: str, detail: str | None = None):
+    def __init__(self, pfn: str, se_name: str, detail: str = ""):
         self.pfn: str = pfn
         self.se_name: str = se_name
         super().__init__(
@@ -75,7 +76,7 @@ def __init__(self, pfn: str, se_name: str, detail: str | None = None):
 
 
 class SandboxAlreadyAssignedError(DiracError):
-    def __init__(self, pfn: str, se_name: str, detail: str | None = None):
+    def __init__(self, pfn: str, se_name: str, detail: str = ""):
         self.pfn: str = pfn
         self.se_name: str = se_name
         super().__init__(
@@ -85,7 +86,7 @@ def __init__(self, pfn: str, se_name: str, detail: str | None = None):
 
 
 class SandboxAlreadyInsertedError(DiracError):
-    def __init__(self, pfn: str, se_name: str, detail: str | None = None):
+    def __init__(self, pfn: str, se_name: str, detail: str = ""):
         self.pfn: str = pfn
         self.se_name: str = se_name
         super().__init__(
@@ -95,7 +96,7 @@ def __init__(self, pfn: str, se_name: str, detail: str | None = None):
 
 
 class JobError(DiracError):
-    def __init__(self, job_id, detail: str | None = None):
+    def __init__(self, job_id, detail: str = ""):
         self.job_id: int = job_id
         super().__init__(
             f"Error concerning job {job_id}" + (f" ({detail})" if detail else "")
@@ -106,81 +107,69 @@ class NotReadyError(DiracError):
     """Tried to access a value which is asynchronously loaded but not yet available."""
 
 
-class GenericError(Exception):
-    head: str = "Error"
-    tail: str = ""
+class DiracFormattedError(DiracError):
+    # TODO: Refactor?
+    pattern = "Error %s"
 
-    def __init__(self, data: dict[str, str], detail: str | None = None):
+    def __init__(self, data: dict[str, str], detail: str = ""):
         self.data = data
-        self.detail = detail
 
         parts = [f"({key}: {value})" for key, value in data.items()]
-        message = f"{self.head} {' '.join(parts)} {self.tail}"
+        message = type(self).pattern % (" ".join(parts))
         if detail:
             message += f": {detail}"
 
         super().__init__(message)
 
 
-class PilotNotFoundError(GenericError):
-    head = "Pilot"
-    tail = "not found"
+class PilotNotFoundError(DiracFormattedError):
+    pattern = "Pilot %s not found"
 
     def __init__(
         self,
         data: dict[str, str],
-        detail: str | None = None,
+        detail: str = "",
         non_existing_pilots: set = set(),
     ):
         super().__init__(data, detail)
         self.non_existing_pilots = non_existing_pilots
 
 
-class PilotAlreadyExistsError(GenericError):
-    head = "Pilot"
-    tail = "already exists"
+class PilotAlreadyExistsError(DiracFormattedError):
+    pattern = "Pilot %s already exists"
 
 
-class BadPilotCredentialsError(GenericError):
-    head = "Bad secret/pilot_stamp"
-    tail = ""
+class BadPilotCredentialsError(DiracFormattedError):
+    pattern = "Bad secret/pilot_stamp %s "
 
 
-class BadPilotVOError(GenericError):
-    head = "Bad VO"
-    tail = ""
+class BadPilotVOError(DiracFormattedError):
+    pattern = "Bad VO %s "
 
 
-class SecretNotFoundError(GenericError):
-    head = "Secret"
-    tail = "not found"
+class SecretNotFoundError(DiracFormattedError):
+    pattern = "Secret %s not found"
 
 
-class CredentialsNotFoundError(GenericError):
-    head = "Credentials"
-    tail = "not found"
+class CredentialsNotFoundError(DiracFormattedError):
+    pattern = "Credentials %s not found"
 
 
-class CredentialsAlreadyExistError(GenericError):
-    head = "Credentials"
-    tail = "already exist"
+class CredentialsAlreadyExistError(DiracFormattedError):
+    pattern = "Credentials %s already exist"
 
 
-class SecretHasExpiredError(GenericError):
-    head = "Secret"
-    tail = "has expired"
+class SecretHasExpiredError(DiracFormattedError):
+    pattern = "Secret %s has expired"
 
 
-class SecretAlreadyExistsError(GenericError):
-    head = "Secret"
-    tail = "already exists"
+class SecretAlreadyExistsError(DiracFormattedError):
+    pattern = "Secret %s already exists"
 
 
-class PilotJobsNotFoundError(GenericError):
-    head = "Pilots or Jobs"
-    tail = "not found"
+class PilotJobsNotFoundError(DiracFormattedError):
+    pattern = "Pilots or Jobs %s not found"
 
 
-class PilotAlreadyAssociatedWithJobError(GenericError):
-    head = "Pilot is already associated with a job"
-    tail = ""
+class PilotAlreadyAssociatedWithJobError(DiracFormattedError):
+    pattern = "Pilot is already associated with a job %s "

diracx-db/src/diracx/db/sql/utils/functions.py

@@ -9,7 +9,7 @@
 from sqlalchemy.ext.compiler import compiles
 from sqlalchemy.sql import ColumnElement, expression
 
-from diracx.core.exceptions import GenericError, InvalidQueryError
+from diracx.core.exceptions import DiracFormattedError, InvalidQueryError
 from diracx.db.exceptions import DBInBadStateError
 
 if TYPE_CHECKING:
@@ -160,7 +160,7 @@ def hash(code: str):
 async def fetch_records_bulk_or_raises(
     conn: AsyncConnection,
     model: Any,  # Here, we currently must use `Any` because `declarative_base()` returns any
-    missing_elements_error_cls: Type[GenericError],
+    missing_elements_error_cls: Type[DiracFormattedError],
     column_attribute_name: str,
     column_name: str,
     elements_to_fetch: list,