最上位の例外
qiskit.exceptions
例外
Qiskitが発生させるQiskit関連の例外はすべてbaseのサブクラスである:
QiskitError
exception qiskit.exceptions.QiskitError(*message)
ベース: Exception
Qiskitが発生させるエラーの基底クラス。
エラーメッセージを設定する。
タイプミスのような一般的なプログラミング・エラーであっても、 TypeError のような標準的な Python エラーが発生することがあります。 QiskitError は、一般的にQiskitに特有の使い方で発生したエラーに対応するものです。
Qiskitのサブパッケージの多くは、あなたが気にするエラーのサブセットのみをキャッチするのに役立つように、独自のより細かいエラーを定義しています。 例えば qiskit.circuit をほぼ独占的に使用している。 CircuitErrorであるのに対して QASM2ExportError と QASM2ParseError は QASM2Error に由来する。 qiskit.qasm2の一種である QiskitError.
Qiskitには、最小限のインストールには必要ない、他のパッケージに依存するいくつかのオプション機能があります。 それらの詳細と、その有無をチェックする方法については、以下をご覧いただきたい。 qiskit.utils.optionals. オプションの追加を必要とする機能を使おうとすると、特定のエラーが発生する。 QiskitError と Python 組み込みの ImportError の両方をサブクラス化します。
MissingOptionalLibraryError
exception qiskit.exceptions.MissingOptionalLibraryError(libname, name, pip_install=None, msg=None)
ベース: QiskitError, ImportError
オプションのライブラリがない場合に発生します。
param libname: 見つからないライブラリの名前 :param name: このライブラリを使用するクラス、関数、モジュールの名前 :param pip_install: もしあれば、pip installコマンド :param msg: もしあれば、説明メッセージ
パラメーター
戻りの型
なし
さらに2つの珍しいエラーは、ユーザー設定ファイルの読み込みに失敗した場合、または使用できないファイル名を指定した場合に関するものである:
QiskitUserConfigError
exception qiskit.exceptions.QiskitUserConfigError(*message)
ベース: QiskitError
ユーザー設定ファイルの読み込みエラーが発生したときに発生します。
エラーメッセージを設定する。
InvalidFileError
exception qiskit.exceptions.InvalidFileError(*message)
ベース: QiskitError
提供されたファイルが特定のタスクに対して有効でない場合に発生する。
エラーメッセージを設定する。
警告
Qiskitの特定の機能によっては、カスタム警告が発生する場合があります。 一般に、 Qiskit は適切な場合には組み込みの Python 警告 (たとえば DeprecationWarning) を使用しますが、 Qiskit 固有の機能に関連する警告は QiskitWarning.
QiskitWarning
に関連する。 MissingOptionalLibraryError場合によっては、オプションの依存関係が見つかっても、他の理由でインポートに失敗することがある。 この場合、Qiskitは依存関係が存在しないかのように続行しますが、そのことを知らせるために OptionalDependencyImportWarning を発生させます。
OptionalDependencyImportWarning
exception qiskit.exceptions.OptionalDependencyImportWarning
ベース: QiskitWarning
オプションのライブラリのインポート中にエラーが発生した場合に発生します。
実験的な機能が使用されている場合、Qiskitは ExperimentalWarning.
Qiskitの実験的な機能はマイナーリリース時に壊れる可能性があり、APIも事前の通知なしに変更される可能性があります。 生産現場での使用は推奨されていない。
ExperimentalWarning
警告のフィルタリング
Python には、警告をフィルタリングするための組み込みの仕組みが用意されており、その詳細についてはモジュ warnings ールのドキュメントに記載されています。 Python 内の警告フィルターでこれらのサブクラスを使用することで、不要な警告を抑制することができます。 たとえば、実験的な機能を意図的に使用しており、それらが将来のバージョンで動作しなくなる可能性があることを承知の上で問題ない場合は、次のように ExperimentalWarning 設定して通知を無効にできます:
import warnings
from qiskit.exceptions import ExperimentalWarning
warnings.filterwarnings("ignore", category=ExperimentalWarning)