29 lines
1.4 KiB
Plaintext
29 lines
1.4 KiB
Plaintext
---
|
||
title: dump
|
||
description: API reference for qiskit.qasm3.dump
|
||
in_page_toc_min_heading_level: 1
|
||
python_api_type: function
|
||
python_api_name: qiskit.qasm3.dump
|
||
---
|
||
|
||
# qiskit.qasm3.dump
|
||
|
||
<Function id="qiskit.qasm3.dump" isDedicatedPage={true} github="https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/qasm3/__init__.py" signature="dump(circuit, stream, **kwargs)">
|
||
Serialize a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") object as a OpenQASM3 stream to file-like object.
|
||
|
||
<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.dump`](qiskit.qasm3.Exporter#dump "qiskit.qasm3.Exporter.dump") method.
|
||
</Admonition>
|
||
|
||
**Parameters**
|
||
|
||
* **circuit** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – Circuit to serialize.
|
||
* **stream** (*TextIOBase*) – stream-like object to dump the OpenQASM3 serialization
|
||
* **\*\*kwargs** – Arguments for the [`Exporter`](qiskit.qasm3.Exporter "qiskit.qasm3.Exporter") constructor.
|
||
|
||
**Return type**
|
||
|
||
`None`
|
||
</Function>
|
||
|