qiskit-documentation/docs/api/qiskit/0.29/qiskit.providers.BaseProvid...

67 lines
1.9 KiB
Plaintext
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

---
title: BaseProvider (v0.29)
description: API reference for qiskit.providers.BaseProvider in qiskit v0.29
in_page_toc_min_heading_level: 1
python_api_type: class
python_api_name: qiskit.providers.BaseProvider
---
# BaseProvider
<Class id="qiskit.providers.BaseProvider" isDedicatedPage={true} github="https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/baseprovider.py" signature="BaseProvider(*args, **kwargs)" modifiers="class">
Bases: `abc.ABC`
Base class for a Backend Provider.
## Methods
<span id="qiskit-providers-baseprovider-backends" />
### backends
<Function id="qiskit.providers.BaseProvider.backends" signature="BaseProvider.backends(name=None, **kwargs)" modifiers="abstract">
Return a list of backends matching the specified filtering.
**Parameters**
* **name** (*str*) name of the backend.
* **\*\*kwargs** dict used for filtering.
**Returns**
**a list of Backends that match the filtering**
criteria.
**Return type**
list\[[BaseBackend](qiskit.providers.BaseBackend "qiskit.providers.BaseBackend")]
</Function>
<span id="qiskit-providers-baseprovider-get-backend" />
### get\_backend
<Function id="qiskit.providers.BaseProvider.get_backend" signature="BaseProvider.get_backend(name=None, **kwargs)">
Return a single backend matching the specified filtering.
**Parameters**
* **name** (*str*) name of the backend.
* **\*\*kwargs** dict used for filtering.
**Returns**
a backend matching the filtering.
**Return type**
[BaseBackend](qiskit.providers.BaseBackend "qiskit.providers.BaseBackend")
**Raises**
[**QiskitBackendNotFoundError**](qiskit.providers.QiskitBackendNotFoundError "qiskit.providers.QiskitBackendNotFoundError") if no backend could be found or more than one backend matches the filtering criteria.
</Function>
</Class>