Move OpenQASM 2 exporter to `qiskit.qasm2` #10533

jakelishman · 2023-07-31T11:41:15Z

Summary

This gets us into a position where the interface is similar between the qasm2, qasm3 and qpy modules (all of which do vaguely similar things at an abstract level), which are in turn similar to functionality in the Python standard libraries.

This commit simply moves the code from QuantumCircuit.qasm over to the new location. Some idiosyncrasies and additional bits of features that we do not intend to support long term (e.g. formatted output) are not brought over, but QuantumCircuit.qasm continues to perform those jobs until it is deprecated and removed.

Details and comments

Depends on #10532 because I copied across the new test from that as well - I didn't want that test to accidentally get lost later. The tests will fail on that one til that PR merges.

This gets us into a position where the interface is similar between the `qasm2`, `qasm3` and `qpy` modules (all of which do vaguely similar things at an abstract level), which are in turn similar to functionality in the Python standard libraries. This commit simply moves the code from `QuantumCircuit.qasm` over to the new location. Some idiosyncrasies and additional bits of features that we do not intend to support long term (e.g. formatted output) are not brought over, but `QuantumCircuit.qasm` continues to perform those jobs until it is deprecated and removed.

qiskit-bot · 2023-07-31T11:41:19Z

One or more of the the following people are requested to review this:

@Qiskit/terra-core

coveralls · 2023-07-31T18:13:59Z

Pull Request Test Coverage Report for Build 5717766407

144 of 149 (96.64%) changed or added relevant lines in 3 files are covered.
4 unchanged lines in 3 files lost coverage.
Overall coverage increased (+0.006%) to 85.916%

Changes Missing Coverage	Covered Lines	Changed/Added Lines	%
qiskit/qasm2/export.py	130	132	98.48%
qiskit/circuit/quantumcircuit.py	13	16	81.25%

Files with Coverage Reduction	New Missed Lines	%
crates/qasm2/src/expr.rs	1	93.76%
crates/qasm2/src/lex.rs	1	91.65%
qiskit/extensions/quantum_initializer/squ.py	2	80.0%

Totals
Change from base Build 5717545484:	0.006%
Covered Lines:	73098
Relevant Lines:	85081

💛 - Coveralls

1ucian0 · 2023-09-01T12:09:50Z

qiskit/circuit/quantumcircuit.py

