32 lines
1.3 KiB
Plaintext
32 lines
1.3 KiB
Plaintext
---
|
||
title: dumps
|
||
description: API reference for qiskit.qasm3.dumps
|
||
in_page_toc_min_heading_level: 1
|
||
python_api_type: function
|
||
python_api_name: qiskit.qasm3.dumps
|
||
---
|
||
|
||
# qiskit.qasm3.dumps
|
||
|
||
<Function id="qiskit.qasm3.dumps" isDedicatedPage={true} github="https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qasm3/__init__.py" signature="dumps(circuit, **kwargs)">
|
||
Serialize a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") object in an OpenQASM3 string.
|
||
|
||
<Admonition title="Note" type="note">
|
||
This is a quick interface to the main [`Exporter`](qiskit.qasm3.Exporter "qiskit.qasm3.Exporter") interface. All keyword arguments to this function are inherited from the constructor of that class, and if you have multiple circuits to export, it will be faster to create an [`Exporter`](qiskit.qasm3.Exporter "qiskit.qasm3.Exporter") instance, and use its [`Exporter.dumps`](qiskit.qasm3.Exporter#dumps "qiskit.qasm3.Exporter.dumps") method.
|
||
</Admonition>
|
||
|
||
**Parameters**
|
||
|
||
* **circuit** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – Circuit to serialize.
|
||
* **\*\*kwargs** – Arguments for the [`Exporter`](qiskit.qasm3.Exporter "qiskit.qasm3.Exporter") constructor.
|
||
|
||
**Returns**
|
||
|
||
The OpenQASM3 serialization
|
||
|
||
**Return type**
|
||
|
||
str
|
||
</Function>
|
||
|