update checker and bump version

qbraid_qir/_version.py

@@ -14,4 +14,4 @@
 Version number (major.minor.patch[-label])
 
 """
-__version__ = "0.2.3.dev"
+__version__ = "0.2.3"

qbraid_qir/qasm3/__init__.py

@@ -20,7 +20,7 @@
    :toctree: ../stubs/
 
    qasm3_to_qir
-
+   validate_qasm
 
 Classes
 ---------
@@ -31,7 +31,6 @@
    Qasm3Module
    BasicQasmVisitor
 
-
 Exceptions
 -----------
 
@@ -41,14 +40,14 @@
    Qasm3ConversionError
 
 """
-from .checker import semantic_check
+from .checker import validate_qasm
 from .convert import qasm3_to_qir
 from .elements import Qasm3Module
 from .exceptions import Qasm3ConversionError
 from .visitor import BasicQasmVisitor
 
 __all__ = [
-    "semantic_check",
+    "validate_qasm",
     "qasm3_to_qir",
     "Qasm3Module",
     "Qasm3ConversionError",

qbraid_qir/qasm3/checker.py

@@ -12,53 +12,45 @@
 Module containing OpenQASM semantic checker function
 
 """
-from typing import Optional, Union
+from typing import Union
 
 import openqasm3
+from openqasm3.parser import QASM3ParsingError
 from pyqir import Context, qir_module
 
 from .elements import Qasm3Module, generate_module_id
 from .exceptions import Qasm3ConversionError
 from .visitor import BasicQasmVisitor
 
 
-def semantic_check(
-    program: Union[openqasm3.ast.Program, str],
-    name: Optional[str] = None,
-    **kwargs,
-) -> None:
-    """Validates a given OpenQASM 3 program for semantic correctness.
+class QasmValidationError(Exception):
+    """Exception raised when a QASM program fails validation."""
 
-    Args:
-        program (openqasm3.ast.Program or str): The OpenQASM 3 program to convert.
-        name (str, optional): Identifier for created QIR module. Auto-generated if not provided.
 
-    Keyword Args:
-        initialize_runtime (bool): Whether to perform quantum runtime environment initialization,
-                                   default `True`.
-        record_output (bool): Whether to record output calls for registers, default `True`
+def validate_qasm(program: Union[openqasm3.ast.Program, str]) -> None:
+    """Validates a given OpenQASM 3 program for semantic correctness.
 
-    Returns:
-        Optional[Exception]: None if the program is semantically correct, otherwise an exception.
+    Args:
+        program (openqasm3.ast.Program or str): The OpenQASM 3 program to validate.
 
     Raises:
-        Exception: If the input is not a valid OpenQASM 3 program.
-        Qasm3ConversionError: If the program is semantically incorrect.
+        TypeError: If the input is not a string or an `openqasm3.ast.Program` instance.
+        QasmValidationError: If the program fails parsing or semantic validation.
     """
     if isinstance(program, str):
-        program = openqasm3.parse(program)
-
+        try:
+            program = openqasm3.parse(program)
+        except QASM3ParsingError as err:
+            raise QasmValidationError(f"Failed to parse OpenQASM string: {err}") from err
     elif not isinstance(program, openqasm3.ast.Program):
-        raise TypeError("Input quantum program must be of type openqasm3.ast.Program or str.")
-
-    if name is None:
-        name = generate_module_id()
+        raise TypeError("Input quantum program must be of type 'str' or 'openqasm3.ast.Program'.")
 
+    name = generate_module_id()
     llvm_module = qir_module(Context(), name)
     module = Qasm3Module.from_program(program, llvm_module)
 
     try:
-        visitor = BasicQasmVisitor(check_only=True, **kwargs)
+        visitor = BasicQasmVisitor(check_only=True)
         module.accept(visitor)
     except (Qasm3ConversionError, TypeError, ValueError) as err:
-        raise err
+        raise QasmValidationError(f"Semantic validation failed: {err}") from err

tests/qasm3_qir/test_checker.py

@@ -15,17 +15,16 @@
 
 import pytest
 
-from qbraid_qir.qasm3.checker import semantic_check
-from qbraid_qir.qasm3.exceptions import Qasm3ConversionError
+from qbraid_qir.qasm3.checker import validate_qasm, QasmValidationError
 
 
 def test_correct_check():
-    assert semantic_check("OPENQASM 3; include 'stdgates.inc'; qubit q;") is None
+    assert validate_qasm("OPENQASM 3; include 'stdgates.inc'; qubit q;") is None
 
 
 def test_incorrect_check():
-    with pytest.raises(Qasm3ConversionError):
-        semantic_check(
+    with pytest.raises(QasmValidationError):
+        validate_qasm(
             """
             //semantically incorrect program
             OPENQASM 3;
@@ -35,13 +34,12 @@ def test_incorrect_check():
             h q;
             }
             rx(3.14) q[2];
-            """,
-            name="test",
+            """
         )
 
 
 def test_incorrect_program_type():
     with pytest.raises(
-        TypeError, match="Input quantum program must be of type openqasm3.ast.Program or str."
+        TypeError, match="Input quantum program must be of type 'str' or 'openqasm3.ast.Program'."
     ):
-        semantic_check(1234)
+        validate_qasm(1234)