z iSrSSKJr "SS\5r"SS\5r"SS\\5r"S S \5r"S S \ 5r "S S\ 5r "SS\ 5r g)a8 =============================================== Top-level exceptions (:mod:`qiskit.exceptions`) =============================================== Exceptions ========== All Qiskit-related exceptions raised by Qiskit are subclasses of the base: .. autoexception:: QiskitError .. note:: Errors that are just general programming errors, such as incorrect typing, may still raise standard Python errors such as ``TypeError``. :exc:`QiskitError` is generally for errors raised in usage that is particular to Qiskit. Many of the Qiskit subpackages define their own more granular error, to help in catching only the subset of errors you care about. For example, :mod:`qiskit.circuit` almost exclusively uses :exc:`.CircuitError`, while both :exc:`.QASM2ExportError` and :exc:`.QASM2ParseError` derive from :exc:`.QASM2Error` in :mod:`qiskit.qasm2`, which is in turn a type of :exc:`.QiskitError`. Qiskit has several optional features that depend on other packages that are not required for a minimal install. You can read more about those, and ways to check for their presence, in :mod:`qiskit.utils.optionals`. Trying to use a feature that requires an optional extra will raise a particular error, which subclasses both :exc:`QiskitError` and the Python built-in ``ImportError``. .. autoexception:: MissingOptionalLibraryError Two more uncommon errors relate to failures in reading user-configuration files, or specifying a filename that cannot be used: .. autoexception:: QiskitUserConfigError .. autoexception:: InvalidFileError Warnings ======== Some particular features of Qiskit may raise custom warnings. In general, Qiskit will use built-in Python warnings (such as :exc:`DeprecationWarning`) when appropriate, but warnings related to Qiskit-specific functionality will be subtypes of :exc:`QiskitWarning`. .. autoexception:: QiskitWarning Related to :exc:`MissingOptionalLibraryError`, in some cases an optional dependency might be found, but fail to import for some other reason. In this case, Qiskit will continue as if the dependency is not present, but will raise :exc:`OptionalDependencyImportWarning` to let you know about it. .. autoexception:: OptionalDependencyImportWarning When experimental features are being used, Qiskit will raise :exc:`ExperimentalWarning`. .. warning:: Qiskit experimental features can break at any minor release and their API might change without previous notification. Their use is not recommended in production. .. autoexception:: ExperimentalWarning Filtering warnings ------------------ Python has built-in mechanisms to filter warnings, described in the documentation of the :mod:`warnings` module. You can use these subclasses in your warning filters from within Python to silence warnings you are not interested in. For example, if you are knowingly using experimental features and are comfortable that they make break in later versions, you can silence :exc:`ExperimentalWarning` like this:: import warnings from qiskit.exceptions import ExperimentalWarning warnings.filterwarnings("ignore", category=ExperimentalWarning) )Optionalc2^\rSrSrSrU4SjrSrSrU=r$) QiskitError\z'Base class for errors raised by Qiskit.cn>[TU]SRU55 SRU5Ulg)zSet the error message. N)super__init__joinmessage)selfr __class__s K/home/james-whalen/.local/lib/python3.13/site-packages/qiskit/exceptions.pyr QiskitError.__init___s) '*+xx( c,[UR5$zReturn the message.reprr r s r__str__QiskitError.__str__dDLL!!rr ) __name__ __module__ __qualname____firstlineno____doc__r r__static_attributes__ __classcell__rs@rrr\s1) ""rrc\rSrSrSrSrSrg)QiskitUserConfigErroriz?Raised when an error is encountered reading a user config file.zUser config invalidN)rrrrrr r r&rrr$r$is I#Grr$c d^\rSrSrSrS S\S\S\\S\\SS4 U4S jjjrS\4S jrS r U=r $) MissingOptionalLibraryErroroz+Raised when an optional library is missing.Nlibnamename pip_installmsgreturnc>SUSUS3/nU(aURSUS35 U(aURSUS35 [TU] SRU55 SRU5Ulg)zSet the error message. Args: libname: Name of missing library name: Name of class, function, module that uses this library pip_install: pip install command, if any msg: Descriptive message, if any zThe 'z' library is required to use 'z'.zYou can install it with 'r.N)appendr r r r )r r*r+r,r-r rs rr $MissingOptionalLibraryError.__init__rss7)#A$rJK  NN6{m2F G  NNQse1: & '*+xx( rc,[UR5$rrrs rr#MissingOptionalLibraryError.__str__rrr)NN) rrrrrstrrr rr r!r"s@rr(r(osY5`d))"%)4r>sJrr>c\rSrSrSrSrg)ExperimentalWarningz2Raised when an experimental feature is being used.r&Nr9r&rrrArAsrAr&rrrGsmJX ") "$K$ "+{"6L{LQKQKmK =-=r