+    @classmethod
+    @property
+    @deprecate_func(
+        since="0.45.0", additional_msg="No alternative will be provided.", is_property=True


I would add something like handled by .qasm2.dumps, so no alternative is needed.

I dunno - the use of this object is/was already done by internally QuantumCircuit.qasm, so if someone's using it outside that context, then they presumably also don't want to use the new qasm2.dumps.

1ucian0 · 2023-09-01T12:10:08Z

qiskit/circuit/quantumcircuit.py

+    @classmethod
+    @property
+    @deprecate_func(
+        since="0.45.0", additional_msg="No alternative will be provided.", is_property=True


ditto https://github.com/Qiskit/qiskit/pull/10533/files#r1312947372

1ucian0

LGTM in general... some comments here and there.

1ucian0 · 2023-09-01T12:11:39Z

qiskit/circuit/quantumcircuit.py

+            :func:`.qasm2.dump` and :func:`.qasm2.dumps`
+                The preferred entry points to the OpenQASM 2 export capabilities.  These match the
+                interface for other serialisers in Qiskit.


Why not just deprecate the .qasm method? Or that's done somewhere else?

This PR is just adding the alternative now, so QuantumCircuit.qasm isn't eligible for deprecation yet.

1ucian0 · 2023-09-01T12:13:39Z

qiskit/circuit/quantumcircuit.py

-                file.write(out)
+                print(out, file=file)


Is this preferred? I always use the write way. Am I doing it wrong?

The print call here ensures that a terminating newline character is added. Since dumps returns an unterminated string (since that makes more sense for in-memory / interactive usage), I switched the file.write to print here so that the files would come out properly formatted without needing to string append \n manually or needing to make two Python-space write calls.

1ucian0 · 2023-09-01T12:17:09Z

qiskit/qasm2/__init__.py

-and exporting back to OpenQASM 2.  The parsing components live in this module, while currently the
-export capabilities are limited to being the :meth:`.QuantumCircuit.qasm` method.
+Qiskit has support for interoperation with OpenQASM 2.0 programs, both :ref:`parsing into Qiskit
+formats <qasm2-parse>` and :ref:`exporting back to OpenQASM 2 <qasm2-export>`.

 .. note::

    OpenQASM 2 is a simple language, and not suitable for general serialisation of Qiskit objects.


Suggested change

OpenQASM 2 is a simple language, and not suitable for general serialisation of Qiskit objects.

OpenQASM 2 is a simple language, and not suitable for general serialisation of Qiskit circuits.

I'd done this deliberately because QPY also allows serialisation of ScheduleBlock, and sometimes the circuit structure is serialisable, but one or two of the contained instructions / expressions aren't. I can change it if you think that distinction is too subtle, though.

1ucian0 · 2023-09-01T12:21:47Z

qiskit/qasm2/__init__.py

+
+    import pathlib
+
+    qiskit.qasm2.dump(qc, pathlib.Path.home() / "myfile.qasm")


I didnt know that pathlib.Path.home() / "myfile.qasm" was possible. Nice one!

Yeah, pathlib is typically a much more convenient interface to working with filesystems than raw os.path, and almost everything that deals with path-like objects will accept T | os.PathLike[T] as the type (for T: str | bytes), of which pathlib.Path is one.

qiskit/circuit/quantumcircuit.py

qiskit/qasm2/__init__.py

qiskit/qasm2/export.py

1ucian0 · 2023-09-01T12:32:51Z

releasenotes/notes/qasm2-new-api-4e1e4803d6a5a175.yaml

+    become confused.
+deprecations:
+  - |
+    The little-used :class:`.QuantumCircuit` class data attributes


Suggested change

The little-used :class:`.QuantumCircuit` class data attributes

The :class:`.QuantumCircuit` class data attributes

I wanted to stress that these are highly unlikely to be in use, but can change it if you think it's much better not to.

qiskit/qasm2/export.py

Co-authored-by: Luciano Bello <bel@zurich.ibm.com>

1ucian0

Let's merge it!

jakelishman added Changelog: Deprecation Include in "Deprecated" section of changelog Changelog: New Feature Include in the "Added" section of the changelog mod: qasm2 Relating to OpenQASM 2 import or export labels Jul 31, 2023

jakelishman added this to the 0.45.0 milestone Jul 31, 2023

jakelishman requested a review from a team as a code owner July 31, 2023 11:41

jakelishman added 4 commits July 31, 2023 12:57

Use 'text' instead of unknown 'qasm2' highlighter

2d3973e

Fix lint import cycle

fa21329

Fix Sphinx typos

3297b5b

Merge remote-tracking branch 'ibm/main' into qasm2/new-api

dbdc506

jakelishman mentioned this pull request Jul 31, 2023

Use built-in IPython code highlighting in formatted OQ2 output #9945

Closed

jakelishman mentioned this pull request Aug 30, 2023

Design discussion for OpenQASM header-file management #10737

Open

jakelishman added 2 commits August 30, 2023 18:35

Merge remote-tracking branch 'ibm/main' into qasm2/new-api

e4000a7

Fix for new unitary decomposition

e6a2002

1ucian0 reviewed Sep 1, 2023

View reviewed changes

1ucian0 self-assigned this Sep 1, 2023

jakelishman commented Sep 1, 2023

View reviewed changes

qiskit/qasm2/export.py Outdated Show resolved Hide resolved

Apply suggestions from code review

89d46c0

Co-authored-by: Luciano Bello <bel@zurich.ibm.com>

1ucian0 approved these changes Sep 1, 2023

View reviewed changes

1ucian0 added this pull request to the merge queue Sep 1, 2023

Merged via the queue into Qiskit:main with commit e1fdb72 Sep 1, 2023
14 checks passed

jakelishman deleted the qasm2/new-api branch October 11, 2023 11:30

purva-thakre mentioned this pull request Feb 26, 2024

Update qiskit requirement from ~=0.45.1 to ~=1.0.1 unitaryfund/mitiq#2207

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Move OpenQASM 2 exporter to `qiskit.qasm2` #10533

Move OpenQASM 2 exporter to `qiskit.qasm2` #10533

jakelishman commented Jul 31, 2023

qiskit-bot commented Jul 31, 2023

coveralls commented Jul 31, 2023

1ucian0 Sep 1, 2023

jakelishman Sep 1, 2023

1ucian0 Sep 1, 2023

1ucian0 left a comment

1ucian0 Sep 1, 2023

jakelishman Sep 1, 2023

1ucian0 Sep 1, 2023

jakelishman Sep 1, 2023

1ucian0 Sep 1, 2023

jakelishman Sep 1, 2023

1ucian0 Sep 1, 2023

jakelishman Sep 1, 2023

1ucian0 Sep 1, 2023

jakelishman Sep 1, 2023

1ucian0 left a comment

	OpenQASM 2 is a simple language, and not suitable for general serialisation of Qiskit objects.
	OpenQASM 2 is a simple language, and not suitable for general serialisation of Qiskit circuits.


		import pathlib

		qiskit.qasm2.dump(qc, pathlib.Path.home() / "myfile.qasm")

	The little-used :class:`.QuantumCircuit` class data attributes
	The :class:`.QuantumCircuit` class data attributes

Move OpenQASM 2 exporter to qiskit.qasm2 #10533

Move OpenQASM 2 exporter to qiskit.qasm2 #10533

Conversation

jakelishman commented Jul 31, 2023

Summary

Details and comments

qiskit-bot commented Jul 31, 2023

coveralls commented Jul 31, 2023

Pull Request Test Coverage Report for Build 5717766407

💛 - Coveralls

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

1ucian0 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

1ucian0 left a comment

Choose a reason for hiding this comment

Move OpenQASM 2 exporter to `qiskit.qasm2` #10533

Move OpenQASM 2 exporter to `qiskit.qasm2` #10533