general_superstaq

Subpackages

`API_URL`
`API_VERSION`

`SuperstaqException`	An exception for errors coming from Superstaq's API.
`SuperstaqServerException`	An exception for non-retriable server-side errors.
`SuperstaqUnsuccessfulJobException`	An exception for attempting to get info about an unsuccessful job.
`SuperstaqWarning`	A warning issued by the server.

`ResourceEstimate`	A class to store data returned from a /resource_estimate request.
`Target`	A data class to store data returned from a /get_targets request.

exception general_superstaq.SuperstaqException(message: str)

Bases: Exception

An exception for errors coming from Superstaq’s API.

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

An exception for non-retriable server-side errors.

exception general_superstaq.SuperstaqUnsuccessfulJobException(job_id: str, status: str)

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.

exception general_superstaq.SuperstaqWarning(message: str)

Bases: Warning

A warning issued by the server.

class general_superstaq.ResourceEstimate

A class to store data returned from a /resource_estimate request.

class general_superstaq.Target(/, **data: Any)

Bases: pydantic.BaseModel

A data class to store data returned from a /get_targets request.