Skip to content

Fix OpenQASM 3 for loop variable type annotation (gh-12866) #15480

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
akhil-40409 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fix OpenQASM 3 for loop variable type annotation (gh-12866) #15480

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions qiskit/qasm3/printer.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -534,6 +534,7 @@ def _visit_BranchingStatement(
def _visit_ForLoopStatement(self, node: ast.ForLoopStatement) -> None:
self._start_line()
self.stream.write("for ")
self.stream.write("int ")
self.visit(node.parameter)
self.stream.write(" in ")
if isinstance(node.indexset, ast.Range):
Expand Down
31 changes: 24 additions & 7 deletions test/python/qasm3/test_export.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -958,7 +958,7 @@ def test_simple_for_loop(self):
"OPENQASM 3.0;",
'include "stdgates.inc";',
f"qubit[2] {qr_name};",
f"for {parameter.name} in {{0, 3, 4}} {{",
f"for int {parameter.name} in {{0, 3, 4}} {{",
f" rx({parameter.name}) {qr_name}[1];",
" break;",
" continue;",
Expand Down Expand Up @@ -997,10 +997,10 @@ def test_nested_for_loop(self):
"OPENQASM 3.0;",
'include "stdgates.inc";',
f"qubit[2] {qr_name};",
f"for {outer_parameter.name} in [0:3] {{",
f"for int {outer_parameter.name} in [0:3] {{",
f" h {qr_name}[0];",
f" rz({outer_parameter.name}) {qr_name}[1];",
f" for {inner_parameter.name} in [1:2:4] {{",
f" for int {inner_parameter.name} in [1:2:4] {{",
# Note the reversed bit order.
f" rz({inner_parameter.name}) {qr_name}[1];",
f" rz({outer_parameter.name}) {qr_name}[0];",
Expand Down Expand Up @@ -1046,10 +1046,10 @@ def test_regular_parameter_in_nested_for_loop(self):
# This next line will be missing until gh-7280 is fixed.
f"input float[64] {regular_parameter.name};",
f"qubit[2] {qr_name};",
f"for {outer_parameter.name} in [0:3] {{",
f"for int {outer_parameter.name} in [0:3] {{",
f" h {qr_name}[0];",
f" h {qr_name}[1];",
f" for {inner_parameter.name} in [1:2:4] {{",
f" for int {inner_parameter.name} in [1:2:4] {{",
# Note the reversed bit order.
f" h {qr_name}[1];",
f" rx({regular_parameter.name}) {qr_name}[0];",
Expand All @@ -1063,6 +1063,23 @@ def test_regular_parameter_in_nested_for_loop(self):
)
self.assertEqual(dumps(qc), expected_qasm)

def test_for_loop_type_annotation(self):
"""Test that for loop variables include type annotations (gh-12866)."""
# This test verifies the fix for GitHub issue #12866 where loop variables
# were missing type annotations in OpenQASM 3 output.
parameter = Parameter("param")
loop_body = QuantumCircuit(2, 2)
loop_body.x(0)

qc = QuantumCircuit(2, 2)
qc.for_loop([0, 1], parameter, loop_body, [0, 1], [0, 1])

output = dumps(qc)
# Verify that the loop variable has a type annotation
self.assertIn("for int param in", output)
# Verify the complete structure
self.assertIn("for int param in {0, 1}", output)

def test_for_loop_with_no_parameter(self):
"""Test that a for loop with the parameter set to ``None`` outputs the expected result."""
loop_body = QuantumCircuit(1)
Expand All @@ -1077,7 +1094,7 @@ def test_for_loop_with_no_parameter(self):
"OPENQASM 3.0;",
'include "stdgates.inc";',
f"qubit[2] {qr_name};",
"for _ in {0, 3, 4} {",
"for int _ in {0, 3, 4} {",
f" h {qr_name}[1];",
"}",
"",
Expand Down Expand Up @@ -1443,7 +1460,7 @@ def test_custom_gate_used_in_loop_scope(self):
" rx(0.5) _gate_q_0;",
"}",
"qubit[1] q;",
"for b in [0:1] {",
"for int b in [0:1] {",
" custom q[0];",
"}",
"",
Expand Down