# Copyright (C) 2024 qBraid
#
# This file is part of pyqasm
#
# Pyqasm 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 pyqasm, as per Section 15 of the GPL v3.
"""
Module defining base PyQASM exceptions.
"""
import logging
from typing import Optional, Type
from openqasm3.ast import Span
[docs]
class PyQasmError(Exception):
"""Base exception for all PyQASM exceptions."""
[docs]
class ValidationError(PyQasmError):
"""Exception raised when a OpenQASM program fails validation."""
class UnrollError(PyQasmError):
"""Exception raised when a OpenQASM program fails unrolling."""
def raise_qasm3_error(
message: Optional[str] = None,
err_type: Type[Exception] = ValidationError,
span: Optional[Span] = None,
raised_from: Optional[Exception] = None,
) -> None:
"""Raises a QASM3 conversion error with optional chaining from another exception.
Args:
message: The error message. If not provided, a default message will be used.
err_type: The type of error to raise.
span: The span (location) in the QASM file where the error occurred.
raised_from: Optional exception from which this error was raised (chaining).
Raises:
err_type: The error type initialized with the specified message and chained exception.
"""
if span:
logging.error(
"Error at line %s, column %s in QASM file", span.start_line, span.start_column
)
if raised_from:
raise err_type(message) from raised_from
raise err_type(message)