# Copyright (C) 2023 qBraid
#
# This file is part of the qBraid-SDK
#
# The qBraid-SDK is free software released under the GNU General Public License v3
# or later. You can redistribute and/or modify it under the terms of the GPL v3.
# See the LICENSE file in the project root or <https://www.gnu.org/licenses/gpl-3.0.html>.
#
# THERE IS NO WARRANTY for the qBraid-SDK, as per Section 15 of the GPL v3.
"""
Module defining all :mod:`~qbraid.providers` enumerated types.
"""
from enum import Enum
[docs]
class DeviceType(str, Enum):
"""Class for possible device types.
Attributes:
SIMULATOR (str): the device is a simulator
QPU (str): the device is a QPU
FAKE (str): is a fake device used for testing
"""
SIMULATOR = "SIMULATOR"
QPU = "QPU"
FAKE = "FAKE"
[docs]
class DeviceStatus(int, Enum):
"""Class for the status of devices.
Attributes:
ONLINE (int): the device is online
OFFLINE (int): the device is offline
"""
ONLINE = 0
OFFLINE = 1
RETIRED = 2
[docs]
class JobStatus(str, Enum):
"""Class for the status of processes (i.e. jobs / quantum tasks) resulting from any
:meth:`~qbraid.providers.QuantumDevice.run` method.
Attributes:
INITIALIZING (str): job is being initialized
QUEUED (str): job is queued
VALIDATING (str): job is being validated
RUNNING (str): job is actively running
CANCELLING (str): job is being cancelled
CANCELLED (str): job has been cancelled
COMPLETED (str): job has successfully run
FAILED (str): job failed / incurred error
UNKNOWN (str): vendor-supplied job status not recognized
"""
INITIALIZING = "job is being initialized"
QUEUED = "job is queued"
VALIDATING = "job is being validated"
RUNNING = "job is actively running"
CANCELLING = "job is being cancelled"
CANCELLED = "job has been cancelled"
COMPLETED = "job has successfully run"
FAILED = "job failed / incurred error"
UNKNOWN = "vendor-supplied job status not recognized"
JOB_FINAL = (JobStatus.COMPLETED, JobStatus.CANCELLED, JobStatus.FAILED)