# Copyright 2025 qBraid
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""
Module defining exceptions for errors raised by qBraid.
"""
from typing import Any, Optional
from qbraid_core._import import LazyLoader
from qbraid.exceptions import QbraidError
registry = LazyLoader("registry", globals(), "qbraid.programs.registry")
[docs]
class QasmError(QbraidError):
"""For errors raised while processing OpenQASM programs."""
[docs]
class PackageValueError(QbraidError):
"""Class for errors raised due to unsupported quantum frontend package"""
def __init__(self, package: str):
msg = (
f"Quantum frontend module '{package}' is not supported.\n"
f"Frontends supported by qBraid are: {registry.QPROGRAM_ALIASES}"
)
super().__init__(msg)
[docs]
class ProgramTypeError(QbraidError):
"""Exception raised for errors encountered with unsupported quantum programs.
Attributes:
program (Optional[Any]): The program that caused the error, default is None.
message (Optional[str]): Explanation of the error. If None, a default error message
is generated based on the provided program.
"""
def __init__(self, program: Optional[Any] = None, message: Optional[str] = None):
self.program = program
self.message = message
super().__init__(self.generate_message())
def generate_message(self) -> str:
"""Generate an error message based on the input."""
if self.message is not None:
return self.message
if self.program is not None:
return f"Quantum program of type '{type(self.program)}' is not supported."
return "Unsupported quantum program type."
[docs]
class ValidationError(ProgramTypeError):
"""Custom exception for validation errors in program types."""
[docs]
class ProgramLoaderError(QbraidError):
"""Raised when an error occurs while loading a quantum program."""