general_superstaq.superstaq_exceptions
======================================

.. py:module:: general_superstaq.superstaq_exceptions

.. autoapi-nested-parse::

   Exceptions for the Superstaq API.



Exceptions
----------

.. autoapisummary::

   general_superstaq.superstaq_exceptions.SuperstaqException
   general_superstaq.superstaq_exceptions.SuperstaqServerException
   general_superstaq.superstaq_exceptions.SuperstaqUnsuccessfulJobException
   general_superstaq.superstaq_exceptions.SuperstaqWarning


Module Contents
---------------

.. py:exception:: SuperstaqException(message: str)

   Bases: :py:obj:`Exception`


   An exception for errors coming from Superstaq's API.


   .. py:attribute:: message


.. py:exception:: SuperstaqServerException(message: str, status_code: int = 400, contact_info: bool = False)

   Bases: :py:obj:`SuperstaqException`


   An exception for non-retriable server-side errors.


   .. py:attribute:: message


   .. py:attribute:: status_code


   .. py:attribute:: status_msg


.. py:exception:: SuperstaqUnsuccessfulJobException(job_id: str, status: str)

   Bases: :py:obj:`SuperstaqException`


   An exception for attempting to get info about an unsuccessful job.

   This exception occurs when a job has been cancelled, deleted, or failed, and information about
   this job is attempted to be accessed.


.. py:exception:: SuperstaqWarning(message: str)

   Bases: :py:obj:`Warning`


   A warning issued by the server.