54 lines
1.6 KiB
Plaintext
54 lines
1.6 KiB
Plaintext
---
|
||
title: load
|
||
description: API reference for qiskit.circuit.qpy_serialization.load
|
||
in_page_toc_min_heading_level: 1
|
||
python_api_type: function
|
||
python_api_name: qiskit.circuit.qpy_serialization.load
|
||
---
|
||
|
||
# qiskit.circuit.qpy\_serialization.load
|
||
|
||
<Function id="qiskit.circuit.qpy_serialization.load" isDedicatedPage={true} github="https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/qpy_serialization.py" signature="load(file_obj)">
|
||
Load a QPY binary file
|
||
|
||
This function is used to load a serialized QPY circuit file and create [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") objects from its contents. For example:
|
||
|
||
```python
|
||
from qiskit.circuit import qpy_serialization
|
||
|
||
with open('bell.qpy', 'rb') as fd:
|
||
circuits = qpy_serialization.load(fd)
|
||
```
|
||
|
||
or with a gzip compressed file:
|
||
|
||
```python
|
||
import gzip
|
||
from qiskit.circuit import qpy_serialization
|
||
|
||
with gzip.open('bell.qpy.gz', 'rb') as fd:
|
||
circuits = qpy_serialization.load(fd)
|
||
```
|
||
|
||
which will read the contents of the qpy and return a list of [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") objects from the file.
|
||
|
||
**Parameters**
|
||
|
||
**file\_obj** (*File*) – A file like object that contains the QPY binary data for a circuit
|
||
|
||
**Returns**
|
||
|
||
**List of `QuantumCircuit`**
|
||
|
||
The list of [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") objects contained in the QPY data. A list is always returned, even if there is only 1 circuit in the QPY data.
|
||
|
||
**Return type**
|
||
|
||
list
|
||
|
||
**Raises**
|
||
|
||
**QiskitError** – if `file_obj` is not a valid QPY file
|
||
</Function>
|
||
|