quapp-common 0.0.13.dev3__tar.gz → 0.0.13.dev5__tar.gz

{quapp_common-0.0.13.dev3/quapp_common.egg-info → quapp_common-0.0.13.dev5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: quapp-common
-Version: 0.0.13.dev3
+Version: 0.0.13.dev5
 Summary: Quapp common library supporting Quapp Platform for Quantum Computing
 Author-email: "CITYNOW Co. Ltd. " <corp@citynow.vn>
 License: The MIT License (MIT)

{quapp_common-0.0.13.dev3 → quapp_common-0.0.13.dev5}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "quapp-common"
-version = "0.0.13.dev3"
+version = "0.0.13.dev5"
 description = "Quapp common library supporting Quapp Platform for Quantum Computing"
 readme = "README.md"
 authors = [{ name = "CITYNOW Co. Ltd. ", email = "corp@citynow.vn" }]

{quapp_common-0.0.13.dev3 → quapp_common-0.0.13.dev5}/quapp_common/component/backend/invocation.py

@@ -93,7 +93,8 @@ class Invocation(ABC):
                 exc_info=True)
 
             job_response = build_error_job_response(exception,
-                                                    message='Error when prepare backend data')
+                                                    message='Error when prepare backend data',
+                                                    stage='while preparing the backend')
             job_response.authentication = self.authentication
             update_job_metadata(job_response, self.callback_dict.get(
                     InvocationStep.PREPARATION).on_error)
@@ -135,7 +136,8 @@ class Invocation(ABC):
                     exc_info=True)
 
             job_response = build_error_job_response(exception,
-                                                    message='Error when create provider or device')
+                                                    message='Error when create provider or device',
+                                                    stage='while running the circuit on the device')
             update_job_metadata(job_response, self.callback_dict.get(
                     InvocationStep.EXECUTION).on_error, )
 
@@ -187,7 +189,8 @@ class Invocation(ABC):
                                   exc_info=True)
 
             job_response = build_error_job_response(exception, job_response,
-                                                    message='Error when prepare circuit')
+                                                    message='Error when prepare circuit',
+                                                    stage='while preparing the circuit')
 
             update_job_metadata(job_response, self.callback_dict.get(
                     InvocationStep.PREPARATION).on_error)

{quapp_common-0.0.13.dev3 → quapp_common-0.0.13.dev5}/quapp_common/util/response_utils.py

@@ -2,6 +2,11 @@
 #  response_utils.py
 #  Copyright © CITYNOW Co. Ltd. All rights reserved.
 
+import json
+import os
+import traceback
+from typing import Optional
+
 from .http_utils import CUSTOM_HEADER_VALUE
 from ..component.backend.job_fetcher import JobFetcher
 from ..data.promise.post_processing_promise import PostProcessingPromise
@@ -97,11 +102,63 @@ def build_done_job_response(fetcher: JobFetcher = None,
             status_code=StatusCode.DONE)
 
 
+def _humanize_exception(exception: Exception) -> Optional[str]:
+    """
+    Return a short, user-friendly explanation for common input-related
+    exceptions raised by a function handler, or None when there is no
+    friendlier form.
+
+    Rationale: the raw ``str`` of some exceptions is cryptic for end users --
+    most notably ``KeyError``, whose ``str`` is just the repr of the missing
+    key (e.g. ``str(KeyError('Q'))`` -> ``"'Q'"``). Classifying the common
+    cases lets us surface an actionable, plain-language message instead. Full
+    technical detail (traceback, step, exception type) stays in the function
+    logs -- it is not surfaced to the end user here.
+    """
+    if isinstance(exception, KeyError):
+        # KeyError.args[0] is the missing key itself (not quoted).
+        key = exception.args[0] if exception.args else exception
+        return f"Missing required input field: '{key}'."
+
+    if isinstance(exception, json.JSONDecodeError):
+        return "Input is not valid JSON."
+
+    if isinstance(exception, IndexError):
+        return "An input field has fewer items than expected."
+
+    return None
+
+
+def _format_exception(exception: Exception) -> dict:
+    """
+    Return a compact, structured description of an exception for the user-facing
+    response: the exception type, a one-line detail, and the deepest source
+    location (file:line in function).
+
+    The full multi-frame traceback is intentionally NOT included here -- it is
+    emitted to the function logs via logger.exception(exc_info=True). The
+    frontend renders job_result as pretty JSON, so this nested object displays
+    cleanly with no frontend change required.
+    """
+    at = None
+    tb = traceback.extract_tb(exception.__traceback__)
+    if tb:
+        frame = tb[-1]  # deepest frame = where the error actually occurred
+        at = f"{os.path.basename(frame.filename)}:{frame.lineno} in {frame.name}()"
+
+    return {
+        "type": type(exception).__name__,
+        "detail": str(exception),
+        "at": at,
+    }
+
+
 def build_error_job_response(exception: Exception,
                              job_response: JobResponse = None,
                              fetcher: JobFetcher = None,
                              post_promise: PostProcessingPromise = None,
-                             message: str = None) -> JobResponse:
+                             message: str = None,
+                             stage: str = None) -> JobResponse:
     """
     Builds and returns a JobResponse object populated with error-related information.
 
@@ -148,8 +205,23 @@ def build_error_job_response(exception: Exception,
                                                  post_promise)
     job_response.status_code = StatusCode.ERROR
     job_response.job_status = JobStatus.ERROR.value
-    job_response.job_result = {'message'  : message or 'Unknown error occurred.',
-                               'exception': str(exception)}
+
+    # User-facing message: plain language + which stage failed (in human terms,
+    # from `stage`), never internal jargon. `message` (old internal step label)
+    # is kept for backward compatibility but is no longer surfaced to the user.
+    # Full multi-frame traceback stays in the logs via logger.exception().
+    phrase = stage or 'while running your job'
+    hint = _humanize_exception(exception)
+    if hint:
+        user_message = f'Your job failed {phrase}. {hint}'
+    else:
+        user_message = (f'Your job failed {phrase}. '
+                        'See the exception below or the job logs for details.')
+
+    job_response.job_result = {
+        'message'  : user_message,
+        'exception': _format_exception(exception),
+    }
     return job_response
 
 

{quapp_common-0.0.13.dev3 → quapp_common-0.0.13.dev5/quapp_common.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: quapp-common
-Version: 0.0.13.dev3
+Version: 0.0.13.dev5
 Summary: Quapp common library supporting Quapp Platform for Quantum Computing
 Author-email: "CITYNOW Co. Ltd. " <corp@citynow.vn>
 License: The MIT License (MIT)