FailedOperation

pydantic model qcelemental.models.FailedOperation[source]

Record indicating that a given operation (program, procedure, etc.) has failed and containing the reason and input data which generated the failure.

Show JSON schema

{
   "title": "FailedOperation",
   "description": "Record indicating that a given operation (program, procedure, etc.) has failed and containing the reason and input data which generated the failure.",
   "type": "object",
   "properties": {
      "id": {
         "title": "Id",
         "description": "A unique identifier which links this FailedOperation, often of the same Id of the operation should it have been successful. This will often be set programmatically by a database such as Fractal.",
         "type": "string"
      },
      "input_data": {
         "title": "Input Data",
         "description": "The input data which was passed in that generated this failure. This should be the complete input which when attempted to be run, caused the operation to fail."
      },
      "success": {
         "title": "Success",
         "description": "A boolean indicator that the operation failed consistent with the model of successful operations. Should always be False. Allows programmatic assessment of all operations regardless of if they failed or succeeded",
         "default": false,
         "type": "boolean"
      },
      "error": {
         "title": "Error",
         "description": "A container which has details of the error that failed this operation. See the :class:`ComputeError` for more details.",
         "allOf": [
            {
               "$ref": "#/definitions/ComputeError"
            }
         ]
      },
      "extras": {
         "title": "Extras",
         "description": "Additional information to bundle with the failed operation. Details which pertain specifically to a thrown error should be contained in the `error` field. See :class:`ComputeError` for details.",
         "type": "object"
      }
   },
   "required": [
      "error"
   ],
   "additionalProperties": false,
   "definitions": {
      "ComputeError": {
         "title": "ComputeError",
         "description": "Complete description of the error from an unsuccessful program execution.",
         "type": "object",
         "properties": {
            "error_type": {
               "title": "Error Type",
               "description": "The type of error which was thrown. Restrict this field to short classifiers e.g. 'input_error'. Suggested classifiers: https://github.com/MolSSI/QCEngine/blob/master/qcengine/exceptions.py",
               "type": "string"
            },
            "error_message": {
               "title": "Error Message",
               "description": "Text associated with the thrown error. This is often the backtrace, but it can contain additional information as well.",
               "type": "string"
            },
            "extras": {
               "title": "Extras",
               "description": "Additional information to bundle with the error.",
               "type": "object"
            }
         },
         "required": [
            "error_type",
            "error_message"
         ],
         "additionalProperties": false
      }
   }
}

Fields:

error (qcelemental.models.common_models.ComputeError)
extras (Optional[Dict[str, Any]])
id (str)
input_data (Any)
success (bool)

field error: ComputeError [Required]: A container which has details of the error that failed this operation. See the ComputeError for more details.

field extras: Optional[Dict[str, Any]] = None: Additional information to bundle with the failed operation. Details which pertain specifically to a thrown error should be contained in the error field. See ComputeError for details.

field id: str = None: A unique identifier which links this FailedOperation, often of the same Id of the operation should it have been successful. This will often be set programmatically by a database such as Fractal.

field input_data: Any = None: The input data which was passed in that generated this failure. This should be the complete input which when attempted to be run, caused the operation to fail.

field success: bool = False: A boolean indicator that the operation failed consistent with the model of successful operations. Should always be False. Allows programmatic assessment of all operations regardless of if they failed or succeeded