Support stabilised syntax for OpenQASM 3 switch
#11417
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The OpenQASM 3 project made some changes to the preliminary syntax of the `switch` statement, merging the final version in openqasm/openqasm#463. This commit adds support for the new syntax, making it available by default while still supporting the experimental flag to enable the preliminary syntax. Support for the old flag is necessary to allow Qiskit to continue to interoperate with other tooling that still assumes the preliminary format (we know that at least the IBM QSS compiler is in this position right now), and in general should hopefully not be too onerous to continue to support.
jakelishman
added
Changelog: New Feature
|
One or more of the the following people are requested to review this:
|
Pull Request Test Coverage Report for Build 7732196831Warning: This coverage report may be inaccurate.We've detected an issue with your CI configuration that might affect the accuracy of this pull request's coverage report.
💛 - Coveralls |
mtreinish
reviewed
Jan 31, 2024
mtreinish
approved these changes
Jan 31, 2024
Comment on lines
+5
to
+12
| :mod:`qiskit.qasm3`) now supports the stabilised syntax of the ``switch`` statement in OpenQASM 3 | ||
| by default. The pre-certification syntax of the ``switch`` statement is still available by | ||
| using the :attr:`.ExperimentalFeatures.SWITCH_CASE_V1` flag in the ``experimental`` argument of | ||
| the exporter. There is no feature flag required for the stabilised syntax, but if you are | ||
| interfacing with other tooling that is not yet updated, you may need to pass the experimental | ||
| flag. | ||
|
|
||
| The syntax of the stabilised form is slightly different with regards to terminating ``break`` |
There was a problem hiding this comment.
Suggested change
| :mod:`qiskit.qasm3`) now supports the stabilised syntax of the ``switch`` statement in OpenQASM 3 | |
| by default. The pre-certification syntax of the ``switch`` statement is still available by | |
| using the :attr:`.ExperimentalFeatures.SWITCH_CASE_V1` flag in the ``experimental`` argument of | |
| the exporter. There is no feature flag required for the stabilised syntax, but if you are | |
| interfacing with other tooling that is not yet updated, you may need to pass the experimental | |
| flag. | |
| The syntax of the stabilised form is slightly different with regards to terminating ``break`` | |
| :mod:`qiskit.qasm3`) now supports the stabilized syntax of the ``switch`` statement in OpenQASM 3 | |
| by default. The pre-certification syntax of the ``switch`` statement is still available by | |
| using the :attr:`.ExperimentalFeatures.SWITCH_CASE_V1` flag in the ``experimental`` argument of | |
| the exporter. There is no feature flag required for the stabilized syntax, but if you are | |
| interfacing with other tooling that is not yet updated, you may need to pass the experimental | |
| flag. | |
| The syntax of the stabilized form is slightly different with regards to terminating ``break`` |
jlapeyre
reviewed
Jan 31, 2024
| class SwitchStatement(Statement): | ||
| """AST node for the proposed 'switch-case' extension to OpenQASM 3.""" | ||
| class SwitchStatementPreview(Statement): | ||
| """AST node for the proposed 'switch-case' extension to OpenQASM 3, before the syntax was |
There was a problem hiding this comment.
I'm trying to think of a better more useful name than ....Preview. I think contemporary software devs find the word "Legacy" distasteful. But it's probably widely understood by casual programmers. Maybe SwitchStatementOldStyle. In OQ3, "old style" refers to OQ2 legacy syntax. In this case it's not from a previous version. But OldStyle tells me that I probably don't want this, even if I am not familiar with its history.
Or even SwitchStatementObsolete. This really tells me I should not be using it.
github-merge-queue
bot
removed this pull request from the merge queue due to failed status checks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
The OpenQASM 3 project made some changes to the preliminary syntax of the
switchstatement, merging the final version in openqasm/openqasm#463. This commit adds support for the new syntax, making it available by default while still supporting the experimental flag to enable the preliminary syntax. Support for the old flag is necessary to allow Qiskit to continue to interoperate with other tooling that still assumes the preliminary format (we know that at least the IBM QSS compiler is in this position right now), and in general should hopefully not be too onerous to continue to support.Details and comments
The new syntax won't be supported by the QSS compiler yet, and there's no need to rush to that - it's easy for Qiskit to continue to support both, and having an easy flag switch over means that any deployments of Qiskit alongside other OpenQASM 3 parsers can easily keep them in sync without having to fall behind on Qiskit bugfixes.